Table of Contents

Description

Installation

npm install nestjs-knex knex

npx nestjs-modules

Examples

npm install nestjs-knex knex sqlite3

KnexModule.forRoot(options, connection?)

import{Module}from'@nestjs/common';import{KnexModule}from'nestjs-knex';import{AppController}from'./app.controller';@Module({imports:[KnexModule.forRoot({config:{client:"sqlite3",useNullAsDefault:true,connection:':memory:',},}),],controllers:[AppController],})exportclassAppModule{}

KnexModule.forRootAsync(options, connection?)

import{Module}from'@nestjs/common';import{KnexModule}from'nestjs-knex';import{AppController}from'./app.controller';@Module({imports:[KnexModule.forRootAsync({useFactory:()=>({config:{client:"sqlite3",useNullAsDefault:true,connection:':memory:',},}),}),],controllers:[AppController],})exportclassAppModule{}

InjectKnex(connection?)

import{Controller,Get,}from'@nestjs/common';import{InjectKnex,Knex}from'nestjs-knex';@Controller()exportclassAppController{constructor(    @InjectKnex()privatereadonlyknex:Knex,){}  @Get()asyncgetHello(){if(!awaitthis.knex.schema.hasTable('users')){awaitthis.knex.schema.createTable('users',table=>{table.increments('id').primary();table.string('name');});}awaitthis.knex.table('users').insert({name:'Name'});constusers=awaitthis.knex.table('users');return{ users};}}

License