JSPM – nestjs-drizzle@0.5.4

Package Exports

nestjs-drizzle
nestjs-drizzle/dist/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 (nestjs-drizzle) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Nest.js Drizzle

Currently only support mysql2

Todo List

mysql2
planetscale
postgresjs
node-postgres
supabase
neon
vercel postgres
sqlite
turso

npm install nestjs-drizzle

app.module.ts

import { ConfigModule } from '@nestjs/config';
import { DrizzleModule } from 'nestjs-drizzle';
@Module({
  imports: [
    ConfigModule.forRoot({ isGlobal: true }),
    DrizzleModule.forMysql2({
      isGlobal: true,
      schema,
      pool: {
        host: process.env.HOST,
        port: process.env.PORT,
        user: process.env.USER,
        password: process.env.PASSWORD,
        database: process.env.DATABASE,
      }
    }),
  ]
})

I recomend to use environment.d.ts file for env type safety.

declare namespace NodeJS {
  interface ProcessEnv {
    [key: string]: string | undefined;
    DATABASE: string;
    USER: string;
    PASSWORD: string;
    PORT: number;
    HOST: string;
    // add more environment variables and their types here
  }
}

any.service.ts

import { Injectable } from "@nestjs/common";
import { DrizzleService } from "nestjs-drizzle";
import { users } from "./drizzle";
import { isNull } from "drizzle-orm";

@Injectable()
export class AppService {
  constructor(private readonly drizzle: DrizzleService) {}

  async getUsers() {
    return await this.drizzle
      .get({
        from: users,
        select: {
          id: users.id,
          username: users.username,
        },
        limit: 10,
      })
      .where(isNull(users.deletedAt));
  }
}

Other helper functions

// values is basicly set
this.drizzle.insert(users, values);

this.drizzle.update(users, values).where(eq(users.id, 10));

this.drizzle.delete(users).where(eq(users.id, 10));

if you need to other features

this.drizzle.db; // all orm in db

this.drizzle.delete(users).where(eq(users.id, 10)).prepare();

this.drizzle.insert(users, values).$dynamic;

Using query

// first make DrizzleService to type safe
import * as schema from "SCHEMA_PATH";
@Injectable()
export class AppService {
  constructor(
    private readonly drizzle: DrizzleService<typeof schema> // <- put here <typeof schema>
  ) {}

  getUsers() {
    this.drizzle.db.query.users.findMany({
      columns: {
        id: true,
        name: true,
      },
      limit: 10,
    });
  }
}

Bugs showcase

npm ERR! Found: reflect-metadata@0.2.1

in package.json reflect-metadata change vertion to ^0.1.14