Skip to main content

NestJS Multiple MongoDB Databases Accessing Sample Code

Introduction:

Most of the case's applications are going to communicate with more than one database. Here I'm going to walk through with sample NestJS application which communicates with multiple MongoDB's. Click here to know more about NestJS API CRUD using MongoDB.

MongoDB Atlas:

MongoDB Atlas is a cloud database. It has all the options of creating a MongoDB instance like for Free MongoDB Instance(for learning), Paid MongoDB Instance(for production). To illustrate multiple MongoDB connections for sample application here I'm going to use this Cloud MongoDB Atlas.

It is fairly minimal steps involved for created a Cloud MongoDB instance.
Note:
It is not mandatory to use the cloud based MongoDb database. You can use either locally installed instances like Mongo Shell, MongoDb Compass.

Create Sample NestJS Application:

NestJS provides CLI which helps to create a boilerplate templated application to getting started

NestJS CLI command:
npm i -g @nestjs/cli
Command to create NestJS sample application:
nest new your_application_name
Commands to start the application:
npm run Start:dev 
npm run Start:prod

mongoose and @nestj/mongoose:

mongoose and @nestjs/mongoose plugins used to create a communication bridge between MongoDB and NestJS application.
Commands to install:
npm install --save @nestjs/mongoose
npm install --save mongoose

Atlas MongoDB ConnectionString:

Now we need to fetch the connection string to configure in our NestJS application.
After clicking on the 'Connect your application' tab we can get connection string as below.

Configure  Multiple MongoDB:

Configure MongoDB connection as below.
src/app.module.ts:
import { MongooseModule } from '@nestjs/mongoose';
// some code hidden for display purpose
@Module({
  imports: [
    
    MongooseModule.forRoot(
      'mongodb+srv://<username>:<passowrd>@cluster0-igk.mongodb.net/MyWorld?retryWrites=true&w=majority',
      {
        connectionName: 'myWorldDb'
      }
    ),
    MongooseModule.forRoot(
      'mongodb+srv://<username>:<passowrd>@cluster0-igk.mongodb.net/WildLife?retryWrites=true&w=majority',
      {
        connectionName: 'wildLifeDb'
      }
    )

  ],
})
export class AppModule {}
  • Import the MongooseModule from the '@nestjs/mongoose' library.
  • 'MongooseModule.forRoot' extension method takes the input parameters like database connection string and options object of type 'MongooseModuleOptions'.
  • 'MongooseModuleOptions' interface type has property like 'connectionName' which helps determine the kind of database connection for the specified connection string.
  • So on to configure multiple databases can be done by importing the multiple 'MongooseModule.forRoot' as above
  • In the sample above connection string, you need to use our own 'username' and 'password' while working with NestJS application with MongoDB
  • In the sample above 'MyWorld' and 'WildLife' pointed to the databases I have created in Cloud MongoDB Atlas.
Now to query the MongoDB collections(means Table), we need to configure the Mongo schema as follows.
src/schemas/myworld/student.schema.ts:(this schema represents 'MyWorld' database of collection name 'Student')
import * as mongoose from 'mongoose';
export const studentSchema = new mongoose.Schema({
    FirstName:String,
    LastName: String,
    Standard: Number,
    FatherName: String,
    MotherName: String
});
  • 'mongoose' library gets imported into the variable name mongoose(import * as mongoose from 'mongoose')
  • Using the mongoose variable creating an instance of 'Schema' by registering all MongoDB Collection columns as property into it.
  • Now, this schema represents a Collection in MongoDB and using this schema we are able to query the collection.
Similarly, add the Schema of the Collection of another database as below:
src/schemas/wildlife/animal.schema.ts:(this scheme represents 'WildLife' database of collection name 'Animals'):
import * as mongoose from 'mongoose';

export const animalSchema = new mongoose.Schema({
    Name:String
})
Now register these Collection(Table) schemas in the application and also need to map them to appropriate database connections follows.
import { Module } from '@nestjs/common';
import { MongooseModule } from '@nestjs/mongoose';
import { studentSchema } from './schemas/myworld/student.schema';
import { animalSchema } from './schemas/wildlife/animal.schema';

