MongoClientSettings Class |
The settings for a MongoDB client.
Inheritance HierarchyNamespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.20.0+ee01960089f28ea1b501690df5fc9f6318a70242
SyntaxThe MongoClientSettings type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | MongoClientSettings |
Creates a new instance of MongoClientSettings. Usually you would use a connection string instead.
|
Properties| Name | Description | |
|---|---|---|
 | AllowInsecureTls |
Gets or sets whether to relax TLS constraints as much as possible.
Setting this variable to true will also set SslSettings.CheckCertificateRevocation to false.
|
| ApplicationName |
Gets or sets the application name.
|
| AutoEncryptionOptions |
Gets or sets the auto encryption options.
|
| ClusterConfigurator |
Gets or sets the cluster configurator.
|
| Compressors |
Gets or sets the compressors.
|
| ConnectionMode | Obsolete.
Gets or sets the connection mode.
|
| ConnectionModeSwitch | Obsolete.
Gets the connection mode switch.
|
| ConnectTimeout |
Gets or sets the connect timeout.
|
| Credential |
Gets or sets the credential.
|
| Credentials | Obsolete.
Gets or sets the credentials.
|
| DirectConnection |
Gets or sets the direct connection.
|
| GuidRepresentation | Obsolete.
Gets or sets the representation to use for Guids.
|
| HeartbeatInterval |
Gets or sets the heartbeat interval.
|
| HeartbeatTimeout |
Gets or sets the heartbeat timeout.
|
| IPv6 |
Gets or sets a value indicating whether to use IPv6.
|
| IsFrozen |
Gets a value indicating whether the settings have been frozen to prevent further changes.
|
| LinqProvider |
Gets or sets the LINQ provider.
|
| LoadBalanced |
Gets or sets whether load balanced mode is used.
|
| LocalThreshold |
Gets or sets the local threshold.
|
| LoggingSettings |
Gets or sets the logging settings
|
| MaxConnecting |
Gets or sets the maximum concurrently connecting connections.
|
| MaxConnectionIdleTime |
Gets or sets the max connection idle time.
|
| MaxConnectionLifeTime |
Gets or sets the max connection life time.
|
| MaxConnectionPoolSize |
Gets or sets the max connection pool size.
|
| MinConnectionPoolSize |
Gets or sets the min connection pool size.
|
| ReadConcern |
Gets or sets the read concern.
|
| ReadEncoding |
Gets or sets the Read Encoding.
|
| ReadPreference |
Gets or sets the read preferences.
|
| ReplicaSetName |
Gets or sets the name of the replica set.
|
| RetryReads |
Gets or sets whether to retry reads.
|
| RetryWrites |
Gets or sets whether to retry writes.
|
| Scheme |
Gets or sets the connection string scheme.
|
| SdamLogFilename | Obsolete.
Gets or set the name of the SDAM log file. Null turns logging off. stdout will log to console.
|
| Server |
Gets or sets the address of the server (see also Servers if using more than one address).
|
| ServerApi |
Gets or sets the server API.
|
| Servers |
Gets or sets the list of server addresses (see also Server if using only one address).
|
| ServerSelectionTimeout |
Gets or sets the server selection timeout.
|
| SocketTimeout |
Gets or sets the socket timeout.
|
| SrvMaxHosts |
Limits the number of SRV records used to populate the seedlist
during initial discovery, as well as the number of additional hosts
that may be added during SRV polling.
|
| SslSettings |
Gets or sets the SSL settings.
|
| UseSsl | Obsolete.
Gets or sets a value indicating whether to use SSL.
|
| UseTls |
Gets or sets a value indicating whether to use TLS.
|
| VerifySslCertificate | Obsolete.
Gets or sets a value indicating whether to verify an SSL certificate.
|
| WaitQueueSize | Obsolete.
Gets or sets the wait queue size.
|
| WaitQueueTimeout |
Gets or sets the wait queue timeout.
|
| WriteConcern |
Gets or sets the WriteConcern to use.
|
| WriteEncoding |
Gets or sets the Write Encoding.
|
Methods| Name | Description | |
|---|---|---|
| Clone |
Creates a clone of the settings.
|
| Equals(Object) |
Determines whether the specified Object is equal to this instance.
(Overrides ObjectEquals(Object).) |
| Equals(MongoClientSettings) |
Determines whether the specified MongoClientSettings is equal to this instance.
|
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| Freeze |
Freezes the settings.
|
 | FromConnectionString |
Gets a MongoClientSettings object intialized with values from a connection string.
|
| FromUrl |
Gets a MongoClientSettings object intialized with values from a MongoURL.
|
| FrozenCopy |
Returns a frozen copy of the settings.
|
| GetHashCode |
Gets the hash code.
(Overrides ObjectGetHashCode.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString |
Returns a string representation of the settings.
(Overrides ObjectToString.) |
Operators| Name | Description | |
|---|---|---|
 | Equality |
Determines whether two MongoClientSettings instances are equal.
|
| Inequality |
Determines whether two MongoClientSettings instances are not equal.
|
Extension Methods| Name | Description | |
|---|---|---|
 | 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.) |
See Also