JSPM – @knaadh/nestjs-drizzle-better-sqlite3@1.2.0

Package Exports

@knaadh/nestjs-drizzle-better-sqlite3
@knaadh/nestjs-drizzle-better-sqlite3/src/index.js

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-better-sqlite3) 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 Better-SQLite3 driver

Table of Contents
Installation
Usage
Configuration
Documentation
License

Installation

npm install @knaadh/nestjs-drizzle-better-sqlite3 drizzle-orm better-sqlite3

Usage

Import the DrizzleBetterSQLiteModule 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 { DrizzleBetterSQLiteModule } from '@knaadh/nestjs-drizzle-better-sqlite3';

@Module({
  imports: [
    // Method #1: Pass options object
    DrizzleBetterSQLiteModule.register({
      tag: 'DB_DEV',
      sqlite3: {
        filename: 'demo.db',
      },
      config: { schema: { ...schema } },
    }),

    // Method #2: useFactory()
   DrizzleBetterSQLiteModule.registerAsync({
      tag: 'DB_PROD',
      useFactory() {
        return {
          sqlite3: {
            filename: 'demo.db',
          },
          config: { schema: { ...schema } },
        };
      },
    }),

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

export class DBConfigService {
  create = () => {
    return {
      sqlite3: {
        filename: 'demo.db',
      },
      config: { schema: { ...schema } },
    };
  };
}

You can inject the Drizzle instances using their respective tag specified in the configurations

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

export interface DrizzleBetterSQLiteConfig {
  sqlite3: {
    filename: string | Buffer;
    options?: Database.Options | undefined;
  };
  config?: DrizzleConfig<any> | undefined;
}

sqlite3.filename: path to the database file. If the database file does not exist, it is created
(optional) sqlite3.options: BetterSQLite options
(optional config: DrizzleORM configuration.

Documentation

License

This package is MIT licensed.

@knaadh/nestjs-drizzle-better-sqlite3