@Module({
  imports: [
    MongooseModule.forFeature([
      {
        name: 'Student',
        schema: studentSchema,
        collection: 'Student',
        
      },
    ],'myWorldDb'),
    MongooseModule.forFeature([
      {
        name: 'Animals',
        schema: animalSchema,
        collection: 'Animals'
      }
    ],'wildLifeDb'),
    MongooseModule.forRoot(
      'mongodb+srv://<userName>:<password>@cluster0-igk.mongodb.net/MyWorld?retryWrites=true&w=majority',
      {
        connectionName: 'myWorldDb'
      }
    ),
    MongooseModule.forRoot(
      'mongodb+srv://<username>:<password>@cluster0-igk.mongodb.net/WildLife?retryWrites=true&w=majority',
      {
        connectionName: 'wildLifeDb'
      }
    )

  ],
  controllers: [],
  providers: [],
})
export class AppModule {}
  • 'MongooseModule.forFeature()' extension method used to configure Collection(Table) schemas to their database respectively.
  • 'MongooseModule.forFeature()' extension expects 2 optional parameters. First optional parameter is array of type 'ModelDefinition'. Second optional parameter is 'connectionName' this connectionName must match with any one of the connectionName of the database configured in the application.
'ModelDefinition' type looks as below:
export declare type ModelDefinition = {
    name: string;
    schema: any;
    collection?: string;
};
  • 'name' property to specify the identity of 'ModelDefinition' in a collection of schema registration.
  • 'schema' property accepts the Collection(Table) Schema that we have created above.
  • 'Collection' property the value should match with MongoDB Collection name
Create models that represent the Collection(Table) in MongoDB. These models help to query the data against MongoDB using the registered schema. In NestJS these models can be created as 'Class' or 'Interface'
Models/myworld/student.model.ts:(represents 'Student' Collection(Table)):
export interface Student {
  FirstName: String;
  LastName: string;
  Standard: Number;
  FatherName: String;
  MotherName: String;
}
Models/wildlife/animal.model.ts:(represents 'Animals' Collection(Table)):
export interface Animal{
    Name:String
}

Create Service To Query MongoDB:

Services are injectable classes that are used to write logic to communicate with the databases.
services/test.service.ts:
import {Injectable} from '@nestjs/common';
import { InjectModel } from '@nestjs/mongoose';
import {Model} from 'mongoose';
import {Student} from '../Models/myworld/student.model';
import {Animal} from '../Models/wildlife/animal.model';

@Injectable()
export class TestService{
    constructor(
        @InjectModel('Student') private readonly studentModel:Model<Student>,
        @InjectModel('Animals') private readonly animalModel:Model<Animal>){

        }

    async getStudent(){
        return await this.studentModel.find();
    }
    
    async getAnimals(){
        return await this.animalModel.find();
    }
}
  • '@Injectable()' decorator makes class works with dependency injection. These classes can be accessed from the constructor. '@Injectable' imported from '@nestjs/common'.
  • '@InjectModel(Your_Schema_Registered_name)' this helps to inject the schema and helps in the query the MongoDB. '@InjectModel()' is imported from '@nestjs/mongoose'.
  • 'Model' from 'mongoose' helps to convert the schema to classes or interface.
  • 'find()' method used to query the MongoDB and you can pass some input value to fetch data conditionally. If no input parameter supplied to 'find()' method that means to fetch all data from the Collection(Table).
Now register the service in the app.module.ts file.
app.module.ts:
import {TestService} from './services/test.service';
// hidden code for display purpose
@Module({
  providers: [TestService],
})
export class AppModule {}  

Test Results:

Now add a Test Controller as follows.
test/test.controller.cs:
import { Controller,Get } from '@nestjs/common';
import { TestService } from '../services/test.service';

@Controller('test')
export class TestController{


    constructor(private testService:TestService){}

