A NestJS module for integrating Drizzle ORM with Turso
Table of Contents
Installation
npm install @knaadh/nestjs-drizzle-turso drizzle-orm @libsql/client
Usage
Import the DrizzleTursoModule 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 { DrizzleTursoModule } from '@knaadh/nestjs-drizzle-turso';
@Module({
imports: [
// Method #1: Pass options object
DrizzleTursoModule.register({
tag: 'DB_DEV',
turso: {
config: {
url: 'DATABASE_URL',
authToken: 'DATABASE_AUTH_TOKEN',
},
},
config: { schema: { ...schema } },
}),
// Method #2: useFactory()
DrizzleTursoModule.registerAsync({
tag: 'DB_PROD',
useFactory() {
return {
turso: {
config: {
url: 'DATABASE_URL',
authToken: 'DATABASE_AUTH_TOKEN',
},
},
config: { schema: { ...schema } },
};
},
}),
// Method #3: useClass()
DrizzleTursoModule.registerAsync({
tag: 'DB_STAGING',
useClass: DBConfigService,
}),
],
controllers: [AppController],
providers: [AppService],
})
export class AppModule {}
export class DBConfigService {
create = () => {
return {
turso: {
config: {
url: 'DATABASE_URL',
authToken: 'DATABASE_AUTH_TOKEN',
},
},
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 { LibSQLDatabase } from 'drizzle-orm/libsql';
@Injectable()
export class AppService {
constructor(
@Inject('DB_DEV') private drizzleDev: LibSQLDatabase<typeof schema>,
@Inject('DB_PROD') private drizzleProd: LibSQLDatabase<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 DrizzleTursoModule option
object has the following interface:
export interface DrizzleTursoConfig {
turso: {
config: Config;
};
config?: DrizzleConfig<any> | undefined;
}
-
turso.config:
Turso config - (optional)
config:
DrizzleORM configuration.
Documentation
License
This package is MIT licensed.