IEvangelist.Azure.CosmosRepository 1.0.0

Azure Cosmos DB Repository .NET SDK

This package wraps the NuGet: Microsoft.Azure.Cosmos package, exposing a simple dependency-injection enabled IRepository<T> interface. The repository is responsible for all of the create, read, update, and delete (CRUD) operations on objects where T : Item. The Item type adds a single property which is a globally unique identifier defined as:

[JsonProperty("id")]
public string Id { get; set; } = Guid.NewGuid().ToString();

Getting started

1. Create an Azure Cosmos DB SQL resource.

2. Obtain the resource connection string from the Keys blade, be sure to get a connection string and not the key - these are different. The connection string is a compound key and endpoint URL.

3. Call AddCosmosRepository and provide the apps configuration object:

   public void ConfigureServices(IServiceCollection services)
   {
       services.AddCosmosRepository(Configuration);
   }
   

   The optional setupAction allows consumers to manually configure the RepositoryOptions object:

   public void ConfigureServices(IServiceCollection services)
   {
       services.AddCosmosRepository(Configuration,
           options => 
           {
               options.CosmosConnectionString = "< connection string >";
               options.ContainerId = "data-store";
               options.DatabaseId = "samples";
           });
   }
   

4. Define your object graph, objects must inherit Item, for example:

   using Microsoft.Azure.CosmosRepository;
   
   public class Person : Item
   {
       public string FirstName { get; set; }
       public string LastName { get; set; }
   }
   

5. Ask for an instance of IRepository<TItem>, in this case the TItem is Person:

   using Microsoft.Azure.CosmosRepository;
   
   public class Consumer
   {
       readonly IRepository<Person> _repository;
   
       public Consumer(IRepository<Person> repository) =>
           _respository = repository;
   
       // Use the repo...
   }
   

6. Perform any of the operations on the _repository instance, create Person records, update them, read them, or delete.

7. Enjoy!