Skip to main content

Dotnet Core Basic CRUD Operations With MongoDB Using Repository Pattern


Introduction:
MongoDB is a document-oriented database, which is classified as a NoSQL database. In MongoDB, tables are called collections and records are called documents. It stores data in JSON format. The reading of data from MongoDB is fast when compared to the Relational Database. But MongoDB doesn't have a relation between the collections. We can't declare NoSQL is better than SQL or vice-versa. So depending on the application requirement either select NoSQL or SQL or Both database.

Dotnet Core by default uses an MSSQL database, but it has built-in support for all other types of datastores like MYSQL, ORACLE, and MongoDB, etc.

Step 1:
Click here to install the MongoDB community edition. After successful installation go to "C:\Program Files\MongoDB\Server\4.2\bin" and then run "mongod.exe". Now we started MongoDB server in our local machine on a default port 27017.

Step 2:
Now open MongoDB shell command "mongo.exe" which is found in "C:\Program Files\MongoDB\Server\4.2\bin", where we can execute database queries.

Step 3:
Now create a database name as "MyWorldDatabase" using the following command "use MyWorldDatabase" in mongo.exe command. If the database already exists it will use existing or else creates a new database with that name on adding a document in a collection for the first time.

Step 4:
Create a collection name as "LivingCreatures", using the command "db.createCollection('LivingCreatures')"

Step 5:
In MongoDB records or data called as documents. So Adding document to MongoDB can be done with commands "db.collectionName.insertOne()" for one document insertion and "db.collectionName.insertMany()" for mutiple document insertion. Add the following test documents into "LivingCreatures" collection
 [
    {
      "CreatureName": "Human Being",
      "Home": "Land",
      "Category": "Omnivores",
      "Description": "Eats both plants and flesh of other animals"
    },
    {
      "CreatureName": "Lion",
      "Home": "Land",
      "Category": "Carnivores",
      "Description": "Eats flesh of other animals"
    },
    {
      "CreatureName": "Tiger",
      "Home": "Land",
      "Category": "Carnivores",
      "Description": "Eats flesh of other animals"
    },
    {
      "CreatureName": "Bear",
      "Home": "Land",
      "Category": "Omnivores",
      "Description": "Eats both plants and flesh of other animals"
    },
    {
      "CreatureName": "Goat",
      "Home": "Land",
      "Category": "Herbivores",
      "Description": "Eats plants"
    }
  ]


now to see all the documents use the command "db.LivingCreatures.find({}).pretty()", here pretty() extention function to display output in good format.


Step 6:
Create a Dotnet Core Web API project, click here. "Install-Package MongoDB.Driver.Core -Version 2.9.1" this NuGet provides all helper methods to access MongoDB.

Step 7:
Now add "Models" folder in web API project. Add class and name as "LivingCreature" which represents our collection in the database
  namespace MongoDBSample1.Model
{
    public class LivingCreature
    {
        [BsonId]
        [BsonRepresentation(BsonType.ObjectId)]
        public string Id { get; set; }
        public string CreatureName { get; set; }
        public string Home { get; set; }
        public string Description { get; set; }
      public string Category { get; set; }
    }
}

. "BsonId" attribute represents the primary key in the document.
. "BsonRepresentation(BsonType.ObjectId)" attribute to assign as a string instead of an object from document primary key which is auto-generated in MongoDB.

Step 8:
Update the "appsettings.json" with the following configurations

. "ConnectionString" contains MongoDB connection string
. "DatabaseName" name of the databse
. "LivingCreatureCollection" name of the collection

Step 9:
In "Models" add a class name as "AppSetting.cs" which contains all configuration properties
  namespace MongoDBSample1.Model
{
    public class AppSettings
    {
        public string LivingCreatureCollection { get; set; }
        public string ConnectionString { get; set; }
        public string DatabaseName { get; set; }
    }
}

Step 10:
Now configure "AppSetting.cs" in application "startup.cs" file. In "startup.cs" file, go to "ConfigureServices" method add the following line of code
  services.Configure(Configuration.GetSection(nameof(AppSettings)));
