JSPM – @knaadh/nestjs-drizzle-postgres@1.1.0

Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@knaadh/nestjs-drizzle-postgres) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

A NestJS module for integrating Drizzle ORM with PostgresJS driver

Table of Contents
Installation
Usage
Configuration
Documentation
License

Installation

npm install @knaadh/nestjs-drizzle-postgres drizzle-orm postgres

Usage

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

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

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

    // Method #2: useFactory()
    DrizzlePostgresModule.registerAsync({
      tag: 'DB_PROD',
      useFactory() {
        return {
          postgres: {
            url: 'postgres://postgres:@127.0.0.1:5432/drizzleDB',
          },
          config: { schema: { ...schema } },
        };
      },
    }),

    // Method #3: useClass()
     DrizzlePostgresModule.registerAsync({
      tag: 'DB_STAGING',
      useClass: DBConfigService,
    }),
  ],

  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

export class DBConfigService {
  create = () => {
    return {
      postgres: {
        url: '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

import { Inject, Injectable } from '@nestjs/common';
import { PostgresJsDatabase } from 'drizzle-orm/postgres-js';
import * as schema from '../db/schema';
@Injectable()
export class AppService {
  constructor(
    @Inject('DB_DEV') private drizzleDev: PostgresJsDatabase<typeof schema>,
    @Inject('DB_PROD') private drizzleProd: PostgresJsDatabase<typeof schema>
    ) {}
  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 DrizzlePostgresModule option object has the following interface:

export interface DrizzlePostgresConfig {
  postgres: {
    url: string;
    config?: Options<Record<string, PostgresType<any>>> | undefined;
  };
  config?: DrizzleConfig<any> | undefined;
}

postgres.url: postgres url connection string
(optional) postgres.config: Postgres.js driver options
(optional) config: DrizzleORM configuration

Documentation

License

This package is MIT licensed.

@knaadh/nestjs-drizzle-postgres