Code Monkey home page Code Monkey logo

nestjs-mysql's Introduction

Nest Logo

A progressive Node.js framework for building efficient and scalable server-side applications.

NPM Version Package License NPM Downloads CircleCI Coverage Discord Backers on Open Collective Sponsors on Open Collective Support us

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:

    $ npm i --save nest-mysql mysql2

or

    $ yarn add nest-mysql mysql2

or

    $ pnpm add nest-mysql mysql2

Table of Contents

Usage

MySqlModule

MySqlModule is the primary entry point for this package and can be used synchronously

@Module({
  imports: [
    MysqlModule.forRoot({
        host: 'localhost',
        database: 'test2',
        password: 'root',
        user: 'root',
        port: 3306,      
    }),
  ],
})

or asynchronously

@Module({
  imports: [
    MysqlModule.forRootAsync({
      useFactory: () => ({
        host: 'localhost',
        database: 'test',
        password: 'root',
        user: 'root',
        port: 3306,      
      }),
    }),
  ],
})

Example of use

UsersService:

import { Injectable } from '@nestjs/common';
import { InjectClient } from 'nest-mysql';
import { Connection } from 'mysql2';

@Injectable()
export class UsersService {
  constructor(@InjectClient() private readonly connection: Connection) {}

  async findAll() {
    const users = await this.connection.query('SELECT * FROM users');
    const results = Object.assign([{}], users[0]);

    return results;
  }
}

UsersController:

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

@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:

import { Pool } from 'mysql2';
import { InjectConnection } from 'nest-mysql';
import { CreatePostDto } from './dto/create-post.dto';

@Injectable()
export class PostService {
  constructor(
    @InjectConnection('db2Connection')
    private dbConnection: Pool,
  ) {}

  public async findAll(): Promise<any> {
    const posts = await this.dbConnection.query('SELECT * FROM posts');
    const results = Object.assign([{}], posts[0]);

    return results;
  }

  public async create(createPostDto: CreatePostDto): Promise<any> {
    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:

import { Pool } from 'mysql2';
import { InjectConnection } from 'nest-mysql';
import { CreateUserDto } from './dto/create-user.dto';

@Injectable()
export class UsersService {
  constructor(
    @InjectConnection('db1Connection')
    private dbConnection: Pool,
  ) {}

  public async findAll(): Promise<any> {
    const users = await this.dbConnection.query('SELECT * FROM users');
    const results = Object.assign([{}], users[0]);

    return results;
  }

  public async create(createUserDto: CreateUserDto): Promise<any> {
    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

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

License

MIT licensed

nestjs-mysql's People

Contributors

renovate[bot] avatar tony133 avatar dependabot[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.