Mastering Azure Cosmos DB with ASP.NET Core

Introduction to Azure Cosmos DB

Azure Cosmos DB is a globally distributed, multi-model database service supplied by Microsoft Azure. It’s designed to supply turnkey international distribution throughout any variety of Azure areas by transparently scaling and replicating your information wherever your customers are. Cosmos DB ensures that your information is at all times accessible and lets you elastically and independently scale throughput and storage throughout any variety of Azure areas worldwide.

Key Options of Azure Cosmos DB

1. International Distribution: Distribute your information globally to any Azure area with a couple of clicks.
2. Elastic Scalability: Independently and elastically scale throughput and storage throughout a number of areas.
3. Multi-Mannequin and Multi-API Help: Helps a number of information fashions equivalent to doc, key-value, graph, and column-family information fashions. APIs embrace SQL, MongoDB, Cassandra, Tables, and Gremlin.
4. Assured Low Latency: Gives single-digit millisecond response instances.
5. Complete SLAs: Gives 5 well-defined consistency ranges and 99.999% excessive availability.
6. Computerized Indexing: Robotically indexes all information with out requiring schema and index administration.
7. Safety: Gives superior security measures, together with encryption at relaxation, and compliance with main requirements like GDPR and ISO.

Execs of Azure Cosmos DB

1. International Distribution: Simply replicate information throughout a number of areas, offering excessive availability and catastrophe restoration.
2. Scalability: Effortlessly scale up or down based mostly in your wants with out downtime.
3. A number of Information Fashions: Flexibility to make use of totally different information fashions and APIs based mostly on the appliance necessities.
4. Efficiency: Excessive throughput and low latency, making it appropriate for mission-critical functions.
5. Absolutely Managed: No have to handle infrastructure, permitting builders to concentrate on software growth.
6. Computerized Indexing: Simplifies information administration by robotically indexing all information.
7. Consistency Ranges: Gives a spectrum of consistency ranges from sturdy to eventual, permitting fine-grained management over consistency and efficiency.

Cons of Azure Cosmos DB

1. Price: This may be costly, particularly for large-scale operations or when utilizing international distribution.
2. Complexity: Studying curve related to its varied options and APIs.
3. Vendor Lock-In: Tightly built-in with Azure, making it difficult to change to different suppliers.
4. Restricted Open Supply Help: Much less group help in comparison with open-source options.
5. Provisioning Throughput: Requires cautious planning of throughput models to keep away from over-provisioning and under-provisioning.

Completely different Accessible Fashions

Azure Cosmos DB helps a number of information fashions, permitting builders to decide on the most effective match for his or her functions:

1. Doc Mannequin: Retailer and question JSON paperwork. Very best for functions requiring versatile schema and hierarchical information buildings.

2. Key-Worth Mannequin: Retailer easy key-value pairs. Appropriate for functions requiring quick lookups.

3. Column-Household Mannequin: Retailer information in rows and columns, much like NoSQL databases like Cassandra. Greatest for write-heavy workloads.

4. Graph Mannequin: Retailer and question graph information buildings, making it best for functions involving complicated relationships.

Integration with ASP.NET Core MVC

Integrating Azure Cosmos DB with an ASP.NET Core MVC software includes the next steps:

1. Setting Up Azure Cosmos DB

1. Create an Azure Cosmos DB Account: Go to the Azure portal, create a brand new Azure Cosmos DB account, select the specified API, and arrange the mandatory configurations.
2. Get Connection String: Retrieve the connection string and keys from the Azure portal to be used in your software.

2. Configuring ASP.NET Core MVC Venture

• Set up NuGet Packages: Set up the mandatory NuGet packages for Azure Cosmos DB in your ASP.NET Core MVC venture.

  dotnet add bundle Microsoft.Azure.Cosmos
  

• Add Configuration: Add the Cosmos DB configuration settings to your appsettings.json.

{
    "CosmosDb": {
        "Account": "<your-account-url>",
        "Key": "<your-account-key>",
        "DatabaseName": "YourDatabaseName",
        "ContainerName": "YourContainerName"
    }
}

builder.Companies.AddSingleton<CosmosClient>(serviceProvider =>
{
    var configuration = serviceProvider.GetRequiredService<IConfiguration>();
    var account = configuration["AzureCosmosDb:Account"];
    var key = configuration["AzureCosmosDb:Key"];

    return new CosmosClient(account, key);
});

3. Creating Information Fashions and Repositories

• Outline Information Fashions: Create C# lessons that signify your information fashions.

public report Scholar(
        string id,
        string title,
        string electronic mail,
        Listing<string> hobbies
        );

• Create Repository: Implement a repository sample to work together with Cosmos DB.

public class StudentService
{
    non-public readonly Container _container;
    public StudentService(IConfiguration configuration,CosmosClient cosmosClient)
    {
        var databaseName = configuration["AzureCosmosDb:DatabaseName"];
        var containerName = configuration["AzureCosmosDb:ContainerName"];

        _container = cosmosClient.GetContainer(databaseName, containerName);
    }
    public async Process Insert(Scholar mannequin)
    {
        await _container.CreateItemAsync(mannequin);
    }
    public async Process<IEnumerable<Scholar>> GetAll()
    {
        var respones = _container.GetItemLinqQueryable<Scholar>(true);
        return respones.AsEnumerable();
    }
    public async Process<Scholar> Get(string id)
    {
        return await _container.ReadItemAsync<Scholar>(id,PartitionKey.None);
    }
    public async Process Delete(string id)
    {
        await _container.DeleteItemAsync<Scholar>(id,PartitionKey.None);
    }
}

4. Utilizing the Repository in Controllers

• Inject Repository: Inject the repository into your controllers and use it to carry out CRUD operations.

[Route("api/[controller]")]
[ApiController]
public class StudentsController(StudentService studentService) : ControllerBase
{
    [HttpGet("GetAll")]
    public async Process<IActionResult> GetAll()
    {
        var response = await studentService.GetAll();
        return Okay(response);
    }
    [HttpGet("Get")]
    public async Process<IActionResult> Get(string id)
    {
        var response = await studentService.Get(id);
        return Okay(response);
    }
    [HttpPut("Insert")]
    public async Process<IActionResult> Insert(Scholar request)
    {
        await studentService.Insert(request);
        return Okay("Scholar created efficiently");
    }
    [HttpDelete("Delete")]
    public async Process<IActionResult> Delete(string id)
    {
        await studentService.Delete(id);
        return Okay("Scholar delete efficiently");
    }
}

By following these steps, you’ll be able to combine Azure Cosmos DB along with your ASP.NET Core MVC software, enabling you to leverage the highly effective capabilities of Cosmos DB in your net functions.

Conclusion

Azure Cosmos DB is a strong and versatile database service that gives international distribution, excessive availability, and multi-model help. Whereas it comes with some complexity and price issues, its advantages for large-scale, globally distributed functions are vital. Integrating it with an ASP.NET Core MVC software is simple, permitting builders to construct scalable and responsive functions with ease.

Supply Code

You possibly can entry the code from my AzureEssentialSeries Github Repo. Please give it a begin for those who prefer it.

Video Tutorial

You possibly can watch the Azure Necessities present Episode 2 on CSharpTV for this subject.