Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tony133/nestjs-mysql
Mysql module for Nest framework (node.js) 😻
https://github.com/tony133/nestjs-mysql
javascript mysql mysql2 nest nest-module nest-mysql nestjs nestjs-mysql typescript
Last synced: 2 months ago
JSON representation
Mysql module for Nest framework (node.js) 😻
- Host: GitHub
- URL: https://github.com/tony133/nestjs-mysql
- Owner: Tony133
- License: mit
- Created: 2022-06-24T17:08:30.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-04T16:04:13.000Z (3 months ago)
- Last Synced: 2024-10-04T19:33:23.584Z (3 months ago)
- Topics: javascript, mysql, mysql2, nest, nest-module, nest-mysql, nestjs, nestjs-mysql, typescript
- Language: TypeScript
- Homepage:
- Size: 2.19 MB
- Stars: 14
- Watchers: 4
- Forks: 3
- 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
MySQL 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-mysql mysql2
```
or
```bash
$ yarn add nest-mysql mysql2
```
or
```bash
$ pnpm add nest-mysql mysql2
```
## Table of Contents
- [Description](#description)
- [Table of Contents](#table-of-contents)
- [Usage](#usage)
- [MySqlModule](#mysqlmodule)
- [MultiConnectionsDatabase](#multi-connections-database)
- [ExampleOfUse](#example-of-use)
## Usage
### MySqlModule
MySqlModule is the primary entry point for this package and can be used synchronously
```typescript
@Module({
imports: [
MysqlModule.forRoot({
host: 'localhost',
database: 'test2',
password: 'root',
user: 'root',
port: 3306,
}),
],
})
```
or asynchronously
```typescript
@Module({
imports: [
MysqlModule.forRootAsync({
useFactory: () => ({
host: 'localhost',
database: 'test',
password: 'root',
user: 'root',
port: 3306,
}),
}),
],
})
```
## Example of use
UsersService:
```typescript
import { Injectable } from '@nestjs/common';
import { InjectClient } from 'nest-mysql';
import { Connection } from 'mysql2';
import { User } from '../interfaces/user.interface';
@Injectable()
export class UsersService {
constructor(@InjectClient() private readonly connection: Connection) {}
async findAll(): Promise {
const users = await this.connection.query('SELECT * FROM users');
const results = Object.assign([{}], users[0]);
return results;
}
}
```
UsersController:
```typescript
import { Controller, Get } from '@nestjs/common';
import { UsersService } from './users.service';
import { User } from '../interfaces/user.interface';
@Controller()
export class UsersController {
constructor(private readonly usersService: UsersService) {}
@Get()
async getAllUsers(): Promise {
return await this.usersService.findAll();
}
}
```
## Multi Connections Database
```typescript
@Module({
imports: [
MysqlModule.forRootAsync(
{
useFactory: () => ({
host: 'localhost',
database: 'test1',
password: 'root',
user: 'root',
port: 3306,
}),
},
'db1Connection',
),
MysqlModule.forRootAsync(
{
useFactory: () => ({
host: 'localhost',
database: 'test2',
password: 'root',
user: 'root',
port: 3307,
}),
},
'db2Connection',
),
],
controllers: [],
providers: [],
})
export class AppModule {}
```
Usage example with Multi Connection
PostService:
```typescript
import { Pool } from 'mysql2';
import { InjectConnection } from 'nest-mysql';
import { CreatePostDto } from './dto/create-post.dto';
import { Post } from '../interfaces/post.interface';
@Injectable()
export class PostService {
constructor(
@InjectConnection('db2Connection')
private dbConnection: Pool,
) {}
public async findAll(): Promise {
const posts = await this.dbConnection.query('SELECT * FROM posts');
const results = Object.assign([{}], posts[0]);
return results;
}
public async create(createPostDto: CreatePostDto): Promise {
try {
const post = await this.dbConnection.query(
'INSERT INTO posts (title, description) VALUES (?, ?)',
[createPostDto.title, createPostDto.description],
);
return post;
} catch (err) {
throw new HttpException(err, HttpStatus.BAD_REQUEST);
}
}
}
```
UsersService:
```typescript
import { Pool } from 'mysql2';
import { InjectConnection } from 'nest-mysql';
import { CreateUserDto } from './dto/create-user.dto';
import { User } from '../interfaces/user.interface';
@Injectable()
export class UsersService {
constructor(
@InjectConnection('db1Connection')
private dbConnection: Pool,
) {}
public async findAll(): Promise {
const users = await this.dbConnection.query('SELECT * FROM users');
const results = Object.assign([{}], users[0]);
return results;
}
public async create(createUserDto: CreateUserDto): Promise {
try {
const user = await this.dbConnection.query(
'INSERT INTO users (firstName, lastName) VALUES (?, ?)',
[createUserDto.firstName, createUserDto.lastName],
);
return user;
} catch (err) {
throw new HttpException(err, HttpStatus.BAD_REQUEST);
}
}
}
```
For more information on `node-mysql` see [here](https://github.com/sidorares/node-mysql2)
## 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)