Table of Contents

Class MongoUrlBuilder

Namespace
MongoDB.Driver
Assembly
MongoDB.Driver.dll

Represents URL-style connection strings.

[Serializable]
public class MongoUrlBuilder
Inheritance
MongoUrlBuilder
Inherited Members

Constructors

MongoUrlBuilder()

Creates a new instance of MongoUrlBuilder.

public MongoUrlBuilder()

MongoUrlBuilder(string)

Creates a new instance of MongoUrlBuilder.

public MongoUrlBuilder(string url)

Parameters

url string

The initial settings.

Properties

AllowInsecureTls

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

public bool AllowInsecureTls { get; set; }

Property Value

bool

ApplicationName

Gets or sets the application name.

public string ApplicationName { get; set; }

Property Value

string

AuthenticationMechanism

Gets or sets the authentication mechanism.

public string AuthenticationMechanism { get; set; }

Property Value

string

AuthenticationMechanismProperties

Gets or sets the authentication mechanism properties.

public IEnumerable<KeyValuePair<string, string>> AuthenticationMechanismProperties { get; set; }

Property Value

IEnumerable<KeyValuePair<string, string>>

AuthenticationSource

Gets or sets the authentication source.

public string AuthenticationSource { get; set; }

Property Value

string

Compressors

Gets or sets the compressors.

public IReadOnlyList<CompressorConfiguration> Compressors { get; set; }

Property Value

IReadOnlyList<CompressorConfiguration>

ComputedWaitQueueSize

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

[Obsolete("This property will be removed in a later release.")]
public int ComputedWaitQueueSize { get; }

Property Value

int

ConnectTimeout

Gets or sets the connect timeout.

public TimeSpan ConnectTimeout { get; set; }

Property Value

TimeSpan

ConnectionMode

Gets or sets the connection mode.

[Obsolete("Use DirectConnection instead.")]
public ConnectionMode ConnectionMode { get; set; }

Property Value

ConnectionMode

ConnectionModeSwitch

Gets the connection mode switch.

[Obsolete("This property will be removed in a later release.")]
public ConnectionModeSwitch ConnectionModeSwitch { get; }

Property Value

ConnectionModeSwitch

DatabaseName

Gets or sets the optional database name.

public string DatabaseName { get; set; }

Property Value

string

DirectConnection

Gets or sets the direct connection.

public bool? DirectConnection { get; set; }

Property Value

bool?

FSync

Gets or sets the FSync component of the write concern.

public bool? FSync { get; set; }

Property Value

bool?

GuidRepresentation

Gets or sets the representation to use for Guids.

[Obsolete("Configure serializers instead.")]
public GuidRepresentation GuidRepresentation { get; set; }

Property Value

GuidRepresentation

HeartbeatInterval

Gets or sets the heartbeat interval.

public TimeSpan HeartbeatInterval { get; set; }

Property Value

TimeSpan

HeartbeatTimeout

Gets or sets the heartbeat timeout.

public TimeSpan HeartbeatTimeout { get; set; }

Property Value

TimeSpan

IPv6

Gets or sets a value indicating whether to use IPv6.

public bool IPv6 { get; set; }

Property Value

bool

Journal

Gets or sets the Journal component of the write concern.

public bool? Journal { get; set; }

Property Value

bool?

LoadBalanced

Gets or sets whether load balanced mode is used.

public bool LoadBalanced { get; set; }

Property Value

bool

LocalThreshold

Gets or sets the local threshold.

public TimeSpan LocalThreshold { get; set; }

Property Value

TimeSpan

MaxConnecting

Gets or sets the maximum concurrently connecting connections.

public int MaxConnecting { get; set; }

Property Value

int

MaxConnectionIdleTime

Gets or sets the max connection idle time.

public TimeSpan MaxConnectionIdleTime { get; set; }

Property Value

TimeSpan

MaxConnectionLifeTime

Gets or sets the max connection life time.

public TimeSpan MaxConnectionLifeTime { get; set; }