Now "AppSetting.cs" can be accessed with "Microsoft.Extensions.Options.IOptions<T>" in any class by dependency injction.

Step 11:
Add a new folder name as "Data". In the "Data" folder add a class name as "MyWorldContext" which holds MongoDB client that interacts with a database.

IMyWorldContext.cs:

 namespace MongoDBSample1.Data
{
    public interface IMyWorldContext
    {
        IMongoDatabase MyWorldDb { get; }
    }
} 

MyWorldContext.cs:
  namespace MongoDBSample1.Data
{
    public class MyWorldContext: IMyWorldContext
    {
        public   IMongoDatabase MyWorldDb { get; set; }

        public MyWorldContext(IOptions<appsettings> options)
        {
            var mongoClient = new MongoClient(options.Value.ConnectionString);
            MyWorldDb = mongoClient.GetDatabase(options.Value.DatabaseName);
        }
    }
}

."MongoDB.Driver.MongoClient" creates an instance to communicate with MongoDB server.
. "mongoClient.GetDatabase("Name_Of_The_Database")" provides access to the required database

Now MyWorldContext needs to be registered for dependency injection in the "ConfigureServices()" method in "startup.cs" file.
  services.AddSingleton<IMyWorldContext, MyWorldContext>();

." AddSingleton()" means objects get created on application start and lives until the application stop, like one-time creation. MongoClient to be initialized one time, so context class registered for singleton scope.

Step 12:
Create a folder name as "Repos" and add a file name as "LivingCreatureRepository.cs" which do all CRUD operations on "LivingCreatures" collection

ILivingCreatureRepository.cs:
  namespace MongoDBSample1.Repos
{
    public interface ILivingCreatureRepository
    {
        Task<IList<LivingCreature>> GetAll();
    }
}

LivingCreatureRepository.cs:
  namespace MongoDBSample1.Repos
{
    public class LivingCreatureRepository:ILivingCreatureRepository
    {
        private readonly IMongoCollection<LivingCreature> _livingCreatreCollction;
        public LivingCreatureRepository(IOptions<AppSettings> options, IMyWorldContext myWorldContext)
        {
            _livingCreatreCollction = myWorldContext.MyWorldDb.GetCollection<LivingCreature>(options.Value.LivingCreatureCollection);
        }

        public async Task<IList<LivingCreature>> GetAll()
        {
            return await _livingCreatreCollction.Find(_ => true).ToListAsync();
        }
    }
}

. "IMongoCollection" holds "LivingCreatures" collection
. "_livingCreatureCollection.find()" gets the documents matches, to get all document give "true" in find() method which returns all documents from the "LivingCreatures" collection.

Now to inject this "LivingCreaturesRepositry" register in "startup.cs" file. Add the following line "configureService()" method
  services.AddScoped<ILivingCreatureRepository, LivingCreatureRepository>();

. "AddScoped()" repository instance gets created per request.

Step 13:
Create a controller name as "LivingCreatureController.cs", add action method to get all the "LivingCreatures".
 namespace MongoDBSample1.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class LivingCreatureController : ControllerBase
    {
        private readonly ILivingCreatureRepository _livingCreatureRepository;

        public LivingCreatureController(ILivingCreatureRepository livingCreatureRepository)
        {
            _livingCreatureRepository = livingCreatureRepository;
        }

        [HttpGet]
        [Route("all")]
        public async Task<IActionResult> GetAll()
        {
            return Ok(await _livingCreatureRepository.GetAll());
        }
    }
}

now run the web API and navigate to "https://localhost:44358/api/LivingCreature/all"

Step 14:
Now we need to add logic to create a new document to "LivingCreatures" collection. Update the
"LivingCreatureRepository.cs" with the following method.

ILivingCreatureRepository.cs:
 Task AddCreature(LivingCreature creature);

LivingCreatureRepository.cs:
   public async Task AddCreature(LivingCreature creature)
        {
            await  _livingCreatreCollction.InsertOneAsync(creature);
        }

