/nestjs-mongodb-driver

MongoDB Node Driver module for Nest framework (node.js) 😻

Primary LanguageTypeScriptMIT LicenseMIT

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

MongoDB Native Driver 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-mongodb-driver mongodb

or

    $ yarn add nest-mongodb-driver mongodb

or

    $ pnpm add nest-mongodb-driver mongodb

Table of Contents

Usage

MongoDbDriverModule

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

@Module({
  imports: [
    MongoDbDriverModule.forRoot({
        url: 'mongodb://localhost:27017/[:nameDb]',
    }),
  ],
})

or asynchronously

@Module({
  imports: [
    MongoDbDriverModule.forRootAsync({
      useFactory: () => ({
        url: 'mongodb://localhost:27017/[:nameDb]',
      }),
    }),
  ],
})

Example of use

UsersService:

import { Injectable } from '@nestjs/common';
import { Db, ObjectId } from 'mongodb';
import { InjectClient } from 'nest-mongodb-driver';
import type {
  Document,
} from 'mongodb';

@Injectable()
export class UsersService {
  constructor(@InjectClient() private readonly db: Db) {}

  async findAll(): Promise<Document[]> {
    return await this.db.collection('users').find().toArray();
  }
}

UsersController:

import { Controller, Get } from '@nestjs/common';
import { UsersService } from './users.service';
import type {
  Document,
} from 'mongodb';

@Controller()
export class UsersController {
  constructor(private readonly usersService: UsersService) {}

  @Get()
  async getAllUsers(): Promise<Document[]> {
    return await this.usersService.findAll();
  }
}

Multi Connections Database

@Module({
  imports: [
    MongoDbDriverModule.forRootAsync(
      {
        useFactory: () => ({
          url: 'mongodb://localhost:27017/test1',
        }),
      },
      'db1Connection',
    ),
    MongoDbDriverModule.forRootAsync(
      {
        useFactory: () => ({
          url: 'mongodb://localhost:27018/test2',
        }),
      },
      'db2Connection',
    ),
  ],
  controllers: [],
  providers: [],
})
export class AppModule {}

Usage example with Multi Connection

PostService:

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

  public async findAll(): Promise<Document[]> {
    return await this.dbConnection.collection('posts').find().toArray();
  }

  public async create(createPostDto: CreatePostDto): Promise<InsertOneResult<Document>> {
    try {
      return await this.dbConnection
        .collection('posts')
        .insertOne(createPostDto);
    } catch (err) {
      throw new HttpException(err, HttpStatus.BAD_REQUEST);
    }
  }

UsersService:

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

  public async findAll(): Promise<Document[]> {
    return await this.dbConnection.collection('users').find().toArray();
  }

  public async create(createUserDto: CreateUserDto): Promise<InsertOneResult<Document>> {
    try {
      return await this.dbConnection
        .collection('users')
        .insertOne(createUserDto);
    } catch (err) {
      throw new HttpException(err, HttpStatus.BAD_REQUEST);
    }
  }
}

For more information on MongoDB NodeJS Driver 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