[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
[circleci-url]: https://circleci.com/gh/nestjs/nest
A progressive Node.js framework for building efficient and scalable server-side applications.
## Description
Cassandra Driver Adapter utilities module for [NestJS](https://github.com/nestjs/nest) based on the [cassandra-driver](https://github.com/datastax/nodejs-driver) package.
## Installation
```bash
$ npm i --save @vlxdisluv/cassandra-driver-adapter
```
```bash
$ yarn add @vlxdisluv/cassandra-driver-adapter
```
## Usage
Import `CassandraDriverAdapterModule`:
```typescript
@Module({
imports: [
CassandraDriverAdapterModule.forRootAsync({...})
],
providers: [...]
})
export class AppModule {}
```
## Async options
Quite often you might want to asynchronously pass your module options instead of passing them beforehand. In such case, use registerAsync() method, that provides a couple of various ways to deal with async data.
**1. Use factory**
```typescript
CassandraDriverAdapterModule.forRootAsync({
useFactory: () => ({...}),
})
```
Obviously, our factory behaves like every other one (might be `async` and is able to inject dependencies through `inject`).
```typescript
CassandraDriverAdapterModule.forRootAsync({
imports: [ConfigModule],
useFactory: (configService: ConfigService) => configService.getDbConfig(),
inject: [ConfigService],
});
```
**2. Use class**
```typescript
CassandraDriverAdapterModule.forRootAsync({
useClass: ConfigService,
});
```
Above construction will instantiate `ConfigService` inside `CassandraDriverAdapterModule` and will leverage it to create options object.
```typescript
class ConfigService implements CassandraDriverAdapterOptionsFactory {
createCassandraDriverAdapterOptions(): CassandraDriverAdapterModuleOptions {
return {...};
}
}
```
**3. Use existing**
```typescript
CassandraDriverAdapterModule.forRootAsync({
imports: [ConfigModule],
useExisting: ConfigService,
});
```
It works the same as `useClass` with one critical difference - `CassandraDriverAdapterModule` will lookup imported modules to reuse already created ConfigService, instead of instantiating it on its own.
## ORM Options
```typescript
import { Entity } from '@vlxdisluv/cassandra-driver-adapter/lib/orm';
@Entity({
tableName: 'messages',
})
export class Message {
id: any;
text: string;
}
```
Let's have a look at the `MessagesModule`
```typescript
import { Module } from '@nestjs/common';
import { CassandraDriverAdapterModule } from '@vlxdisluv/cassandra-driver-adapter';
import { MessagesService } from './messages.service';
import { MessagesController } from './messages.controller';
import { Message } from './message.entity';
@Module({
imports: [CassandraDriverAdapterModule.forFeature([Message])],
providers: [MessagesService],
controllers: [MessagesController],
})
export class MessagesModule {}
```
## Using Repository
```typescript
import { Module } from '@nestjs/common';
import { CassandraDriverAdapterModule } from '@vlxdisluv/cassandra-driver-adapter';
import { MessagesService } from './messages.service';
import { MessagesController } from './messages.controller';
import { Message } from './message.entity';
@Module({
imports: [CassandraDriverAdapterModule.forFeature([Message])],
providers: [MessagesService],
controllers: [MessagesController],
})
export class MessagesModule {}
```
```typescript
import { Injectable } from '@nestjs/common';
import {
InjectRepository,
Repository,
} from '@vlxdisluv/cassandra-driver-adapter';
import { Message } from './message.entity';
import { Observable } from 'rxjs';
@Injectable()
export class PersonService {
constructor(
@InjectRepository(Message)
private readonly messagesRepository: Repository,
) {}
getById(id: id): Promise {
return this.messagesRepository.findOne({ id });
}
}
```
## Using Custom Repository
Let's create a repository:
```typescript
import {
Repository,
EntityRepository,
} from '@vlxdisluv/cassandra-driver-adapter';
import { Message } from './message.entity';
import { Observable } from 'rxjs';
@EntityRepository(Message)
export class MessagesRepository extends Repository {
findById(id: any): Message {
return this.findOne({ id: id });
}
}
```
## Stay in touch
- Author - [Vladislav Severin](https://github.com/vlxdisluv)