[FEATURE]: supported package for nestjs

[decifris]

Describe want to want

it would be great to have a package like "nestjs-keysely" for drizzle

[Rykuno]

What would the package contain? I'm utilizing nestJS and Drizzle and it was as simple as just creating a drizzle.module.ts and instantiating the client

Oh! You mean the ORM bindings to their entities/repository classes.

I agree that would be incredibly neat.

[decifris]

Yes right? Anyway I had issues even with the first answer, I don't remember the error honestly. Would you like to share the code? It may be helpful for some people, including me!

[Rykuno]

I just wrote a very simple provider. I gave this some more thought and I actually would not prefer to have my ORM tied to my entities. I develop in monorepos so I can have packages/drizzle and reuse that in my app/admin, app/web, and app/api. It would be cool to have the option but I believe it would have be be brought up in the NestJS github.

import { Injectable, OnModuleInit } from '@nestjs/common';
import { NodePgDatabase, drizzle } from 'drizzle-orm/node-postgres';
import * as schema from './schemas';
import { Pool } from 'pg';

@Injectable()
export class DrizzleProvider implements OnModuleInit {
  db: NodePgDatabase<typeof schema>;

  constructor() {}

  async onModuleInit() {
    const client = new Pool({
      connectionString: process.env.DATABASE_URL,
    });

    await client.connect();
    const db = drizzle(client, { schema });
    this.db = db;

    // migrate(this.db, { migrationsFolder: './src/db/migrations' });
  }
}

What im doing is just extending each Entity to implement the Drizzle table class.

import { User } from 'src/database/schemas';

export class UserEntity implements User {
  id: string;
  username: string;
  usernameId: string;
  displayName: string;
  account?: AccountEntity;
  createdAt: Date;
  updatedAt: Date;
}

[stefaanv]

Definately wanted. nestJs is used a lot

[johannesschobel]

Dear @Rykuno ,

can you provide more details on how you got drizzle to work with nestjs and sqlite?
I am struggling quite a bit.

can you provide a minimal reproduction repository?

All the best and thanks for your help,
Johannes

[md-redwan-hossain]

+1

[Rykuno]

My setup is as follows @johannesschobel

drizzle.service.ts

import { Injectable, OnApplicationBootstrap } from '@nestjs/common';
import { NodePgDatabase, drizzle } from 'drizzle-orm/node-postgres';
import { Pool } from 'pg';
import * as schema from './schemas';
import { customAlphabet } from 'nanoid';

@Injectable()
export class DrizzleService implements OnApplicationBootstrap {
  db: NodePgDatabase<typeof schema>;

  async onApplicationBootstrap() {
    const pool = new Pool({
      connectionString: process.env.DATABASE_URL,
    });
    const client = await pool.connect();
    const db = drizzle(client, { schema });
    this.db = db;
  }

  createId() {
    const nanoid = customAlphabet('0123456789abcdefghijklmnopqrstuvwxyz', 12);
    return nanoid();
  }
}

The drizzle.module.ts is a basic NestJS module and the configs are per drizzle docs.

[dylanmeivis]

For anyone coming here using mysql2. The docs state you initiate a connection like this:

import { drizzle } from "drizzle-orm/mysql2";
import mysql from "mysql2/promise";
 
const poolConnection = mysql.createPool({
  host: "host",
  user: "user",
  database: "database",
  ...
});
 
const db = drizzle(poolConnection);

That did not work for me in combination with nestjs. I kept getting TypeError: Cannot read properties of undefined (reading 'createPool'). After changing the import It worked as expected.

// use either
import { createPool } from "mysql2/promise"
const connection = createPool({
  host: "host",
  user: "user",
  database: "database",
  ...
});

// or
import * as mysql from "mysql2/promise"
const connection = mysql.createPool({
  host: "host",
  user: "user",
  database: "database",
  ...
});

[parmetra]

db: NodePgDatabase<typeof schema>

Hello, @Rykuno! I have one question: when creating a query with leftJoin and putting the response in the author field, I get an error, when I try properties into author:
An object literal can only use known properties. "id" does not exist in the type "SQL | Aliased | PgColumn<ColumnBaseConfig<ColumnDataType, string>, {}, {}>".ts(2322)

If I am doing something wrong, please point out my mistake. Or is there any advice on how to resolve the problem?

I am using the NodePgDatabase type when defining the db variable. But if I change type to any it works fine. But that's wrong from a safety standpoint, right?

Here is my query:

const articles = await this.db
  .select({
	articles: {
	  id: articleTable.id,
	  slug: articleTable.slug,
	  title: articleTable.title,
	  body: articleTable.body,
	  createdAt: articleTable.createdAt,
	  author: {
		id: userTable.id,
		username: userTable.username,
		email: userTable.email,
		image: userTable.image,
	  },
	},
  })
  .from(articleTable)
  .leftJoin(userTable, eq(articleTable.authorId, userTable.id));

My schema:

import { relations } from 'drizzle-orm';
import { serial, text, pgTable, timestamp, integer } from 'drizzle-orm/pg-core';

export const tags = pgTable('tags', {
  id: serial('id').primaryKey(),
  value: text('value'),
});

export const user = pgTable('user', {
  id: serial('id').primaryKey(),
  username: text('username').notNull(),
  email: text('email').notNull(),
  password: text('password').notNull(),
  image: text('image').default(null),
});

export const userRelations = relations(user, ({ many }) => ({
  article: many(article),
}));

export const article = pgTable('article', {
  id: serial('id').primaryKey(),
  slug: text('slug').notNull(),
  title: text('title').notNull(),
  body: text('body').default(null),
  createdAt: timestamp('createdAt').defaultNow(),
  authorId: integer('authorId').references(() => user.id),
});

export const articleRelations = relations(article, ({ one }) => ({
  authorId: one(user, {
    fields: [article.authorId],
    references: [user.id],
  }),
}));

[vladkrasn]

The thing that stops me from trying out drizzle is lack of official documentation/package about nest integration (either by nest or drizzle itself)

[vladkrasn]

It's not that hard to build a module out of drizzle, and utilize it using NestJS patterns. The hard part is to make Drizzle integration full-featured.

For example, in Mikro-ORM, the table schemas are classes (https://mikro-orm.io/docs/guide/first-entity#first-entity), and that makes them an easy single source of truth about the entities. Then, you can throw nestjs' swagger decorators on them, and a correct OpenAPI schema will be generated.

You can't really do that with Drizzle.

[solmanter]

i working on this package nestjs-drizzle right now only supports mysql and postgres.