@knaadh/nestjs-drizzle-pg

A NestJS module for integrating Drizzle ORM with Node-Postgres driver

Table of Contents

- Table of Contents
- Installation
- Usage
- Configuration
- Documentation
- License

Installation

``bash
npm install @knaadh/nestjs-drizzle-pg drizzle-orm pg
`

Usage

Import the DrizzlePGModule module and pass an options object to initialize it. You can pass options object using the usual methods for custom providers as shown below:

`typescript
import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import * as schema from '../db/schema';
import { DrizzlePGModule } from '@knaadh/nestjs-drizzle-pg';

@Module({
imports: [
// Method #1: Pass options object
DrizzlePGModule.register({
tag: 'DB_DEV',
pg: {
connection: 'client',
config: {
connectionString: 'postgres://postgres:@127.0.0.1:5432/drizzleDB',
},
},
config: { schema: { ...schema } },
}),

// Method #2: useFactory()
DrizzlePGModule.registerAsync({
tag: 'DB_PROD',
useFactory() {
return {
pg: {
connection: 'client',
config: {
connectionString: 'postgres://postgres:@127.0.0.1:5432/drizzleDB',
},
},
config: { schema: { ...schema } },
};
},
}),

// Method #3: useClass()
DrizzlePGModule.registerAsync({
tag: 'DB_STAGING',
useClass: DBConfigService,
}),
],
controllers: [AppController],
providers: [AppService],
})
export class AppModule {}
`

`typescript
export class DBConfigService {
create = () => {
return {
pg: {
connection: 'client' as const,
config: {
connectionString: 'postgres://postgres:@127.0.0.1:5432/drizzleDB',
},
},
config: { schema: { ...schema } },
};
};
}
`
You can inject the Drizzle instances using their respective tag specified in the configurations

`typescript
import { Inject, Injectable } from '@nestjs/common';
import * as schema from '../db/schema';
import { NodePgDatabase } from 'drizzle-orm/node-postgres';
@Injectable()
export class AppService {
constructor(
@Inject('DB_DEV') private drizzleDev: NodePgDatabase,
@Inject('DB_PROD') private drizzleProd: NodePgDatabase
) {}
async getData() {
const books = await this.drizzleDev.query.books.findMany();
const authors = await this.drizzleProd.query.authors.findMany();
return {
books: books,
authors: authors,
};
}
}
`

Configuration

A DrizzlePGModule option object has the following interface:

`typescript
export interface DrizzlePGConfig {
pg: {
connection: 'client' | 'pool';
config: ClientConfig | PoolConfig;
};
config?: DrizzleConfig | undefined;
}
`

- pg.connection: single client connection or a pool as mentioned here
- (optional) postgres.config: pass client config or pool config according to the connection
- (optional) config:` DrizzleORM configuration

Documentation

- NX
- DrizzleORM
- Node-PostGres

License

This package is MIT licensed.