MongoClient Class

Base class for implementors of IMongoClient.

Inheritance Hierarchy

SystemObject
MongoDB.DriverMongoClientBase
MongoDB.DriverMongoClient

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.13.1-v2-13-x1+a7f8afe27855f38f4f72157d11ba2ae73895502e

Syntax

Copy

public class MongoClient : MongoClientBase

Public Class MongoClient
	Inherits MongoClientBase

type MongoClient =  
    class
        inherit MongoClientBase
    end

The MongoClient type exposes the following members.

Constructors

	Name	Description
	MongoClient	Initializes a new instance of the MongoClient class.
	MongoClient(String)	Initializes a new instance of the MongoClient class. In .NET Standard, authenticating via SCRAM-SHA-256 may not work with non-ASCII passwords because SaslPrep is not fully implemented due to the lack of a string normalization function in .NET Standard 1.5. Normalizing the password into Unicode Normalization Form KC beforehand MAY help. SCRAM-SHA-1 is the recommended alternative for now.
	MongoClient(MongoClientSettings)	Initializes a new instance of the MongoClient class. In .NET Standard, authenticating via SCRAM-SHA-256 may not work with non-ASCII passwords because SaslPrep is not fully implemented due to the lack of a string normalization function in .NET Standard 1.5. Normalizing the password into Unicode Normalization Form KC beforehand MAY help. SCRAM-SHA-1 is the recommended alternative for now.
	MongoClient(MongoUrl)	Initializes a new instance of the MongoClient class. In .NET Standard, authenticating via SCRAM-SHA-256 may not work with non-ASCII passwords because SaslPrep is not fully implemented due to the lack of a string normalization function in .NET Standard 1.5. Normalizing the password into Unicode Normalization Form KC beforehand MAY help. SCRAM-SHA-1 is the recommended alternative for now.

Top

Properties

	Name	Description
	Cluster	Gets the cluster. (Overrides MongoClientBaseCluster.)
	Settings	Gets the settings. (Overrides MongoClientBaseSettings.)

Top

Methods

Top

Extension Methods

	Name	Description
	GetServer	Gets a MongoServer object using this client's settings. (Defined by MongoClientExtensions.)
	ToBson	Serializes an object to a BSON byte array. (Defined by BsonExtensionMethods.)
	ToBsonDocument	Serializes an object to a BsonDocument. (Defined by BsonExtensionMethods.)
	ToJson	Serializes an object to a JSON string. (Defined by BsonExtensionMethods.)

Top

Reference

