NestDrizzle -- Drizzle ORM integration for NestJS

This module was created to integrate Drizzle ORM with NestJS with all serverfull drivers:

1'postgres-js' | 'mysql2' | 'supabase' | 'neon' | 'planetscale' | 'sqlite3'

Installation

To install this project:

1npm i @ockonor/nest-drizzle 
2npm i -D drizzle-kit

Create the drizzle-kit configuration in your project root folder

1// <your project root>/drizzle.config.ts
2import type { Config } from "drizzle-kit";
3 
4export default {
5  schema: "./src/schema.ts",
6  out: "./drizzle",
7} satisfies Config;

Create your schema in your project src folder

See documentation here

1// <your project root>/src/schema.ts
2import { serial, text, timestamp, pgTable } from 'drizzle-orm/pg-core';
3
4export const user = pgTable('user', {
5  id: serial('id'),
6  name: text('name'),
7  email: text('email'),
8  password: text('password'),
9  role: text('role').$type<'admin' | 'customer'>(),
10  createdAt: timestamp('created_at'),
11  updatedAt: timestamp('updated_at'),
12});

Add generate script in package.json and execute drizzle-kit documentation here

1"scripts": {
2    "start:dev": "tsc-watch -p tsconfig.build.json --onSuccess \"node dist/main.js\"",
3    "build": "tsc",
4    "prepare": "npm run build",
5    "format": "prettier --write \"src/**/*.ts\"",
6    "lint": "tslint -p tsconfig.json -c tslint.json",
7    "test": "jest",
8    "test:watch": "jest --watch",
9    "test:cov": "jest --coverage",
10    "test:e2e": "jest --config ./test/jest-e2e.json",
11  + "generate": "drizzle-kit generate:pg"
12  },

1# Update you schema
2npm run generate

Configuration

Modules

Methods:

• register()
• registerAsync()
• forRoot()
• forRootAsync()

1// in your module
2import { NestDrizzleModule } from '@ockonor/nest-drizzle';
3
4@Module({
5  controllers: [NestDrizzleClientController],
6  imports: [
7    NestDrizzleModule.registerAsync({
8      useFactory: () => {
9        return {
10          driver: 'postgres-js', // 'postgres-js'|'mysql2'|'supabase'|'neon'|'planetscale' |'sqlite3'
11          url: 'postgres://<user>:<password>@<host>:<port>/<database>', // postgres://<user>:<password>@<host>:<port>/<database>, ./<your file>.sqlite
12          ...
13        };
14      },
15    }),
16  ],
17})
18export class ...

Types

Don't forget to import the good types in your controllers/services

1// if you have driver 'postgres-js'|'supabase'|'neon'
2import { PostgresJsDb, DRIZZLE_ORM } from '@ockonor/nest-drizzle';
3// or if you have driver 'mysql2'|'planetscale'
4import { MySql2Db, DRIZZLE_ORM } from '@ockonor/nest-drizzle';
5// or if you have the driver 'sqlite3'
6import { SQLite3Db, DRIZZLE_ORM } from '@ockonor/nest-drizzle';
7

Controllers / Services

See documentation here

1// in your controller or service
2import { Controller, Get, Inject } from '@nestjs/common';
3import { user } from '../../schema';
4import { PostgresJsDb, DRIZZLE_ORM } from '@ockonor/nest-drizzle';
5
6@Controller()
7export class NestDrizzleClientController {
8  // private readonly db: PostgresJsDb or MySql2Db or SQLite3Db
9  constructor(@Inject(DRIZZLE_ORM) private readonly db: PostgresJsDb) {}
10
11  @Get()
12  async index() {
13    const allUsers = await this.db.select().from(user);
14    return allUsers;
15  }
16}

TODO

• Command for migration
• Support another serverless databases + sqlite providers
• Add forRoot and forRootAsync