Class MongoDbRepositoryBase<TDocument>
Provides a base implementation for interacting with MongoDB for a specific document type.
public abstract class MongoDbRepositoryBase<TDocument> : IMongoDbRepositoryBase<TDocument>, IMongoDbRepositoryBaseQuery<TDocument> where TDocument : class
Type Parameters
TDocumentThe type of the document to manage in MongoDB.
- Inheritance
-
MongoDbRepositoryBase<TDocument>
- Implements
-
IMongoDbRepositoryBase<TDocument>IMongoDbRepositoryBaseQuery<TDocument>
- Inherited Members
Examples
public class OrderSearchRepository : MongoDbRepositoryBase<OrderProjection>
{
public OrderSearchRepository(IMongoClient client, IOptionsMonitor<MongoDbProjectionStoreOptions> options)
: base(client,
options.Get(MongoDbProjectionCollectionConvention.GetOptionsName<OrderProjection>()).DatabaseName,
MongoDbProjectionCollectionConvention.GetCollectionName<OrderProjection>(
options.Get(MongoDbProjectionCollectionConvention.GetOptionsName<OrderProjection>())))
{
}
public override Task InitializeCollectionAsync(CancellationToken ct) => Task.CompletedTask;
}
Remarks
This class includes operations for adding, updating, retrieving, deleting, and querying documents, as well as initializing collections and indexes in MongoDB.
Documents are stored as flat BSON documents. The MongoDB driver's
IgnoreExtraElementsConvention is registered globally so that consumer
document types silently ignore metadata fields during deserialization.
Use this base class to build custom query repositories that share MongoDB collections
with IProjectionStore<T> or other stores.
Constructors
MongoDbRepositoryBase(IMongoClient, string, string)
Initializes a new instance of the MongoDbRepositoryBase<TDocument> class.
protected MongoDbRepositoryBase(IMongoClient client, string databaseName, string collectionName)
Parameters
clientIMongoClientThe MongoDB client instance.
databaseNamestringThe name of the database to operate on.
collectionNamestringThe name of the collection to operate on.
Properties
Client
Gets the underlying MongoDB client.
protected IMongoClient Client { get; }
Property Value
- IMongoClient
Collection
Gets the underlying MongoDB collection typed as MongoDB.Bson.BsonDocument.
protected IMongoCollection<BsonDocument> Collection { get; }
Property Value
- IMongoCollection<BsonDocument>
CollectionName
Gets the name of the collection this repository operates on.
protected string CollectionName { get; }
Property Value
Methods
AddOrUpdateAsync(string, TDocument, CancellationToken)
Adds or updates a document in the MongoDB collection.
public virtual Task<bool> AddOrUpdateAsync(string documentId, TDocument document, CancellationToken cancellationToken)
Parameters
documentIdstringThe unique identifier for the document.
documentTDocumentThe document to be added or updated.
cancellationTokenCancellationTokenThe cancellation token.
Returns
FindAsync(FilterDefinition<BsonDocument>, SortDefinition<BsonDocument>?, int?, int?, CancellationToken)
Executes a find query against the MongoDB collection.
public virtual Task<IReadOnlyList<TDocument>> FindAsync(FilterDefinition<BsonDocument> filter, SortDefinition<BsonDocument>? sort, int? skip, int? limit, CancellationToken cancellationToken)
Parameters
filterFilterDefinition<BsonDocument>The filter definition for the query.
sortSortDefinition<BsonDocument>Optional sort definition.
skipint?Optional number of documents to skip.
limitint?Optional maximum number of documents to return.
cancellationTokenCancellationTokenThe cancellation token.
Returns
- Task<IReadOnlyList<TDocument>>
A read-only list of matched documents.
GetByIdAsync(string, CancellationToken)
Retrieves a document from MongoDB by its ID.
public virtual Task<TDocument?> GetByIdAsync(string documentId, CancellationToken cancellationToken)
Parameters
documentIdstringThe unique identifier of the document.
cancellationTokenCancellationTokenThe cancellation token.
Returns
- Task<TDocument>
The document if found, or
nullif not found.
InitializeCollectionAsync(CancellationToken)
Initializes the MongoDB collection (creates indexes, etc.).
public abstract Task InitializeCollectionAsync(CancellationToken cancellationToken)
Parameters
cancellationTokenCancellationTokenThe cancellation token.
Returns
RemoveAsync(string, CancellationToken)
Removes a document from the MongoDB collection.
public virtual Task<bool> RemoveAsync(string documentId, CancellationToken cancellationToken)
Parameters
documentIdstringThe unique identifier of the document to remove.
cancellationTokenCancellationTokenThe cancellation token.