Class MongoClient

Namespace

MongoDB.Driver

Assembly

MongoDB.Driver.dll

Base class for implementors of IMongoClient.

public class MongoClient : MongoClientBase, IMongoClient

Inheritance

object

MongoClientBase

MongoClient

Implements

IMongoClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

IMongoClientExtensions.Watch(IMongoClient, ChangeStreamOptions, CancellationToken)

IMongoClientExtensions.Watch(IMongoClient, IClientSessionHandle, ChangeStreamOptions, CancellationToken)

IMongoClientExtensions.WatchAsync(IMongoClient, ChangeStreamOptions, CancellationToken)

IMongoClientExtensions.WatchAsync(IMongoClient, IClientSessionHandle, ChangeStreamOptions, CancellationToken)

Constructors

MongoClient()

Initializes a new instance of the MongoClient class.

public MongoClient()

MongoClient(MongoClientSettings)

Initializes a new instance of the MongoClient class.

public MongoClient(MongoClientSettings settings)

Parameters

settings MongoClientSettings

The settings.

MongoClient(MongoUrl)

Initializes a new instance of the MongoClient class.

public MongoClient(MongoUrl url)

Parameters

url MongoUrl

The URL.

MongoClient(string)

Initializes a new instance of the MongoClient class.

public MongoClient(string connectionString)

Parameters

connectionString string

The connection string.

Properties

Cluster

Gets the cluster.

public override ICluster Cluster { get; }

Property Value

ICluster

Settings

Gets the settings.

public override sealed MongoClientSettings Settings { get; }

Property Value

MongoClientSettings

Methods

DropDatabase(IClientSessionHandle, string, CancellationToken)

Drops the database with the specified name.