    @Get('get')
    async get(){
       return {
           Students: await this.testService.getStudent(),
           Animals: await this.testService.getAnimals()
       }
    }
}
Now register the TestController in the app.module.ts as below.
app.module.ts:
import {TestController} from './test/test.controller';
// code hidden for display purpose
@Module({
  imports: [
  controllers: [TestController],
})
export class AppModule {}
Now run the application and call the test controller endpoint.

Wrapping Up:

Hopefully, this article will help to understand the accessing multiple MongoDB databases with NestJS application. I love to have your feedback, suggestions and better techniques in the comment section.

Follow Me:

Comments

  1. Great job there,

    What if I need to pass a dynamic dB Name to the connection.

    Such as

    I'll get the dBName from another dB and pass to this, from inside the controller.

    MongooseModule.forRoot(
    'mongodb+srv://:@cluster0-igk.mongodb.net/?retryWrites=true&w=majority',
    {
    connectionName: 'wildLifeDb'
    }
    )

    ReplyDelete

Post a Comment

Popular posts from this blog

Blazor WebAssembly Custom Authentication From Scratch

In this article, we are going to explore and implement custom authentication from the scratch. In this sample, we will use JWT authentication for user authentication. Main Building Blocks Of Blazor WebAssembly Authentication: The core concepts of blazor webassembly authentication are: AuthenticationStateProvider Service AuthorizeView Component Task<AuthenticationState> Cascading Property CascadingAuthenticationState Component AuthorizeRouteView Component AuthenticationStateProvider Service - this provider holds the authentication information about the login user. The 'GetAuthenticationStateAsync()' method in the Authentication state provider returns user AuthenticationState. The 'NotifyAuthenticationStateChaged()' to notify the latest user information within the components which using this AuthenticationStateProvider. AuthorizeView Component - displays different content depending on the user authorization state. This component uses the AuthenticationStateProvider

How Response Caching Works In Asp.Net Core

What Is Response Caching?: Response Caching means storing of response output and using stored response until it's under it's the expiration time. Response Caching approach cuts down some requests to the server and also reduces some workload on the server. Response Caching Headers: Response Caching carried out by the few Http based headers information between client and server. Main Response Caching Headers are like below Cache-Control Pragma Vary Cache-Control Header: Cache-Control header is the main header type for the response caching. Cache-Control will be decorated with the following directives. public - this directive indicates any cache may store the response. private - this directive allows to store response with respect to a single user and can't be stored with shared cache stores. max-age - this directive represents a time to hold a response in the cache. no-cache - this directive represents no storing of response and always fetch the fr

.Net5 Web API Managing Files Using Azure Blob Storage

In this article, we are going to understand the different file operations like uploading, reading, downloading, and deleting in .Net5 Web API application using Azure Blob Storage. Azure Blob Storage: Azure blob storage is Microsoft cloud storage. Blob storage can store a massive amount of file data as unstructured data. The unstructured data means not belong to any specific type, which means text or binary data. So something like images or pdf or videos to store in the cloud, then the most recommended is to use the blob store. The key component to creating azure blob storage resource: Storage Account:- A Storage account gives a unique namespace in Azure for all the data we will save. Every object that we store in Azure Storage has an address. The address is nothing but the unique name of our Storage Account name. The combination of the account name and the Azure Storage blob endpoint forms the base address for each object in our Storage account. For example, if our Storage Account is n

.Net5 Web API Redis Cache Using StackExchange.Redis.Extensions.AspNetCore Library

In this article, we are going to explore the integration of Redis cache in .Net5 Web API application using the 'StackExchange.Redis.Exntensions' library. Note:- Microsoft has introduced an 'IDistributedCache' interface in dotnet core which supports different cache stores like In-Memory, Redis, NCache, etc. It is simple and easy to work with  'IDistributedCache', for the Redis store with limited features but if we want more features of the Redis store we can choose to use 'StackExchange.Redis.Extensions'.  Click here for Redis Cache Integration Using IDistributedCache Interface . Overview On StackExchange.Redis.Extnesions Library: The 'StackExchange.Redis.Extension' library extended from the main library 'StackExchange.Redis'. Some of the key features of this library like: Default serialization and deserialization. Easy to save and fetch complex objects. Search key. Multiple Database Access Setup Redis Docker Instance: For this sampl

Endpoint Routing In Asp.Net Core

How Routing Works In  Core 2.1 And Below Versions?: In Asp.Net Core routing is configured using app.UseRouter() or app.UseMvc() middleware. app.UseMvc(routes => { routes.MapRoute( name: "default", template: "{controller=Home}/{action=Index}/{id?}"); }); Here in Dotnet Core version 2.1 or below versions on the execution of route middleware request will be navigated appropriate controller matched to the route. An operation or functionality which is dependent on route URL or route values and that need to be implemented before the execution of route middleware can be done by accessing the route path from the current request context as below app.Use(async (context, next) => { if(context.Request.Path.Value.IndexOf("oldvehicle") != -1) { context.Response.Redirect("vehicle"); } else { await next(); } }); app.UseMvc(routes => { routes.MapRoute( name: "vehicleRoute", template: "vehicle", defaul

Asp.Net Core MVC Form Validation Techniques

Introduction: Form validations in any applications are like assures that a valid data is storing on servers. All programing frameworks have their own individual implementations for form validations. In Dotnet Core MVC application server-side validations carried on by the models with the help of Data Annotations and the client-side validations carried by the plugin jQuery Unobtrusive Validation. jQuery Unobtrusive Validation is a custom library developed by Microsoft based on the popular library  jQuery Validate . In this article, we are going to learn how the model validation and client-side validation works in Asp.Net Core MVC Application with sample examples. Getting Started: Let's create an Asp.Net Core MVC application project using preferred editors like Microsoft Visual Studio or Microsoft Visual Studio Code. Here I'm using Visual Studio. Let's create an MVC controller and name it as 'PersonController.cs' and add an action method as bel

NestJS File Upload

In this article, we are going to understand the steps to create a file uploading endpoint in the NestJS application. Key Features In NestJS File Upload: Let us know some key features of NestJS file upload before implementing a sample application. FileInterceptor: The 'FileInterceptor' will be decorated on top of the file upload endpoint. This interceptor will read single file data from the form posted to the endpoint. export declare function FilesInterceptor(fieldName: string, localOptions?: MulterOptions): Type<NestInterceptor>; Here we can observe the 'fieldName' first input parameter this value should be a match with our 'name' attribute value on the form file input field. So our interceptor read our files that are attached to the file input field. Another input parameter of 'MulterOptions' that provides configuration like file destination path, customizing file name, etc. FilesInterceptor: The 'FilesInterceptor' will be decorated on t

.NET Core MVC Application File Upload To Physical Location With Buffered Technique

Buffering Technique In File Upload: The server will use its Memory(RAM) or Disk Storage to save the files on receiving a file upload request from the client.  Usage of Memory(RAM) or Disk depends on the number of file requests and the size of the file.  Any single buffered file exceeding 64KB is moved from Memory to a temp file on disk.  If an application receives heavy traffic of uploading files there might be a chance of out of Disk or RAM memory which leads to crash application. So this Buffer technique used for small files uploading. In the following article, we create a sample for the file uploading using .NET Core MVC application. Create The .NET Core MVC Project: Let's create a .NET Core MVC project, here for this sample I'm using Visual Studio Code as below.   Check the link to use the Visual Studio Code for .NET Core Application . IFormFile: Microsoft.AspNetCore.Http.IFormFile used for file upload with buffered technique. On uploading files f

Ionic Picker Sample Code In Angular

Introduction: Ionic Picker(ion-picker) is a popup slides up from the bottom of the device screen, which contains rows with selectable column separated items. The main building block of ion-picker as follows: PickerController PickerOptions PickerController: PickerController object helps in creating an ion-picker overlay. create(opts?: Opts): Promise<Overlay> PickerController create method helps in create the picker overlay with the picker options PickerOptions: PickerOptions is a configuration object used by PickerController to display ion-picker. Single Column Ionic Picker: single.item.picker.ts: import { Component } from "@angular/core"; import { PickerController } from "@ionic/angular"; import { PickerOptions } from "@ionic/core"; @Component({ selector: "single-column-picker", templateUrl:"single.item.picker.html" }) export class SingleItemPicker { animals: string[] = ["Tiger&quo

.Net Core HttpClient JSON Extension Methods Using System.Net.Http.Json Package

.Net Core 3.0 onwards Microsoft brought up a new package called System.Net.Http.Json. This new package provides JSON extension methods for HttpClient. These JSON extension methods will have a prebuild mechanism for serializing or deserializing response data or payload of HttpClient call. System.Net.Http.Json extension methods that are provided to HttpClient, few of them are mentioned below. GetFromJsonAsync PostAsJsonAsync PutAsJsonAsync ReadFromJsonAsync In this article, we understand System.Net.Http.Json package by implementing the HttpClient samples by with and without JSON extension methods and compare them. Create A .Net Core Web API Sample Application: Let's create a .Net Core sample Web API application, from this application we will consume another Web API by implementing HttpClient calls. We can create a Web API sample application using IDE like Visual Studio 2019(Supports .Net Core 3.0 plus) or  Visual Studio Code . Create A Typed Client: In .Net Core using the Http