azure-cosmos-dotnet-repository

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

azure-cosmos-dotnet-repository

(★ 338)

Wraps the .NET SDK for Azure Cosmos DB abstracting away the complexity, exposing a simple CRUD-based repository pattern

azure-cosmos-dotnet-repository Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![build](https://github.com/IEvangelist/azure-cosmos-dotnet-repository/workflows/build/badge.svg) ![CodeQL](https://github.com/IEvangelist/azure-cosmos-dotnet-repository/workflows/CodeQL/badge.svg) [![NuGet](https://img.shields.io/nuget/v/IEvangelist.Azure.CosmosRepository.svg?style=flat&label=NuGet%20version)](https://www.nuget.org/packages/IEvangelist.Azure.CosmosRepository) ![Nuget](https://img.shields.io/nuget/dt/IEvangelist.Azure.CosmosRepository?color=blue&label=NuGet%20downloads&logo=nuget) [![.NET code metrics](https://github.com/IEvangelist/azure-cosmos-dotnet-repository/actions/workflows/code-metrics.yml/badge.svg)](https://github.com/IEvangelist/azure-cosmos-dotnet-repository/actions/workflows/code-metrics.yml) [![Discord](https://img.shields.io/discord/868239483529723914.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.com/invite/qMXrX4shAv)

[![All Contributors](https://img.shields.io/badge/all_contributors-35-orange.svg?style=flat-square)](https://raw.githubusercontent.com/IEvangelist/azure-cosmos-dotnet-repository/main/)

# Azure Cosmos DB Repository .NET SDK

This package wraps the [NuGet: Microsoft.Azure.Cosmos package](https://www.nuget.org/packages/Microsoft.Azure.Cosmos),
exposing a simple dependency-injection enabled `IRepository<T>` interface.

## Documentation

The core library `IEvangelist.Azure.CosmosRepository` and `IEvangelist.Azure.CosmosEventSourcing` both host there own documentation site. See below:

* [`IEvangelist.Azure.CosmosRepository Documentation`](https://ievangelist.github.io/azure-cosmos-dotnet-repository/1-getting-started/)
* [`IEvangelist.Azure.CosmosEventSourcing Documentation`](https://mumby0168.github.io/cosmos-event-sourcing-docs/)

![Cosmos Repository](https://raw.githubusercontent.com/IEvangelist/azure-cosmos-dotnet-repository/main/CosmosRepository.png)

The repository is responsible for all of the create, read, update, and delete (CRUD) operations on objects `where T : Item`. The `Item` type adds
several properties, one which is a globally unique identifier defined as:

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

Additionally, a type property exists which indicates the subclass name (this is used for filtering implicitly on your behalf):

```csharp
[JsonProperty("type")]
public string Type { get; set; }
```

Finally, a partition key property is used internally to manage partitioning on your behalf. This can optionally be overridden on an item per item basis.

📣 [Azure Cosmos DB - Official Blog](https://devblogs.microsoft.com/cosmosdb/azure-cosmos-db-repository-net-sdk-v-1-0-4)

## Getting started

1. Create an Azure Cosmos DB SQL resource.
1. 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.
1. Call `AddCosmosRepository`:

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

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

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

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

```csharp
   using Microsoft.Azure.CosmosRepository;

public class Person : Item
   {
       public string FirstName { get; set; }
       public string LastName { get; set; }
   }
   ```

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

```csharp
   using Microsoft.Azure.CosmosRepository;

public class Consumer
 {
 readonly IRepository<Person> _repository;

public Consumer(IRepository<Person> repository) =>
 _repository = repository;

// Use the repo...
   }
   ```

1. Perform any of the operations on the `_repository` instance, create `Person` records, update them, read them, or delete.
1. Enjoy!

<!--
Notes for tagging releases:
 https://rehansaeed.com/the-easiest-way-to-version-nuget-packages/#minver

git tag -a 2.1.3 -m "Build v2.1.3"
git push upstream --tags
dotnet build
-->

## Samples

Visit the `Microsoft.Azure.CosmosRepository.Samples` [directory](https://github.com/IEvangelist/azure-cosmos-dotnet-repository/tree/main/samples) for samples on how to use the library with:

- [Azure Functions](https://github.com/IEvangelist/azure-cosmos-dotnet-repository/tree/main/samples/Microsoft.Azure.CosmosRepository/AzureFunctionTier)
- [Services](https://github.com/IEvangelist/azure-cosmos-dotnet-repository/tree/main/samples/Microsoft.Azure.CosmosRepository/ServiceTier)
- [Controllers (web apps)](https://github.com/IEvangelist/azure-cosmos-dotnet-repository/tree/main/samples/Microsoft.Azure.CosmosRepository/WebTier)
- [Paging](https://github.com/IEvangelist/azure-cosmos-dotnet-repository/tree/main/samples/Microsoft.Azure.CosmosRepository/Paging)

## Deep-dive video

[![A deep dive into the Azure Cosmos DB repository pattern NET SDK](https://raw.githubusercontent.com/IEvangelist/azure-cosmos-dotnet-repository/main/images/deep-dive-talk.png)](https://www.youtube.com/watch?v=izdnmBrTweA)

[![Cosmos Repository Crash Course](https://raw.githubusercontent.com/IEvangelist/azure-cosmos-dotnet-repository/main/images/dotnet-docs-show.jpeg)](https://www.youtube.com/watch?v=_rsVwc4n8Ps)

## Discord

Get extra support on our dedicated Discord channel.

[![alt Join the conversation](https://img.shields.io/discord/868239483529723914.svg "Discord")](https://discord.com/invite/qMXrX4shAv)

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<table>
 <tbody>
 <tr>
 <td align="center" valign="top" width="14.28%"><a href="https://www.microsoft.com"><img src="https://avatars0.githubusercontent.com/u/7679720?v=4?s=100" width="100px;" alt="David Pine"/> David Pine</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=IEvangelist" title="Code">💻</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=IEvangelist" title="Tests">⚠️</a> <a href="#example-IEvangelist" title="Examples">💡</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/pulls?q=is%3Apr+reviewed-by%3AIEvangelist" title="Reviewed Pull Requests">👀</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://twitter.com/invvard"><img src="https://avatars0.githubusercontent.com/u/7305493?v=4?s=100" width="100px;" alt="Invvard"/> Invvard</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=Invvard" title="Tests">⚠️</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=Invvard" title="Code">💻</a></td>
 <td align="center" valign="top" width="14.28%"><a href="http://richmercer.com/"><img src="https://avatars3.githubusercontent.com/u/1423493?v=4?s=100" width="100px;" alt="Richard Mercer"/> Richard Mercer</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=RichMercer" title="Code">💻</a></td>
 <td align="center" valign="top" width="14.28%"><a href="http://www.planetgeek.ch"><img src="https://avatars1.githubusercontent.com/u/174258?v=4?s=100" width="100px;" alt="Daniel Marbach"/> Daniel Marbach</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=danielmarbach" title="Code">💻</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://manuel.sidler.io"><img src="https://avatars3.githubusercontent.com/u/802015?v=4?s=100" width="100px;" alt="Manuel Sidler"/> Manuel Sidler</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=manuelsidler" title="Code">💻</a></td>
 <td align="center" valign="top" width="14.28%"><a href="http://daveabrock.com"><img src="https://avatars1.githubusercontent.com/u/275862?v=4?s=100" width="100px;" alt="Dave Brock"/> Dave Brock</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=daveabrock" title="Documentation">📖</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=daveabrock" title="Code">💻</a></td>
 <td align="center" valign="top" width="14.28%"><a href="http://www.develoopers.co.uk"><img src="https://avatars0.githubusercontent.com/u/972726?v=4?s=100" width="100px;" alt="Cagdas Erman Afacan"/> Cagdas Erman Afacan</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=afacanerman" title="Code">💻</a> <a href="#example-afacanerman" title="Examples">💡</a></td>
 </tr>
 <tr>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/dcuccia"><img src="https://avatars.githubusercontent.com/u/479617?v=4?s=100" width="100px;" alt="dcuccia"/> dcuccia</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=dcuccia" title="Code">💻</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/VeryCautious"><img src="https://avatars.githubusercontent.com/u/38176872?v=4?s=100" width="100px;" alt="VeryCautious"/> VeryCautious</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=VeryCautious" title="Code">💻</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=VeryCautious" title="Tests">⚠️</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/mumby0168"><img src="https://avatars.githubusercontent.com/u/23740684?v=4?s=100" width="100px;" alt="Billy Mumby"/> Billy Mumby</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=mumby0168" title="Code">💻</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=mumby0168" title="Documentation">📖</a> <a href="#ideas-mumby0168" title="Ideas, Planning, & Feedback">🤔</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/zhangzunke"><img src="https://avatars.githubusercontent.com/u/16775338?v=4?s=100" width="100px;" alt="Michael Zhang"/> Michael Zhang</a> <a href="#ideas-zhangzunke" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=zhangzunke" title="Code">💻</a></td>
 <td align="center" valign="top" width="14.28%"><a href="http://www.roji.org"><img src="https://avatars.githubusercontent.com/u/1862641?v=4?s=100" width="100px;" alt="Shay Rojansky"/> Shay Rojansky</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/pulls?q=is%3Apr+reviewed-by%3Aroji" title="Reviewed Pull Requests">👀</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://www.linkedin.com/in/junior-wellemen-de-macedo-mba-mcp-ms-49282643/?locale=en_US"><img src="https://avatars.githubusercontent.com/u/12876899?v=4?s=100" width="100px;" alt="Junior Macedo"/> Junior Macedo</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=jrwmacedo" title="Code">💻</a> <a href="#ideas-jrwmacedo" title="Ideas, Planning, & Feedback">🤔</a></td>
 <td align="center" valign="top" width="14.28%"><a href="http://emrekara.me"><img src="https://avatars.githubusercontent.com/u/17519791?v=4?s=100" width="100px;" alt="Emre KARA"/> Emre KARA</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=emrekara37" title="Code">💻</a></td>
 </tr>
 <tr>
 <td align="center" valign="top" width="14.28%"><a href="http://www.bradwestness.com"><img src="https://avatars.githubusercontent.com/u/1802434?v=4?s=100" width="100px;" alt="Brad Westness"/> Brad Westness</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/pulls?q=is%3Apr+reviewed-by%3Abradwestness" title="Reviewed Pull Requests">👀</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/BeigeBadger"><img src="https://avatars.githubusercontent.com/u/8124536?v=4?s=100" width="100px;" alt="Matt Stannett"/> Matt Stannett</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=BeigeBadger" title="Code">💻</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=BeigeBadger" title="Documentation">📖</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=BeigeBadger" title="Tests">⚠️</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/mustafarabie"><img src="https://avatars.githubusercontent.com/u/24240605?v=4?s=100" width="100px;" alt="mustafarabie"/> mustafarabie</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=mustafarabie" title="Code">💻</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=mustafarabie" title="Tests">⚠️</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://www.linkedin.com/in/robertobennett"><img src="https://avatars.githubusercontent.com/u/8798036?v=4?s=100" width="100px;" alt="Robert Bennett"/> Robert Bennett</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=robertbennett1998" title="Tests">⚠️</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=robertbennett1998" title="Code">💻</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/Rabosa616"><img src="https://avatars.githubusercontent.com/u/12774781?v=4?s=100" width="100px;" alt="Rabosa616"/> Rabosa616</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=Rabosa616" title="Code">💻</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=Rabosa616" title="Tests">⚠️</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=Rabosa616" title="Documentation">📖</a></td>
 <td align="center" valign="top" width="14.28%"><a href="http://www.adamstorr.co.uk"><img src="https://avatars.githubusercontent.com/u/374343?v=4?s=100" width="100px;" alt="Adam Storr"/> Adam Storr</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=WestDiscGolf" title="Code">💻</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=WestDiscGolf" title="Tests">⚠️</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://www.linkedin.com/in/krbenton"><img src="https://avatars.githubusercontent.com/u/1820709?v=4?s=100" width="100px;" alt="Kevin Benton"/> Kevin Benton</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=kevin-benton" title="Code">💻</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=kevin-benton" title="Tests">⚠️</a></td>
 </tr>
 <tr>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/filipmhpersson"><img src="https://avatars.githubusercontent.com/u/6987448?v=4?s=100" width="100px;" alt="Filip Persson"/> Filip Persson</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=filipmhpersson" title="Code">💻</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=filipmhpersson" title="Tests">⚠️</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://www.fffffatah.tech"><img src="https://avatars.githubusercontent.com/u/43249848?v=4?s=100" width="100px;" alt="A.F.M. Noorullah"/> A.F.M. Noorullah</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=fffffatah" title="Documentation">📖</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/idormenco"><img src="https://avatars.githubusercontent.com/u/1877190?v=4?s=100" width="100px;" alt="Ion Dormenco"/> Ion Dormenco</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=idormenco" title="Code">💻</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/MO2k4"><img src="https://avatars.githubusercontent.com/u/453360?v=4?s=100" width="100px;" alt="Martin Oehlert"/> Martin Oehlert</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=MO2k4" title="Code">💻</a></td>
 <td align="center" valign="top" width="14.28%"><a href="http://evancjohnson.com"><img src="https://avatars.githubusercontent.com/u/17952965?v=4?s=100" width="100px;" alt="Evan Johnson"/> Evan Johnson</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=evancjohnson" title="Code">💻</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=evancjohnson" title="Tests">⚠️</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/philip-reed"><img src="https://avatars.githubusercontent.com/u/7798175?v=4?s=100" width="100px;" alt="Phil Reed"/> Phil Reed</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=philip-reed" title="Tests">⚠️</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=philip-reed" title="Code">💻</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=philip-reed" title="Documentation">📖</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/dnitsch"><img src="https://avatars.githubusercontent.com/u/6850870?v=4?s=100" width="100px;" alt="dnitsch"/> dnitsch</a> <a href="#ideas-dnitsch" title="Ideas, Planning, & Feedback">🤔</a></td>
 </tr>
 <tr>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/SeanFarrow"><img src="https://avatars.githubusercontent.com/u/1455486?v=4?s=100" width="100px;" alt="Sean Farrow"/> Sean Farrow</a> <a href="#ideas-SeanFarrow" title="Ideas, Planning, & Feedback">🤔</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/stormbringer766"><img src="https://avatars.githubusercontent.com/u/14202723?v=4?s=100" width="100px;" alt="stormbringer766"/> stormbringer766</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=stormbringer766" title="Code">💻</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=stormbringer766" title="Tests">⚠️</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/joelsteventurner"><img src="https://avatars.githubusercontent.com/u/11704606?v=4?s=100" width="100px;" alt="Joel Turner"/> Joel Turner</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=joelsteventurner" title="Code">💻</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/r0ss88"><img src="https://avatars.githubusercontent.com/u/35737434?v=4?s=100" width="100px;" alt="Ross"/> Ross</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/issues?q=author%3Ar0ss88" title="Bug reports">🐛</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/mrfootoyou"><img src="https://avatars.githubusercontent.com/u/4042025?v=4?s=100" width="100px;" alt="John Belcher"/> John Belcher</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=mrfootoyou" title="Documentation">📖</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/victormarante"><img src="https://avatars.githubusercontent.com/u/41802977?v=4?s=100" width="100px;" alt="Victor Marante"/> Victor Marante</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=victormarante" title="Code">💻</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/mateuszkumpf"><img src="https://avatars.githubusercontent.com/u/24723556?v=4?s=100" width="100px;" alt="Mateusz Kumpf"/> Mateusz Kumpf</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=mateuszkumpf" title="Code">💻</a> <a href="https://github.com/IEvangelist/azure-cosmos-dotnet-repository/commits?author=mateuszkumpf" title="Tests">⚠️</a></td>
 </tr>
 </tbody>
</table>

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

azure-cosmos-dotnet-repository

azure-cosmos-dotnet-repository Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

azure-cosmos-dotnet-repository

azure-cosmos-dotnet-repository Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README