public override sealed void DropDatabase(IClientSessionHandle session, string name, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle

The session.

name string

The name of the database to drop.

cancellationToken CancellationToken

The cancellation token.

DropDatabase(string, CancellationToken)

Drops the database with the specified name.

public override sealed void DropDatabase(string name, CancellationToken cancellationToken = default)

Parameters

name string

The name of the database to drop.

cancellationToken CancellationToken

The cancellation token.

DropDatabaseAsync(IClientSessionHandle, string, CancellationToken)

Drops the database with the specified name.

public override sealed Task DropDatabaseAsync(IClientSessionHandle session, string name, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle

The session.

name string

The name of the database to drop.

cancellationToken CancellationToken

The cancellation token.

Returns

Task

A task.

DropDatabaseAsync(string, CancellationToken)

Drops the database with the specified name.

public override sealed Task DropDatabaseAsync(string name, CancellationToken cancellationToken = default)

Parameters

name string

The name of the database to drop.

cancellationToken CancellationToken

The cancellation token.

Returns

Task

A task.

GetDatabase(string, MongoDatabaseSettings)

Gets a database.

public override sealed IMongoDatabase GetDatabase(string name, MongoDatabaseSettings settings = null)

Parameters

name string

The name of the database.

settings MongoDatabaseSettings

The database settings.

Returns

IMongoDatabase

An implementation of a database.

ListDatabaseNames(IClientSessionHandle, ListDatabaseNamesOptions, CancellationToken)

Returns the names of the databases on the server.

public override sealed IAsyncCursor<string> ListDatabaseNames(IClientSessionHandle session, ListDatabaseNamesOptions options, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle

The session.

options ListDatabaseNamesOptions

The options.

cancellationToken CancellationToken

The cancellation token.

Returns

IAsyncCursor<string>

The database names.

ListDatabaseNames(IClientSessionHandle, CancellationToken)

Returns the names of the databases on the server.

public override sealed IAsyncCursor<string> ListDatabaseNames(IClientSessionHandle session, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle

The session.

cancellationToken CancellationToken

The cancellation token.

Returns

IAsyncCursor<string>

The database names.

ListDatabaseNames(ListDatabaseNamesOptions, CancellationToken)

Returns the names of the databases on the server.

public override sealed IAsyncCursor<string> ListDatabaseNames(ListDatabaseNamesOptions options, CancellationToken cancellationToken = default)

Parameters

options ListDatabaseNamesOptions

The options.

cancellationToken CancellationToken

The cancellation token.

Returns

IAsyncCursor<string>

The database names.

ListDatabaseNames(CancellationToken)

Returns the names of the databases on the server.

public override sealed IAsyncCursor<string> ListDatabaseNames(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token.

Returns

IAsyncCursor<string>

The database names.

ListDatabaseNamesAsync(IClientSessionHandle, ListDatabaseNamesOptions, CancellationToken)

Returns the names of the databases on the server.

public override sealed Task<IAsyncCursor<string>> ListDatabaseNamesAsync(IClientSessionHandle session, ListDatabaseNamesOptions options, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle

The session.

options ListDatabaseNamesOptions

The options.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IAsyncCursor<string>>

The database names.

ListDatabaseNamesAsync(IClientSessionHandle, CancellationToken)

Returns the names of the databases on the server.

public override sealed Task<IAsyncCursor<string>> ListDatabaseNamesAsync(IClientSessionHandle session, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle

The session.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IAsyncCursor<string>>

The database names.

ListDatabaseNamesAsync(ListDatabaseNamesOptions, CancellationToken)

Returns the names of the databases on the server.

public override sealed Task<IAsyncCursor<string>> ListDatabaseNamesAsync(ListDatabaseNamesOptions options, CancellationToken cancellationToken = default)

Parameters

options ListDatabaseNamesOptions

The options.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IAsyncCursor<string>>

The database names.

ListDatabaseNamesAsync(CancellationToken)

Returns the names of the databases on the server.

public override sealed Task<IAsyncCursor<string>> ListDatabaseNamesAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IAsyncCursor<string>>

The database names.

ListDatabases(IClientSessionHandle, ListDatabasesOptions, CancellationToken)

Lists the databases on the server.

public override sealed IAsyncCursor<BsonDocument> ListDatabases(IClientSessionHandle session, ListDatabasesOptions options, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle

The session.

options ListDatabasesOptions

The options.

cancellationToken CancellationToken

The cancellation token.

Returns

IAsyncCursor<BsonDocument>

A cursor.

ListDatabases(IClientSessionHandle, CancellationToken)

Lists the databases on the server.

public override sealed IAsyncCursor<BsonDocument> ListDatabases(IClientSessionHandle session, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle

The session.

cancellationToken CancellationToken

The cancellation token.

Returns

IAsyncCursor<BsonDocument>

A cursor.

ListDatabases(ListDatabasesOptions, CancellationToken)

Lists the databases on the server.

public override sealed IAsyncCursor<BsonDocument> ListDatabases(ListDatabasesOptions options, CancellationToken cancellationToken = default)

Parameters

options ListDatabasesOptions

The options.

cancellationToken CancellationToken

The cancellation token.

Returns

IAsyncCursor<BsonDocument>

A cursor.

ListDatabases(CancellationToken)

Lists the databases on the server.

public override sealed IAsyncCursor<BsonDocument> ListDatabases(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token.

Returns

IAsyncCursor<BsonDocument>

A cursor.

ListDatabasesAsync(IClientSessionHandle, ListDatabasesOptions, CancellationToken)

Lists the databases on the server.

public override sealed Task<IAsyncCursor<BsonDocument>> ListDatabasesAsync(IClientSessionHandle session, ListDatabasesOptions options, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle

The session.

options ListDatabasesOptions

The options.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IAsyncCursor<BsonDocument>>

A Task whose result is a cursor.

ListDatabasesAsync(IClientSessionHandle, CancellationToken)

Lists the databases on the server.

public override sealed Task<IAsyncCursor<BsonDocument>> ListDatabasesAsync(IClientSessionHandle session, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle

The session.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IAsyncCursor<BsonDocument>>

A Task whose result is a cursor.

ListDatabasesAsync(ListDatabasesOptions, CancellationToken)

Lists the databases on the server.

public override sealed Task<IAsyncCursor<BsonDocument>> ListDatabasesAsync(ListDatabasesOptions options, CancellationToken cancellationToken = default)

Parameters

options ListDatabasesOptions

The options.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IAsyncCursor<BsonDocument>>

A Task whose result is a cursor.

ListDatabasesAsync(CancellationToken)

Lists the databases on the server.

public override sealed Task<IAsyncCursor<BsonDocument>> ListDatabasesAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IAsyncCursor<BsonDocument>>

A Task whose result is a cursor.

StartSession(ClientSessionOptions, CancellationToken)

Starts a client session.

public override sealed IClientSessionHandle StartSession(ClientSessionOptions options = null, CancellationToken cancellationToken = default)

Parameters

options ClientSessionOptions

The session options.

cancellationToken CancellationToken

The cancellation token.

Returns

IClientSessionHandle

A client session.

StartSessionAsync(ClientSessionOptions, CancellationToken)

Starts a client session.

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

Parameters

options ClientSessionOptions

The session options.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IClientSessionHandle>

A Task whose result is a client session.

WatchAsync<TResult>(IClientSessionHandle, PipelineDefinition<ChangeStreamDocument<BsonDocument>, TResult>, ChangeStreamOptions, CancellationToken)

Watches changes on all collections in all databases.

public override Task<IChangeStreamCursor<TResult>> WatchAsync<TResult>(IClientSessionHandle session, PipelineDefinition<ChangeStreamDocument<BsonDocument>, TResult> pipeline, ChangeStreamOptions options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle

The session.

pipeline PipelineDefinition<ChangeStreamDocument<BsonDocument>, TResult>

The pipeline.

options ChangeStreamOptions

The options.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IChangeStreamCursor<TResult>>

A change stream.

Type Parameters

TResult

The type of the result.

WatchAsync<TResult>(PipelineDefinition<ChangeStreamDocument<BsonDocument>, TResult>, ChangeStreamOptions, CancellationToken)

Watches changes on all collections in all databases.

public override Task<IChangeStreamCursor<TResult>> WatchAsync<TResult>(PipelineDefinition<ChangeStreamDocument<BsonDocument>, TResult> pipeline, ChangeStreamOptions options = null, CancellationToken cancellationToken = default)

Parameters

pipeline PipelineDefinition<ChangeStreamDocument<BsonDocument>, TResult>

The pipeline.

options ChangeStreamOptions

The options.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IChangeStreamCursor<TResult>>

A change stream.

Type Parameters

TResult

The type of the result.

Watch<TResult>(IClientSessionHandle, PipelineDefinition<ChangeStreamDocument<BsonDocument>, TResult>, ChangeStreamOptions, CancellationToken)

Watches changes on all collections in all databases.

public override IChangeStreamCursor<TResult> Watch<TResult>(IClientSessionHandle session, PipelineDefinition<ChangeStreamDocument<BsonDocument>, TResult> pipeline, ChangeStreamOptions options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle

The session.

pipeline PipelineDefinition<ChangeStreamDocument<BsonDocument>, TResult>

The pipeline.

options ChangeStreamOptions

The options.

cancellationToken CancellationToken

The cancellation token.

Returns

IChangeStreamCursor<TResult>

A change stream.

Type Parameters

TResult

The type of the result.

Watch<TResult>(PipelineDefinition<ChangeStreamDocument<BsonDocument>, TResult>, ChangeStreamOptions, CancellationToken)

Watches changes on all collections in all databases.

public override IChangeStreamCursor<TResult> Watch<TResult>(PipelineDefinition<ChangeStreamDocument<BsonDocument>, TResult> pipeline, ChangeStreamOptions options = null, CancellationToken cancellationToken = default)

Parameters

pipeline PipelineDefinition<ChangeStreamDocument<BsonDocument>, TResult>

The pipeline.

options ChangeStreamOptions

The options.

cancellationToken CancellationToken

The cancellation token.

Returns

IChangeStreamCursor<TResult>

A change stream.

Type Parameters

TResult

The type of the result.

WithReadConcern(ReadConcern)

Returns a new IMongoClient instance with a different read concern setting.

public override IMongoClient WithReadConcern(ReadConcern readConcern)

Parameters

readConcern ReadConcern

The read concern.

Returns

IMongoClient

A new IMongoClient instance with a different read concern setting.

WithReadPreference(ReadPreference)

Returns a new IMongoClient instance with a different read preference setting.

public override IMongoClient WithReadPreference(ReadPreference readPreference)

Parameters

readPreference ReadPreference

The read preference.

Returns

IMongoClient

A new IMongoClient instance with a different read preference setting.

WithWriteConcern(WriteConcern)

Returns a new IMongoClient instance with a different write concern setting.

public override IMongoClient WithWriteConcern(WriteConcern writeConcern)

Parameters

writeConcern WriteConcern

The write concern.

Returns

IMongoClient

A new IMongoClient instance with a different write concern setting.