. "_livingCreaterCollection.InsertOneAsync()" adds new document to collection

Now add action method to the controller  as below
     [HttpPost]
        [Route("add")]
        public async Task Create(LivingCreature creature)
        {
            await _livingCreatureRepository.AddCreature(creature);
            return Ok();
        }

To test this endpoint browser directly don't support the "POST" action, use google postman or fiddler to test the post endpoint as below

To check the newly added document, once again navigate to get endpoint above.

Step 15:
Update a document in the collection by using dotnet helper methods like "MongoDB.Driver.ReplaceOneAsync(_filter_expresion,_document_tobeUpdated)", based on filter expression, matching record get update.

Add below code to repository

ILivingCreatureRepository.cs:
  Task Update(LivingCreature creature);
LivingCreatureRepository.cs:
   public async Task Update(LivingCreature creature)
        {
            await _livingCreatreCollction.ReplaceOneAsync(_ => _.Id == creature.Id, creature);
        }

Add update action method in controller as below
  [HttpPost]
        [Route("update")]
        public async Task Update(LivingCreature creature)
        {
            await _livingCreatureRepository.Update(creature);
            return Ok();
        }

Test it using postman as below

Step 16:
Delete a document in the collection by using dotnet helper methods like "MongoDB.Driver.DeleteOneAsync(id)", based on id of a document, matching document get deleted.

ILivingCreatureRepository.cs:
  Task Delete(string id);
LivingCreatureRepository.cs:
   public async Task Delete(string id)
        {
            await _livingCreatreCollction.DeleteOneAsync(_ => _.Id == id);
        }
Controller:
  [HttpDelete]
        [Route("delete")]
        public async Task Delete(string id)
        {
            await _livingCreatureRepository.Delete(id);
            return Ok();
        }

Support Me!
Buy Me A Coffee PayPal Me 

Comments

  1. same thing i had done but its not entering into the controller ,it shows 404 error....
    why?????

    ReplyDelete
    Replies
    1. Hi Kavya,
      404 means unable to found your end point(API url)
      cross check your end point

      Delete

Post a Comment

Popular posts from this blog

.NET6 Web API CRUD Operation With Entity Framework Core

In this article, we are going to do a small demo on AspNetCore 6 Web API CRUD operations. What Is Web API: Web API is a framework for building HTTP services that can be accessed from any client like browser, mobile devices, desktop apps. In simple terminology API(Application Programming Interface) means an interface module that contains a programming function that can be requested via HTTP calls to save or fetch the data for their respective clients. Some of the key characteristics of API: Supports HTTP verbs like 'GET', 'POST', 'PUT', 'DELETE', etc. Supports default responses like 'XML' and 'JSON'. Also can define custom responses. Supports self-hosting or individual hosting, so that all different kinds of apps can consume it. Authentication and Authorization are easy to implement. The ideal platform to build REST full services. Create A .NET6 Web API Application: Let's create a .Net6 Web API sample application to accomplish our

A Small Guide On NestJS Queues

NestJS Application Queues helps to deal with application scaling and performance challenges. When To Use Queues?: API request that mostly involves in time taking operations like CPU bound operation, doing them synchronously which will result in thread blocking. So to avoid these issues, it is an appropriate way to make the CPU-bound operation separate background job.  In nestjs one of the best solutions for these kinds of tasks is to implement the Queues. For queueing mechanism in the nestjs application most recommended library is '@nestjs/bull'(Bull is nodejs queue library). The 'Bull' depends on Redis cache for data storage like a job. So in this queueing technique, we will create services like 'Producer' and 'Consumer'. The 'Producer' is used to push our jobs into the Redis stores. The consumer will read those jobs(eg: CPU Bound Operations) and process them. So by using this queues technique user requests processed very fastly because actually

Part-1 Angular JWT Authentication Using HTTP Only Cookie[Angular V13]

