https://github.com/alexandre-spieser/mongodb-generic-repository
An example of generic repository implementation using the MongoDB C# Sharp 2.0 driver (async)
https://github.com/alexandre-spieser/mongodb-generic-repository
generic mongodb repository
Last synced: 4 days ago
JSON representation
An example of generic repository implementation using the MongoDB C# Sharp 2.0 driver (async)
- Host: GitHub
- URL: https://github.com/alexandre-spieser/mongodb-generic-repository
- Owner: alexandre-spieser
- License: mit
- Created: 2016-02-27T10:51:09.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-05-28T14:42:45.000Z (11 months ago)
- Last Synced: 2024-08-02T18:40:20.635Z (9 months ago)
- Topics: generic, mongodb, repository
- Language: C#
- Homepage:
- Size: 38.2 MB
- Stars: 310
- Watchers: 17
- Forks: 84
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- Awesome-Nuget-Packages - **MongoDbGenericRepository**
README
# MongoDbGenericRepository
An example of generic repository implementation using the MongoDB C# Sharp 2.0 driver (async)
Now available as a nuget package:
https://www.nuget.org/packages/MongoDbGenericRepository/
Covered by 400+ integration tests and counting.
The MongoDbGenericRepository is also used in [AspNetCore.Identity.MongoDbCore](https://github.com/alexandre-spieser/AspNetCore.Identity.MongoDbCore).
# Support This Project
If you have found this project helpful, either as a library that you use or as a learning tool, please consider buying Alex a coffee: 
# Worth Knowing
This package sets the `MongoDefaults.GuidRepresentation` to `MongoDB.Bson.GuidRepresentation.Standard` by default, instead of the default driver setting of `MongoDB.Bson.GuidRepresentation.CSharpLegacy`. This can cause issues if you have been using the driver on an existing application previously or if you are using CosmosDB.
You can override this behaviour to enforce legacy behaviour in your app Startup routine like so :
`MongoDbContext.SetGuidRepresentation(MongoDB.Bson.GuidRepresentation.CSharpLegacy)`. More info [here](https://github.com/alexandre-spieser/mongodb-generic-repository/issues/7).
# Usage examples
This repository is meant to be inherited from.
You are responsible for managing its lifetime, it is advised to setup this repository as a singleton.
Here is an example of repository usage, where the TestRepository is implementing 2 custom methods:
```csharp
public interface ITestRepository : IBaseMongoRepository
{
void DropTestCollection();
void DropTestCollection(string partitionKey);
}
public class TestRepository : BaseMongoRepository, ITestRepository
{
public TestRepository(string connectionString, string databaseName) : base(connectionString, databaseName)
{
}
public void DropTestCollection()
{
MongoDbContext.DropCollection();
}
public void DropTestCollection(string partitionKey)
{
MongoDbContext.DropCollection(partitionKey);
}
}
```
If all your documents have the same type of `Id`, you can use the more specific `BaseMongoRepository` where `TKey` is the type of the `Id` of your documents.
```csharp
public class TestTKeyRepository : BaseMongoRepository, ITestRepository where TKey : IEquatable
{
const string connectionString = "mongodb://localhost:27017/MongoDbTests";
private static readonly ITestRepository _instance = new TestTKeyRepository(connectionString);
///
private TestTKeyRepository(string connectionString) : base(connectionString)
{
}
}
```
## Instantiation
The repository can be instantiated like so:
```csharp
ITestRepository testRepository = new TestRepository(connectionString, "MongoDbTests");
ITestRepository testTKeyRepository = new TestTKeyRepository(connectionString);
```
If you prefer to reuse the same MongoDb database across your application, you can use the `MongoDatabase` from the MongoDb driver implementing the `IMongoDatabase` interface:
```csharp
var client = new MongoClient(connectionString);
var mongoDbDatabase = Client.GetDatabase(databaseName);
ITestRepository testRepository = new TestRepository(mongoDbDatabase);
```
## Adding documents
To add a document, its class must inherit from the `Document` class, implement the `IDocument` or `IDocument` interface:
```csharp
public class MyDocument : Document
{
public MyDocument()
{
Version = 2; // you can bump the version of the document schema if you change it over time
}
public string SomeContent { get; set; }
}
```
The `IDocument` and `IDocument` interfaces can be seen below:
```csharp
///
/// This class represents a basic document that can be stored in MongoDb.
/// Your document must implement this class in order for the MongoDbRepository to handle them.
///
public interface IDocument
{
Guid Id { get; set; }
int Version { get; set; }
}
///
/// This class represents a basic document that can be stored in MongoDb.
/// Your document must implement this class in order for the MongoDbRepository to handle them.
///
public interface IDocument where TKey : IEquatable
{
///
/// The Primary Key, which must be decorated with the [BsonId] attribute
/// if you want the MongoDb C# driver to consider it to be the document ID.
///
[BsonId]
TKey Id { get; set; }
///
/// A version number, to indicate the version of the schema.
///
int Version { get; set; }
}
```
## Partitioned collections
This repository also allows you to partition your document across multiple collections, this can be useful if you are running a SaaS application and want to keep good performance.
To use partitioned collections, you must define your documents using the PartitionedDocument class, which implements the IPartitionedDocument interface:
```csharp
public class MyPartitionedDocument : PartitionedDocument
{
public MyPartitionedDocument(string myPartitionKey) : base(myPartitionKey)
{
Version = 1;
}
public string SomeContent { get; set; }
}
```
This partitioned key will be used as a prefix to your collection name.
The collection name is derived from the name of the type of your document, is set to camel case, and is pluralized using a class taken from Humanizer (https://github.com/Humanizr/Humanizer).
```csharp
var myDoc = new MyPartitionedDocument("myPartitionKey");
_testRepository.AddOne(myDoc);
```
The above code will generate a collection named `myPartitionKey-myPartitionedDocuments`.
## CollectionName Attribute
It is now possible to change the collection name by using the `CollectionName` attribute:
```csharp
[CollectionName("MyCollectionName")]
public class MyDocument : Document
{
public MyDocument()
{
Version = 2;
}
public string SomeContent { get; set; }
}
```
Documents of this type will be inserted into a collection named "MyCollectionName".
## Index Management
From version 1.3.8 the `MongoDbGenericRepository` implements the `IBaseMongoRepository_Index` and `IBaseMongoRepository_Index` interfaces.
This exposes the functionality to programmatically manage indexes against your collections in a generic fashion.
The following methods are exposed and fully integration tested:
+ CreateAscendingIndexAsync
+ CreateDescendingIndexAsync
+ CreateCombinedTextIndexAsync
+ CreateHashedIndexAsync
+ CreateTextIndexAsync
+ DropIndexAsync
+ GetIndexesNamesAsync
Usage examples:
```csharp
string expectedIndexName = $"myCustomIndexName";
var option = new IndexCreationOptions
{
Name = expectedIndexName
};
// Act
// create a text index against the Version property of the document.
var result = await SUT.CreateTextIndexAsync(x => x.Version, option, PartitionKey);
// Assert
var listOfIndexNames = await SUT.GetIndexesNamesAsync(PartitionKey);
Assert.Contains(expectedIndexName, listOfIndexNames);
// Cleanup
await SUT.DropIndexAsync(expectedIndexName, PartitionKey);
```
Please refer to the IntegrationTests (NET45) and CoreIntegrationTests (netstandard2.0) projects for more usage examples.
The `CoreIntegrationTests.Infrastructure.MongoDbTKeyDocumentTestBase` test class is a good start.
## Author
**Alexandre Spieser**
## License
mongodb-generic-repository is under MIT license - http://www.opensource.org/licenses/mit-license.php
The MIT License (MIT)
Copyright (c) 2016-2019 Alexandre Spieser
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
==============================================================================
Inflector (https://github.com/srkirkland/Inflector)
The MIT License (MIT)
Copyright (c) 2013 Scott Kirkland
==============================================================================
Humanizer (https://github.com/Humanizr/Humanizer)
The MIT License (MIT)
Copyright (c) 2012-2014 Mehdi Khalili (http://omar.io)
==============================================================================
## Copyright
Copyright © 2019