MongoDB.Driver Namespace

	Name	Description
	DropDatabase(String, CancellationToken)	Drops the database with the specified name. (Overrides MongoClientBaseDropDatabase(String, CancellationToken).)
	DropDatabase(IClientSessionHandle, String, CancellationToken)	Drops the database with the specified name. (Overrides MongoClientBaseDropDatabase(IClientSessionHandle, String, CancellationToken).)
	DropDatabaseAsync(String, CancellationToken)	Drops the database with the specified name. (Overrides MongoClientBaseDropDatabaseAsync(String, CancellationToken).)
	DropDatabaseAsync(IClientSessionHandle, String, CancellationToken)	Drops the database with the specified name. (Overrides MongoClientBaseDropDatabaseAsync(IClientSessionHandle, String, CancellationToken).)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetDatabase	Gets a database. (Overrides MongoClientBaseGetDatabase(String, MongoDatabaseSettings).)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ListDatabaseNames(CancellationToken)	Returns the names of the databases on the server. (Overrides MongoClientBaseListDatabaseNames(CancellationToken).)
	ListDatabaseNames(IClientSessionHandle, CancellationToken)	Returns the names of the databases on the server. (Overrides MongoClientBaseListDatabaseNames(IClientSessionHandle, CancellationToken).)
	ListDatabaseNames(ListDatabaseNamesOptions, CancellationToken)	Returns the names of the databases on the server. (Overrides MongoClientBaseListDatabaseNames(ListDatabaseNamesOptions, CancellationToken).)
	ListDatabaseNames(IClientSessionHandle, ListDatabaseNamesOptions, CancellationToken)	Returns the names of the databases on the server. (Overrides MongoClientBaseListDatabaseNames(IClientSessionHandle, ListDatabaseNamesOptions, CancellationToken).)
	ListDatabaseNamesAsync(CancellationToken)	Returns the names of the databases on the server. (Overrides MongoClientBaseListDatabaseNamesAsync(CancellationToken).)
	ListDatabaseNamesAsync(IClientSessionHandle, CancellationToken)	Returns the names of the databases on the server. (Overrides MongoClientBaseListDatabaseNamesAsync(IClientSessionHandle, CancellationToken).)
	ListDatabaseNamesAsync(ListDatabaseNamesOptions, CancellationToken)	Returns the names of the databases on the server. (Overrides MongoClientBaseListDatabaseNamesAsync(ListDatabaseNamesOptions, CancellationToken).)
	ListDatabaseNamesAsync(IClientSessionHandle, ListDatabaseNamesOptions, CancellationToken)	Returns the names of the databases on the server. (Overrides MongoClientBaseListDatabaseNamesAsync(IClientSessionHandle, ListDatabaseNamesOptions, CancellationToken).)
	ListDatabases(CancellationToken)	Lists the databases on the server. (Overrides MongoClientBaseListDatabases(CancellationToken).)
	ListDatabases(IClientSessionHandle, CancellationToken)	Lists the databases on the server. (Overrides MongoClientBaseListDatabases(IClientSessionHandle, CancellationToken).)
	ListDatabases(ListDatabasesOptions, CancellationToken)	Lists the databases on the server. (Overrides MongoClientBaseListDatabases(ListDatabasesOptions, CancellationToken).)
	ListDatabases(IClientSessionHandle, ListDatabasesOptions, CancellationToken)	Lists the databases on the server. (Overrides MongoClientBaseListDatabases(IClientSessionHandle, ListDatabasesOptions, CancellationToken).)
	ListDatabasesAsync(CancellationToken)	Lists the databases on the server. (Overrides MongoClientBaseListDatabasesAsync(CancellationToken).)
	ListDatabasesAsync(IClientSessionHandle, CancellationToken)	Lists the databases on the server. (Overrides MongoClientBaseListDatabasesAsync(IClientSessionHandle, CancellationToken).)
	ListDatabasesAsync(ListDatabasesOptions, CancellationToken)	Lists the databases on the server. (Overrides MongoClientBaseListDatabasesAsync(ListDatabasesOptions, CancellationToken).)
	ListDatabasesAsync(IClientSessionHandle, ListDatabasesOptions, CancellationToken)	Lists the databases on the server. (Overrides MongoClientBaseListDatabasesAsync(IClientSessionHandle, ListDatabasesOptions, CancellationToken).)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	StartSession	Starts a client session. (Overrides MongoClientBaseStartSession(ClientSessionOptions, CancellationToken).)
	StartSessionAsync	Starts a client session. (Overrides MongoClientBaseStartSessionAsync(ClientSessionOptions, CancellationToken).)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	WatchTResult(PipelineDefinitionChangeStreamDocumentBsonDocument, TResult, ChangeStreamOptions, CancellationToken)	Watches changes on all collections in all databases. (Overrides MongoClientBaseWatchTResult(PipelineDefinitionChangeStreamDocumentBsonDocument, TResult, ChangeStreamOptions, CancellationToken).)
	WatchTResult(PipelineDefinitionChangeStreamDocumentBsonDocument, TResult, ChangeStreamOptions, CancellationToken)	Watches changes on all collections in all databases. (Inherited from MongoClientBase.)
	WatchTResult(IClientSessionHandle, PipelineDefinitionChangeStreamDocumentBsonDocument, TResult, ChangeStreamOptions, CancellationToken)	Watches changes on all collections in all databases. (Overrides MongoClientBaseWatchTResult(IClientSessionHandle, PipelineDefinitionChangeStreamDocumentBsonDocument, TResult, ChangeStreamOptions, CancellationToken).)
	WatchTResult(IClientSessionHandle, PipelineDefinitionChangeStreamDocumentBsonDocument, TResult, ChangeStreamOptions, CancellationToken)	Watches changes on all collections in all databases. (Inherited from MongoClientBase.)
	WatchAsyncTResult(PipelineDefinitionChangeStreamDocumentBsonDocument, TResult, ChangeStreamOptions, CancellationToken)	Watches changes on all collections in all databases. (Overrides MongoClientBaseWatchAsyncTResult(PipelineDefinitionChangeStreamDocumentBsonDocument, TResult, ChangeStreamOptions, CancellationToken).)
	WatchAsyncTResult(PipelineDefinitionChangeStreamDocumentBsonDocument, TResult, ChangeStreamOptions, CancellationToken)	Watches changes on all collections in all databases. (Inherited from MongoClientBase.)
	WatchAsyncTResult(IClientSessionHandle, PipelineDefinitionChangeStreamDocumentBsonDocument, TResult, ChangeStreamOptions, CancellationToken)	Watches changes on all collections in all databases. (Overrides MongoClientBaseWatchAsyncTResult(IClientSessionHandle, PipelineDefinitionChangeStreamDocumentBsonDocument, TResult, ChangeStreamOptions, CancellationToken).)
	WatchAsyncTResult(IClientSessionHandle, PipelineDefinitionChangeStreamDocumentBsonDocument, TResult, ChangeStreamOptions, CancellationToken)	Watches changes on all collections in all databases. (Inherited from MongoClientBase.)
	WithReadConcern	Returns a new IMongoClient instance with a different read concern setting. (Overrides MongoClientBaseWithReadConcern(ReadConcern).)
	WithReadPreference	Returns a new IMongoClient instance with a different read preference setting. (Overrides MongoClientBaseWithReadPreference(ReadPreference).)
	WithWriteConcern	Returns a new IMongoClient instance with a different write concern setting. (Overrides MongoClientBaseWithWriteConcern(WriteConcern).)