Socket
Socket
Sign inDemoInstall

@knaadh/nestjs-drizzle-postgres

Package Overview
Dependencies
4
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@knaadh/nestjs-drizzle-postgres

A NestJS module for integrating Drizzle ORM with PostgresJS driver


Version published
Weekly downloads
977
decreased by-8.09%
Maintainers
1
Install size
94.3 kB
Created
Weekly downloads
 

Readme

Source

Nest Logo

A NestJS module for integrating Drizzle ORM with PostgresJS driver

Nrwl Nx

Table of Contents

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 { 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.

Keywords

FAQs

Last updated on 24 Oct 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc