Add CollectionName attribute for allowing explicit naming of collections

2018-02-05 14:48:26 +01:00
parent c50e4d086e
commit c117bf2a7f
5 changed files with 46 additions and 18 deletions
@@ -0,0 +1,63 @@
+using MongoDB.Driver;
+using MongoDbGenericRepository.Models;
+using System;
+
+namespace MongoDbGenericRepository
+{
+    /// <summary>
+    /// This is the interface of the IMongoDbContext which is managed by the <see cref="BaseMongoRepository"/>.
+    /// </summary>
+    public interface IMongoDbContext
+    {
+        /// <summary>
+        /// The IMongoClient from the official MongoDb driver
+        /// </summary>
+        IMongoClient Client { get; }
+
+        /// <summary>
+        /// The IMongoDatabase from the official Mongodb driver
+        /// </summary>
+        IMongoDatabase Database { get; }
+
+        /// <summary>
+        /// The private GetCollection method
+        /// </summary>
+        /// <typeparam name="TDocument"></typeparam>
+        IMongoCollection<TDocument> GetCollection<TDocument>();
+
+        /// <summary>
+        /// Returns a collection for a document type that has a partition key.
+        /// </summary>
+        /// <typeparam name="TDocument"></typeparam>
+        /// <param name="partitionKey">The value of the partition key.</param>
+        IMongoCollection<TDocument> GetCollection<TDocument>(string partitionKey) where TDocument : IDocument;
+
+        /// <summary>
+        /// Returns a collection for a document type that has a partition key.
+        /// </summary>
+        /// <typeparam name="TDocument">The type representing a Document.</typeparam>
+        /// <typeparam name="TKey">The type of the primary key for a Document.</typeparam>
+        /// <param name="partitionKey">The value of the partition key.</param>
+        IMongoCollection<TDocument> GetCollection<TDocument, TKey>(string partitionKey)
+            where TDocument : IDocument<TKey>
+            where TKey : IEquatable<TKey>;
+
+        /// <summary>
+        /// Drops a collection, use very carefully.
+        /// </summary>
+        /// <typeparam name="TDocument"></typeparam>
+        void DropCollection<TDocument>();
+
+        /// <summary>
+        /// Drops a collection having a partitionkey, use very carefully.
+        /// </summary>
+        /// <typeparam name="TDocument"></typeparam>
+        void DropCollection<TDocument>(string partitionKey);
+
+        /// <summary>
+        /// Sets the Guid representation of the MongoDb Driver.
+        /// </summary>
+        /// <param name="guidRepresentation">The new value of the GuidRepresentation</param>
+        void SetGuidRepresentation(MongoDB.Bson.GuidRepresentation guidRepresentation);
+    }
+}