Click or drag to resize

MongoClient Class

Base class for implementors of IMongoClient.
Inheritance Hierarchy

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.11.0+cb27a82ea70620ad1acad8058809be8302ae4f2a
Syntax
public class MongoClient : MongoClientBase

The MongoClient type exposes the following members.

Constructors
  NameDescription
Public methodMongoClient
Initializes a new instance of the MongoClient class.
Public methodMongoClient(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.
Public methodMongoClient(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.
Public methodMongoClient(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
Methods
  NameDescription
Public methodDropDatabase(String, CancellationToken)
Drops the database with the specified name.
(Overrides MongoClientBaseDropDatabase(String, CancellationToken).)
Public methodDropDatabase(IClientSessionHandle, String, CancellationToken)
Drops the database with the specified name.
(Overrides MongoClientBaseDropDatabase(IClientSessionHandle, String, CancellationToken).)
Public methodDropDatabaseAsync(String, CancellationToken)
Drops the database with the specified name.
(Overrides MongoClientBaseDropDatabaseAsync(String, CancellationToken).)
Public methodDropDatabaseAsync(IClientSessionHandle, String, CancellationToken)
Drops the database with the specified name.
(Overrides MongoClientBaseDropDatabaseAsync(IClientSessionHandle, String, CancellationToken).)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetDatabase
Gets a database.
(Overrides MongoClientBaseGetDatabase(String, MongoDatabaseSettings).)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodListDatabaseNames(CancellationToken)
Returns the names of the databases on the server.
(Overrides MongoClientBaseListDatabaseNames(CancellationToken).)
Public methodListDatabaseNames(IClientSessionHandle, CancellationToken)
Returns the names of the databases on the server.
(Overrides MongoClientBaseListDatabaseNames(IClientSessionHandle, CancellationToken).)
Public methodListDatabaseNames(ListDatabaseNamesOptions, CancellationToken)
Returns the names of the databases on the server.
(Overrides MongoClientBaseListDatabaseNames(ListDatabaseNamesOptions, CancellationToken).)
Public methodListDatabaseNames(IClientSessionHandle, ListDatabaseNamesOptions, CancellationToken)
Returns the names of the databases on the server.
(Overrides MongoClientBaseListDatabaseNames(IClientSessionHandle, ListDatabaseNamesOptions, CancellationToken).)
Public methodListDatabaseNamesAsync(CancellationToken)
Returns the names of the databases on the server.
(Overrides MongoClientBaseListDatabaseNamesAsync(CancellationToken).)
Public methodListDatabaseNamesAsync(IClientSessionHandle, CancellationToken)
Returns the names of the databases on the server.
(Overrides MongoClientBaseListDatabaseNamesAsync(IClientSessionHandle, CancellationToken).)
Public methodListDatabaseNamesAsync(ListDatabaseNamesOptions, CancellationToken)
Returns the names of the databases on the server.
(Overrides MongoClientBaseListDatabaseNamesAsync(ListDatabaseNamesOptions, CancellationToken).)
Public methodListDatabaseNamesAsync(IClientSessionHandle, ListDatabaseNamesOptions, CancellationToken)
Returns the names of the databases on the server.
(Overrides MongoClientBaseListDatabaseNamesAsync(IClientSessionHandle, ListDatabaseNamesOptions, CancellationToken).)
Public methodListDatabases(CancellationToken)
Lists the databases on the server.
(Overrides MongoClientBaseListDatabases(CancellationToken).)
Public methodListDatabases(IClientSessionHandle, CancellationToken)
Lists the databases on the server.
(Overrides MongoClientBaseListDatabases(IClientSessionHandle, CancellationToken).)
Public methodListDatabases(ListDatabasesOptions, CancellationToken)
Lists the databases on the server.
(Overrides MongoClientBaseListDatabases(ListDatabasesOptions, CancellationToken).)
Public methodListDatabases(IClientSessionHandle, ListDatabasesOptions, CancellationToken)
Lists the databases on the server.
(Overrides MongoClientBaseListDatabases(IClientSessionHandle, ListDatabasesOptions, CancellationToken).)
Public methodListDatabasesAsync(CancellationToken)
Lists the databases on the server.
(Overrides MongoClientBaseListDatabasesAsync(CancellationToken).)
Public methodListDatabasesAsync(IClientSessionHandle, CancellationToken)
Lists the databases on the server.
(Overrides MongoClientBaseListDatabasesAsync(IClientSessionHandle, CancellationToken).)
Public methodListDatabasesAsync(ListDatabasesOptions, CancellationToken)
Lists the databases on the server.
(Overrides MongoClientBaseListDatabasesAsync(ListDatabasesOptions, CancellationToken).)
Public methodListDatabasesAsync(IClientSessionHandle, ListDatabasesOptions, CancellationToken)
Lists the databases on the server.
(Overrides MongoClientBaseListDatabasesAsync(IClientSessionHandle, ListDatabasesOptions, CancellationToken).)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodStartSession
Starts a client session.
(Overrides MongoClientBaseStartSession(ClientSessionOptions, CancellationToken).)
Public methodStartSessionAsync
Starts a client session.
(Overrides MongoClientBaseStartSessionAsync(ClientSessionOptions, CancellationToken).)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodWatchTResult(PipelineDefinitionChangeStreamDocumentBsonDocument, TResult, ChangeStreamOptions, CancellationToken)
Watches changes on all collections in all databases.
(Overrides MongoClientBaseWatchTResult(PipelineDefinitionChangeStreamDocumentBsonDocument, TResult, ChangeStreamOptions, CancellationToken).)
Public methodWatchTResult(PipelineDefinitionChangeStreamDocumentBsonDocument, TResult, ChangeStreamOptions, CancellationToken)
Watches changes on all collections in all databases.
(Inherited from MongoClientBase.)
Public methodWatchTResult(IClientSessionHandle, PipelineDefinitionChangeStreamDocumentBsonDocument, TResult, ChangeStreamOptions, CancellationToken)
Watches changes on all collections in all databases.
(Overrides MongoClientBaseWatchTResult(IClientSessionHandle, PipelineDefinitionChangeStreamDocumentBsonDocument, TResult, ChangeStreamOptions, CancellationToken).)
Public methodWatchTResult(IClientSessionHandle, PipelineDefinitionChangeStreamDocumentBsonDocument, TResult, ChangeStreamOptions, CancellationToken)
Watches changes on all collections in all databases.
(Inherited from MongoClientBase.)
Public methodWatchAsyncTResult(PipelineDefinitionChangeStreamDocumentBsonDocument, TResult, ChangeStreamOptions, CancellationToken)
Watches changes on all collections in all databases.
(Overrides MongoClientBaseWatchAsyncTResult(PipelineDefinitionChangeStreamDocumentBsonDocument, TResult, ChangeStreamOptions, CancellationToken).)
Public methodWatchAsyncTResult(PipelineDefinitionChangeStreamDocumentBsonDocument, TResult, ChangeStreamOptions, CancellationToken)
Watches changes on all collections in all databases.
(Inherited from MongoClientBase.)
Public methodWatchAsyncTResult(IClientSessionHandle, PipelineDefinitionChangeStreamDocumentBsonDocument, TResult, ChangeStreamOptions, CancellationToken)
Watches changes on all collections in all databases.
(Overrides MongoClientBaseWatchAsyncTResult(IClientSessionHandle, PipelineDefinitionChangeStreamDocumentBsonDocument, TResult, ChangeStreamOptions, CancellationToken).)
Public methodWatchAsyncTResult(IClientSessionHandle, PipelineDefinitionChangeStreamDocumentBsonDocument, TResult, ChangeStreamOptions, CancellationToken)
Watches changes on all collections in all databases.
(Inherited from MongoClientBase.)
Public methodWithReadConcern
Returns a new IMongoClient instance with a different read concern setting.
(Overrides MongoClientBaseWithReadConcern(ReadConcern).)
Public methodWithReadPreference
Returns a new IMongoClient instance with a different read preference setting.
(Overrides MongoClientBaseWithReadPreference(ReadPreference).)
Public methodWithWriteConcern
Returns a new IMongoClient instance with a different write concern setting.
(Overrides MongoClientBaseWithWriteConcern(WriteConcern).)
Top
Extension Methods
  NameDescription
Public Extension MethodGetServer
Gets a MongoServer object using this client's settings.
(Defined by MongoClientExtensions.)
Public Extension MethodToBson
Serializes an object to a BSON byte array.
(Defined by BsonExtensionMethods.)
Public Extension MethodToBsonDocument
Serializes an object to a BsonDocument.
(Defined by BsonExtensionMethods.)
Public Extension MethodToJson
Serializes an object to a JSON string.
(Defined by BsonExtensionMethods.)
Top
See Also