Property Value

TimeSpan

MaxConnectionPoolSize

Gets or sets the max connection pool size.

public int MaxConnectionPoolSize { get; set; }

Property Value

int

MinConnectionPoolSize

Gets or sets the min connection pool size.

public int MinConnectionPoolSize { get; set; }

Property Value

int

Password

Gets or sets the password.

public string Password { get; set; }

Property Value

string

ReadConcernLevel

Gets or sets the read concern level.

public ReadConcernLevel? ReadConcernLevel { get; set; }

Property Value

ReadConcernLevel?

ReadPreference

Gets or sets the read preference.

public ReadPreference ReadPreference { get; set; }

Property Value

ReadPreference

ReplicaSetName

Gets or sets the name of the replica set.

public string ReplicaSetName { get; set; }

Property Value

string

RetryReads

Gets or sets whether to retry reads.

public bool? RetryReads { get; set; }

Property Value

bool?

RetryWrites

Gets or sets whether to retry writes.

public bool? RetryWrites { get; set; }

Property Value

bool?

Scheme

The connection string scheme.

public ConnectionStringScheme Scheme { get; set; }

Property Value

ConnectionStringScheme

Server

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

public MongoServerAddress Server { get; set; }

Property Value

MongoServerAddress

ServerSelectionTimeout

Gets or sets the server selection timeout.

public TimeSpan ServerSelectionTimeout { get; set; }

Property Value

TimeSpan

Servers

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

public IEnumerable<MongoServerAddress> Servers { get; set; }

Property Value

IEnumerable<MongoServerAddress>

SocketTimeout

Gets or sets the socket timeout.

public TimeSpan SocketTimeout { get; set; }

Property Value

TimeSpan

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.

public int? SrvMaxHosts { get; set; }

Property Value

int?

TlsDisableCertificateRevocationCheck

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

public bool TlsDisableCertificateRevocationCheck { get; set; }

Property Value

bool

UseSsl

Gets or sets a value indicating whether to use SSL.

[Obsolete("Use UseTls instead.")]
public bool UseSsl { get; set; }

Property Value

bool

UseTls

Gets or sets a value indicating whether to use TLS.

public bool UseTls { get; set; }

Property Value

bool

Username

Gets or sets the username.

public string Username { get; set; }

Property Value

string

VerifySslCertificate

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

[Obsolete("Use AllowInsecureTls instead.")]
public bool VerifySslCertificate { get; set; }

Property Value

bool

W

Gets or sets the W component of the write concern.

public WriteConcern.WValue W { get; set; }

Property Value

WriteConcern.WValue

WTimeout

Gets or sets the WTimeout component of the write concern.

public TimeSpan? WTimeout { get; set; }

Property Value

TimeSpan?

WaitQueueMultiple

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

[Obsolete("This property will be removed in a later release.")]
public double WaitQueueMultiple { get; set; }

Property Value

double

WaitQueueSize

Gets or sets the wait queue size.

[Obsolete("This property will be removed in a later release.")]
public int WaitQueueSize { get; set; }

Property Value

int

WaitQueueTimeout

Gets or sets the wait queue timeout.

public TimeSpan WaitQueueTimeout { get; set; }

Property Value

TimeSpan

Methods

GetWriteConcern(bool)

Returns a WriteConcern value based on this instance's settings and a default enabled value.

public WriteConcern GetWriteConcern(bool enabledDefault)

Parameters

enabledDefault bool

The default enabled value.

Returns

WriteConcern

A WriteConcern.

Parse(string)

Parses a URL and sets all settings to match the URL.

public void Parse(string url)

Parameters

url string

The URL.

ToMongoUrl()

Creates a new instance of MongoUrl based on the settings in this MongoUrlBuilder.

public MongoUrl ToMongoUrl()

Returns

MongoUrl

A new instance of MongoUrl.

ToString()

Returns the canonical URL based on the settings in this MongoUrlBuilder.

public override string ToString()

Returns

string

The canonical URL.