In this article, we are going to implement a sample angular application authentication using HTTP only cookie that contains a JWT token. HTTP Only JWT Cookie: In a SPA(Single Page Application) Authentication JWT token either can be stored in browser 'LocalStorage' or in 'Cookie'. Storing JWT token inside of the cookie then the cookie should be HTTP Only. The HTTP-Only cookie nature is that it will be only accessible by the server application. Client apps like javascript-based apps can't access the HTTP-Only cookie. So if we use authentication with HTTP only JWT cookie then we no need to implement custom logic like adding authorization header or storing token data, etc at our client application. Because once the user authenticated cookie will be automatically sent to the server by the browser on every API call. Authentication API: To implement JWT cookie authentication we need to set up an API. For that, I had created a mock authentication API(Using the NestJS Se

Usage Of CancellationToken In Asp.Net Core Applications

When To Use CancellationToken?: In a web application request abortion or orphan, requests are quite common. On users disconnected by network interruption or navigating between multiple pages before proper response or closing of the browser, tabs make the request aborted or orphan. An orphan request can't deliver a response to the client, but it will execute all steps(like database calls, HTTP calls, etc) at the server. Complete execution of an orphan request at the server might not be a problem generally if at all requests need to work on time taking a job at the server in those cases might be nice to terminate the execution immediately. So CancellationToken can be used to terminate a request execution at the server immediately once the request is aborted or orphan. Here we are going to see some sample code snippets about implementing a CancellationToken for Entity FrameworkCore, Dapper ORM, and HttpClient calls in Asp.NetCore MVC application. Note: The sample codes I will show in

Unit Testing Asp.NetCore Web API Using xUnit[.NET6]

In this article, we are going to write test cases to an Asp.NetCore Web API(.NET6) application using the xUnit. xUnit For .NET: The xUnit for .Net is a free, open-source, community-focused unit testing tool for .NET applications. By default .Net also provides a xUnit project template to implement test cases. Unit test cases build upon the 'AAA' formula that means 'Arrange', 'Act' and 'Assert' Arrange - Declaring variables, objects, instantiating mocks, etc. Act - Calling or invoking the method that needs to be tested. Assert - The assert ensures that code behaves as expected means yielding expected output. Create An API And Unit Test Projects: Let's create a .Net6 Web API and xUnit sample applications to accomplish our demo. We can use either Visual Studio 2022 or Visual Studio Code(using .NET CLI commands) to create any.Net6 application. For this demo, I'm using the 'Visual Studio Code'(using the .NET CLI command) editor. Create a fo

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

Angular 14 Reactive Forms Example

In this article, we will explore the Angular(14) reactive forms with an example. Reactive Forms: Angular reactive forms support model-driven techniques to handle the form's input values. The reactive forms state is immutable, any form filed change creates a new state for the form. Reactive forms are built around observable streams, where form inputs and values are provided as streams of input values, which can be accessed synchronously. Some key notations that involve in reactive forms are like: FormControl - each input element in the form is 'FormControl'. The 'FormControl' tracks the value and validation status of form fields. FormGroup - Track the value and validate the state of the group of 'FormControl'. FormBuilder - Angular service which can be used to create the 'FormGroup' or FormControl instance quickly. Form Array - That can hold infinite form control, this helps to create dynamic forms. Create An Angular(14) Application: Let'

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

Different HttpClient Techniques To Consume API Calls In Minimal API[.NET6]

In this article, we are going to implement different HttpClient techniques to consume API calls in minimal API. The different HttpClient techniques that we are going to explore are like: Register HttpClient Object Explicitly In DI(Dependency Injection Service) Named Client Type Client HttpRequestMessage Object Create A .NET6 Minimal API Project: Let's create a .Net6 Minimal API sample project to accomplish our demo. We can use either Visual Studio 2022 or Visual Studio Code(using .NET CLI commands) to create any.Net6 application. For this demo, I'm using the 'Visual Studio Code'(using the .NET CLI command) editor. CLI command For Minimal API Project dotnet new webapi -minimal -o Your_Project_Name Create A Third Party API Response Model: Here I'm going to use a free third-party rest API that is "https://jsonplaceholder.typicode.com/posts". So to receive the response let's create a response model like 'Post.cs'. Program.cs:(Add Post.cs c

.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