Interface IMongoDbService

Namespace

Tharga.MongoDB

Assembly

Tharga.MongoDB.dll

public interface IMongoDbService

Methods

AssureFirewallAccessAsync(bool)

ValueTask<string> AssureFirewallAccessAsync(bool force = false)

Parameters

force bool

Returns

ValueTask<string>

CreateCollectionAsync<T>(string)

Task<IMongoCollection<T>> CreateCollectionAsync<T>(string name)

Parameters

name string

Returns

Task<IMongoCollection<T>>

Type Parameters

T

CreateCollectionStrategy()

CreateStrategy CreateCollectionStrategy()

Returns

CreateStrategy

DoesCollectionExist(string)

Task<bool> DoesCollectionExist(string name)

Parameters

name string

Returns

Task<bool>

DropCollectionAsync(string)

Task DropCollectionAsync(string name)

Parameters

name string

Returns

Task

DropDatabase(string)

void DropDatabase(string name)

Parameters

name string

GetAssureIndexMode()

AssureIndexMode GetAssureIndexMode()

Returns

AssureIndexMode

GetAutoClean()

bool GetAutoClean()

Returns

bool

GetCleanOnStartup()

bool GetCleanOnStartup()

Returns

bool

GetCollectionAsync(string, string)

Returns the raw MongoDB.Driver.IMongoCollection<TDocument> for an arbitrary database name. Used by document-inspection paths that operate on per-tenant databases (DatabasePart) without rebuilding the whole IMongoDbService instance per database.

Task<IMongoCollection<BsonDocument>> GetCollectionAsync(string databaseName, string collectionName)

Parameters

databaseName string

collectionName string

Returns

Task<IMongoCollection<BsonDocument>>

GetCollectionAsync<T>(string)

Task<IMongoCollection<T>> GetCollectionAsync<T>(string name)

Parameters

name string

Returns

Task<IMongoCollection<T>>

Type Parameters

T

GetCollections()

IEnumerable<string> GetCollections()

Returns

IEnumerable<string>

GetCollectionsWithMetaAsync(string, string, bool)

IAsyncEnumerable<CollectionMeta> GetCollectionsWithMetaAsync(string databaseName = null, string collectionNameFilter = null, bool includeDetails = true)

Parameters

databaseName string

collectionNameFilter string

includeDetails bool

Returns

IAsyncEnumerable<CollectionMeta>

GetConfigurationName()

string GetConfigurationName()

Returns

string

GetDatabaseAddress()

string GetDatabaseAddress()

Returns

string

GetDatabaseHostName()

string GetDatabaseHostName()

Returns

string

GetDatabaseName()

string GetDatabaseName()

Returns

string

GetDatabases()

IEnumerable<string> GetDatabases()

Returns

IEnumerable<string>

GetFetchSize()

int? GetFetchSize()

Returns

int?

GetInfoAsync(bool)

Task<DatabaseInfo> GetInfoAsync(bool assureFirewall = true)

Parameters

assureFirewall bool

Returns

Task<DatabaseInfo>

GetMaxConnectionPoolSize()

int GetMaxConnectionPoolSize()

Returns

int

GetServerKey()

string GetServerKey()

Returns

string

GetSize(string, IMongoDatabase)

long GetSize(string collectionName, IMongoDatabase mongoDatabase = null)

Parameters

collectionName string

mongoDatabase IMongoDatabase

Returns

long

ReadAllCleanInfoAsync(string)

Task<Dictionary<string, CleanInfo>> ReadAllCleanInfoAsync(string databaseName)

Parameters

databaseName string

Returns

Task<Dictionary<string, CleanInfo>>

ReadCleanInfoAsync(string, string)

Task<CleanInfo> ReadCleanInfoAsync(string databaseName, string collectionName)

Parameters

databaseName string

collectionName string

Returns

Task<CleanInfo>

StartSessionAsync(ClientSessionOptions, CancellationToken)

Start a client session on the underlying MongoDB cluster. Used as the foundation for MongoDbServiceFactoryTransactionExtensions.WithTransactionAsync.

Task<IClientSessionHandle> StartSessionAsync(ClientSessionOptions options = null, CancellationToken cancellationToken = default)

Parameters

options ClientSessionOptions

cancellationToken CancellationToken

Returns

Task<IClientSessionHandle>