Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tony133/nestjs-knexjs
Knexjs module for Nest framework (node.js) 😻
https://github.com/tony133/nestjs-knexjs
javascript knex knexjs mariadb mysql nest nestjs nestjs-knexjs nodejs postgresql sqlite typescript
Last synced: 12 days ago
JSON representation
Knexjs module for Nest framework (node.js) 😻
- Host: GitHub
- URL: https://github.com/tony133/nestjs-knexjs
- Owner: Tony133
- License: mit
- Created: 2021-02-22T20:50:25.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-12T12:58:57.000Z (7 months ago)
- Last Synced: 2024-04-12T20:19:53.036Z (7 months ago)
- Topics: javascript, knex, knexjs, mariadb, mysql, nest, nestjs, nestjs-knexjs, nodejs, postgresql, sqlite, typescript
- Language: TypeScript
- Homepage:
- Size: 3.78 MB
- Stars: 75
- Watchers: 4
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
[circleci-url]: https://circleci.com/gh/nestjs/nest
A progressive Node.js framework for building efficient and scalable server-side applications.
## Description
Knexjs module for Nest framework (node.js) 😻
## Installation
First install the module via `yarn` or `npm` or `pnpm` and do not forget to install the driver package as well:
```bash
$ npm i --save nest-knexjs knex mysql # for mysql/mariadb
$ npm i --save nest-knexjs knex pg # for postgresql
$ npm i --save nest-knexjs knex sqlite # for sqlite
$ npm i --save nest-knexjs knex oracledb # for oracledb
```
or
```bash
$ yarn add nest-knexjs knex mysql # for mysql/mariadb
$ yarn add nest-knexjs knex pg # for postgresql
$ yarn add nest-knexjs knex sqlite # for sqlite
$ yarn add nest-knexjs knex oracledb # for oracledb
```
or
```bash
$ pnpm add nest-knexjs knex mysql # for mysql/mariadb
$ pnpm add nest-knexjs knex pg # for postgresql
$ pnpm add nest-knexjs knex sqlite # for sqlite
$ pnpm add nest-knexjs knex oracledb # for oracledb
```
## Table of Contents
- [Description](#description)
- [Table of Contents](#table-of-contents)
- [Usage](#usage)
- [KnexModule](#knexmodule)
- [ExampleOfUse](#example-of-use)
- [MultiConnectionsDatabase](#multi-connections-database)
- [CreateMigrations](#create-migrations)
- [RunMigrations](#run-migrations)
- [CreateSeeds](#create-seeds)
- [RunSeeds](#run-seeds)
## Usage
### KnexModule
KnexModule is the primary entry point for this package and can be used synchronously
```typescript
@Module({
imports: [
KnexModule.forRoot({
config: {
client: 'mysql',
version: '5.7',
connection: {
host: '127.0.0.1',
user: 'root',
password: 'root',
database: 'test',
},
},
}),
],
})
```
or asynchronously
```typescript
@Module({
imports: [
KnexModule.forRootAsync({
useFactory: () => ({
config: {
client: 'mysql',
version: '5.7',
connection: {
host: '127.0.0.1',
user: 'root',
password: 'root',
database: 'test',
},
},
}),
}),
],
})
```
## Example of use
UsersService:
```typescript
import { Injectable } from '@nestjs/common';
import { Knex } from 'knex';
import { InjectConnection } from 'nest-knexjs';
@Injectable()
export class UsersService {
constructor(@InjectConnection() private readonly knex: Knex) {}
async findAll() {
const users = await this.knex.table('users');
return { users };
}
}
```
UsersController:
```typescript
import { Controller, Get } from '@nestjs/common';
import { UsersService } from './users.service';
@Controller()
export class UsersController {
constructor(private readonly usersService: UsersService) {}
@Get()
async getAllUsers() {
return await this.usersService.findAll();
}
}
```
## Multi Connections Database
```typescript
@Module({
imports: [
KnexModule.forRootAsync(
{
useFactory: () => ({
config: {
client: 'mysql',
version: '5.7',
useNullAsDefault: true,
connection: {
host: '127.0.0.1',
user: 'root',
port: 3306,
password: 'root',
database: 'test1',
},
pool: {
min: 2,
max: 10,
},
},
}),
},
'db1Connection',
),
KnexModule.forRootAsync(
{
useFactory: () => ({
config: {
client: 'mysql',
version: '5.7',
useNullAsDefault: true,
connection: {
host: '127.0.0.1',
user: 'root',
port: 3307,
password: 'root',
database: 'test2',
},
pool: {
min: 2,
max: 10,
},
},
}),
},
'db2Connection',
),
],
controllers: [],
providers: [],
})
export class AppModule {}
```
Usage example with Multi Connection
PostService:
```typescript
@Injectable()
export class PostService {
constructor(
@InjectConnection('db2Connection')
private knexConnection: Knex,
) {}
async create(createPostDto: CreatePostDto) {
try {
const post = await this.knexConnection.table('posts').insert({
title: createPostDto.title,
description: createPostDto.description,
});
return post;
} catch (err) {
throw new HttpException(err, HttpStatus.BAD_REQUEST);
}
}
async findAll() {
const posts = await this.knexConnection.table('posts');
return { posts };
}
}
```
UsersService:
```typescript
@Injectable()
export class UsersService {
constructor(
@InjectConnection('db1Connection')
private knexConnection: Knex,
) {}
async findAll() {
const users = await this.knexConnection.table('users');
return { users };
}
async create(createUserDto: CreateUserDto) {
try {
const users = await this.knexConnection.table('users').insert({
firstName: createUserDto.firstName,
lastName: createUserDto.lastName,
});
return { users };
} catch (err) {
throw new HttpException(err, HttpStatus.BAD_REQUEST);
}
}
}
```
In `knexfile.js` update with your database configuration settings:
```javascript
module.exports = {
development: {
client: 'mysql',
version: '5.7',
connection: {
name: 'db1Connection',
host: '127.0.0.1',
user: 'root',
port: 3306,
password: 'root',
database: 'test1',
},
migrations: {
directory: './migrations/users',
tableName: '[:name_file_migrations_users]',
},
},
developmentTwo: {
client: 'mysql',
version: '5.7',
connection: {
name: 'db2Connection',
host: '127.0.0.1',
user: 'root',
port: 3307,
password: 'root',
database: 'test2',
},
migrations: {
directory: './migrations/posts',
tableName: '[:name_file_migrations_posts]',
},
},
};
```
Run Migrations:
```bash
$ npx knex migrate:latest --env development
$ npx knex migrate:latest --env developmentTwo
```
## Create Migrations
```bash
$ npx knex init
$ npx knex migrate:make [name_migrations]
```
Example file migrations:
```typescript
exports.up = function(knex) {
return knex.schema
.createTable('users', function(table) {
table.increments('id');
table.string('firstName', 255).notNullable();
table.string('lastName', 255).notNullable();
})
.createTable('products', function(table) {
table.increments('id');
table.string('name', 255).notNullable();
table.decimal('price').notNullable();
});
};
exports.down = function (knex) {
return knex.schema.dropTable('products').dropTable('users');
};
```
## Run Migrations
In `knexfile.js` update with your config settings:
```javascript
module.exports = {
development: {
client: 'mysql',
connection: {
host: '127.0.0.1',
user: 'root',
password: 'root',
database: 'test',
},
},
}
```
then we run the following command from the terminal
```bash
$ npx knex migrate:latest
```
## Create Seeds
```bash
$ npx knex seed:make [name_seed]
```
Example file seeds
```javascript
exports.seed = function (knex) {
return knex('users')
.del()
.then(function () {
return knex('users').insert([
{ id: 1, firstName: 'firstName#1', lastName: 'lastName#1' },
{ id: 2, firstName: 'firstName#2', lastName: 'lastName#2' },
{ id: 3, firstName: 'firstName#3', lastName: 'lastName#3' },
]);
});
};
```
## Run Seeds
```
$ npx knex seed:run
```
For more information on `Knex.js` see [here](http://knexjs.org/)
## Contribute
Feel free to help this library, I'm quite busy with also another Nestjs packages, but the community will appreciate the effort of improving this library. Make sure you follow the guidelines
## Stay in touch
- Author - [Tony133](https://github.com/Tony133)
- Framework - [https://nestjs.com](https://nestjs.com/)
## License
[MIT licensed](LICENSE)