17.35. Class MongoCollectionProvider<TData, TModelMapping>
Namespace: ArmoniK.Core.Adapters.MongoDB.Common
Assembly: ArmoniK.Core.Adapters.MongoDB.dll
[PublicAPI]
public class MongoCollectionProvider<TData, TModelMapping> : IInitializable, IHealthCheckProvider, IAsyncInitialization<IMongoCollection<TData>> where TModelMapping : IMongoDataModelMapping<TData>, new()
17.35.1. Type Parameters
TData
TModelMapping
17.35.2. Inheritance
17.35.3. Implements
IInitializable, IHealthCheckProvider, IAsyncInitialization<IMongoCollection<TData>>
17.35.4. Inherited Members
object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()
17.35.5. Constructors
17.35.5.1. MongoCollectionProvider(MongoDB, SessionProvider, IMongoDatabase, ILogger<IMongoCollection<TData>>, CancellationToken)
public MongoCollectionProvider(MongoDB options, SessionProvider sessionProvider, IMongoDatabase mongoDatabase, ILogger<IMongoCollection<TData>> logger, CancellationToken cancellationToken = default)
17.35.5.1.1. Parameters
options MongoDB
sessionProvider SessionProvider
mongoDatabase IMongoDatabase
logger ILogger<IMongoCollection<TData>>
cancellationToken CancellationToken
17.35.6. Properties
17.35.6.1. Initialization
The result of the asynchronous initialization of this instance.
public Task<IMongoCollection<TData>> Initialization { get; }
17.35.6.1.1. Property Value
Task<IMongoCollection<TData>>
17.35.7. Methods
17.35.7.1. Check(HealthCheckTag)
Checks the status of a class for the given health check type.
public Task<HealthCheckResult> Check(HealthCheckTag tag)
17.35.7.1.1. Parameters
tag HealthCheckTag
Health check for which the class has to answer.
17.35.7.1.2. Returns
The result of the check containing the status of the class for the health check type.
17.35.7.2. Get()
public IMongoCollection<TData> Get()
17.35.7.2.1. Returns
IMongoCollection<TData>
17.35.7.3. Init(CancellationToken)
Executes an initialization process for the class
public Task Init(CancellationToken cancellationToken)
17.35.7.3.1. Parameters
cancellationToken CancellationToken
Token used to cancel the execution of the method
17.35.7.3.2. Returns
Task representing the asynchronous execution of the method