Class MongoUrlBuilder

Namespace: MongoDB.Driver

Assembly: MongoDB.Driver.dll

Represents URL-style connection strings.

public class MongoUrlBuilder

Inheritance: object

MongoUrlBuilder

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

MongoUrlBuilder(): Creates a new instance of MongoUrlBuilder.

MongoUrlBuilder(string): Creates a new instance of MongoUrlBuilder.

Properties

AllowInsecureTls: Gets or sets whether to relax TLS constraints as much as possible.

ApplicationName: Gets or sets the application name.

AuthenticationMechanism: Gets or sets the authentication mechanism.

AuthenticationMechanismProperties: Gets or sets the authentication mechanism properties.

AuthenticationSource: Gets or sets the authentication source.

Compressors: Gets or sets the compressors.

ComputedWaitQueueSize: Gets the actual wait queue size (either WaitQueueSize or WaitQueueMultiple x MaxConnectionPoolSize).

ConnectTimeout: Gets or sets the connect timeout.

DatabaseName: Gets or sets the optional database name.

DirectConnection: Gets or sets the direct connection.

EnableOverloadRetargeting: Gets or sets whether overload retargeting is enabled.

FSync: Gets or sets the FSync component of the write concern.

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.

Journal: Gets or sets the Journal component of the write concern.

LoadBalanced: Gets or sets whether load balanced mode is used.

LocalThreshold: Gets or sets the local threshold.

MaxAdaptiveRetries: Gets or sets the maximum number of adaptive retries.

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.

Password: Gets or sets the password.

ProxyHost: Gets or sets the proxy host.

ProxyPassword: Gets or sets the proxy password.

ProxyPort: Gets or sets the proxy port.

ProxyUsername: Gets or sets the proxy username.

ReadConcernLevel: Gets or sets the read concern level.

ReadPreference: Gets or sets the read preference.

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: The connection string scheme.

Server: Gets or sets the address of the server (see also Servers if using more than one address).

ServerMonitoringMode: Gets or sets the server monitoring mode to use.

ServerSelectionTimeout: Gets or sets the server selection timeout.

Servers: Gets or sets the list of server addresses (see also Server if using only one address).

SocketTimeout: Gets or sets the socket timeout.

SrvAllowedHostsSuffix

Gets or sets the hostname suffix that hosts returned by an SRV lookup are validated against. When set, it replaces the domain name that would otherwise be inferred from the SRV hostname.

WARNING: Modifying the default SRV domain name validation can create vulnerabilities. Prefer the narrowest suffix that covers the deployment: the broader it is, the more hosts a forged SRV response could direct the driver to.

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.

SrvServiceName

Gets or sets the SRV service name which modifies the srv URI to look like:

_{srvServiceName}._tcp.{hostname}.{domainname}

TlsDisableCertificateRevocationCheck: Gets or sets whether to disable certificate revocation checking during the TLS handshake.

UseSsl: Gets or sets a value indicating whether to use SSL.

UseTls: Gets or sets a value indicating whether to use TLS.

Username: Gets or sets the username.

VerifySslCertificate: Gets or sets a value indicating whether to verify an SSL certificate.

W: Gets or sets the W component of the write concern.

WTimeout: Gets or sets the WTimeout component of the write concern.

WaitQueueMultiple: Gets or sets the wait queue multiple (the actual wait queue size will be WaitQueueMultiple x MaxConnectionPoolSize).

WaitQueueSize: Gets or sets the wait queue size.

WaitQueueTimeout: Gets or sets the wait queue timeout.

Methods

GetWriteConcern(bool): Returns a WriteConcern value based on this instance's settings and a default enabled value.

Parse(string): Parses a URL and sets all settings to match the URL.

ToMongoUrl(): Creates a new instance of MongoUrl based on the settings in this MongoUrlBuilder.

ToString(): Returns the canonical URL based on the settings in this MongoUrlBuilder.