MongoUrl Class

Represents an immutable URL style connection string. See also MongoUrlBuilder.

Inheritance Hierarchy

SystemObject
MongoDB.DriverMongoUrl

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.22.0+75246110ed1247226fcc7f8eb2c54ffab745693e

Syntax

Copy

[SerializableAttribute]
[TypeConverterAttribute(typeof(MongoUrlTypeConverter))]
public class MongoUrl : IEquatable<MongoUrl>

<SerializableAttribute>
<TypeConverterAttribute(GetType(MongoUrlTypeConverter))>
Public Class MongoUrl
	Implements IEquatable(Of MongoUrl)

[<SerializableAttribute>]
[<TypeConverterAttribute(typeof(MongoUrlTypeConverter))>]
type MongoUrl =  
    class
        interface IEquatable<MongoUrl>
    end

The MongoUrl type exposes the following members.

Constructors

	Name	Description
	MongoUrl	Creates a new instance of MongoUrl.

Top

Properties

	Name	Description
	AllowInsecureTls	Gets whether to relax TLS constraints as much as possible.
	ApplicationName	Gets the application name.
	AuthenticationMechanism	Gets the authentication mechanism.
	AuthenticationMechanismProperties	Gets the authentication mechanism properties.
	AuthenticationSource	Gets the authentication source.
	Compressors	Gets the compressors.
	ComputedWaitQueueSize	Obsolete. Gets the actual wait queue size (either WaitQueueSize or WaitQueueMultiple x MaxConnectionPoolSize).
	ConnectionMode	Obsolete. Gets the connection mode.
	ConnectionModeSwitch	Obsolete. Gets the connection mode switch.
	ConnectTimeout	Gets the connect timeout.
	DatabaseName	Gets the optional database name.
	DirectConnection	Gets the direct connection.
	FSync	Gets the FSync component of the write concern.
	GuidRepresentation	Obsolete. Gets the representation to use for Guids.
	HasAuthenticationSettings	Gets a value indicating whether this instance has authentication settings.
	HeartbeatInterval	Gets the heartbeat interval.
	HeartbeatTimeout	Gets the heartbeat timeout.
	IPv6	Gets a value indicating whether to use IPv6.
	IsResolved	Gets a value indicating whether a connection string with scheme MongoDBPlusSrv has been resolved.
	Journal	Gets the Journal component of the write concern.
	LoadBalanced	Gets or sets whether load balanced mode is used.
	LocalThreshold	Gets the local threshold.
	MaxConnecting	Gets the maximum concurrently connecting connections.
	MaxConnectionIdleTime	Gets the max connection idle time.
	MaxConnectionLifeTime	Gets the max connection life time.
	MaxConnectionPoolSize	Gets the max connection pool size.
	MinConnectionPoolSize	Gets the min connection pool size.
	Password	Gets the password.
	ReadConcernLevel	Gets the read concern level.
	ReadPreference	Gets the read preference.
	ReplicaSetName	Gets the name of the replica set.
	RetryReads	Gets whether reads will be retried.
	RetryWrites	Gets whether writes will be retried.
	Scheme	Gets the connection string scheme.
	Server	Gets the address of the server (see also Servers if using more than one address).
	Servers	Gets the list of server addresses (see also Server if using only one address).
	ServerSelectionTimeout	Gets the server selection timeout.
	SocketTimeout	Gets 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.
	TlsDisableCertificateRevocationCheck	Gets whether or not to disable checking certificate revocation status during the TLS handshake.
	Url	Gets the URL (in canonical form).
	Username	Gets the username.
	UseSsl	Obsolete. Gets a value indicating whether to use SSL.
	UseTls	Gets a value indicating whether to use TLS.
	VerifySslCertificate	Obsolete. Gets a value indicating whether to verify an SSL certificate.
	W	Gets the W component of the write concern.
	WaitQueueMultiple	Obsolete. Gets the wait queue multiple (the actual wait queue size will be WaitQueueMultiple x MaxConnectionPoolSize).
	WaitQueueSize	Obsolete. Gets the wait queue size.
	WaitQueueTimeout	Gets the wait queue timeout.
	WTimeout	Gets the WTimeout component of the write concern.

Top

Methods

	Name	Description
	ClearCache	Clears the URL cache. When a URL is parsed it is stored in the cache so that it doesn't have to be parsed again. There is rarely a need to call this method.
	Create	Creates an instance of MongoUrl (might be an existing existence if the same URL has been used before).
	Equals(Object)	Compares two MongoUrls. (Overrides ObjectEquals(Object).)
	Equals(MongoUrl)	Compares two MongoUrls.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetCredential	Gets the credential.
	GetHashCode	Gets the hash code. (Overrides ObjectGetHashCode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetWriteConcern	Returns a WriteConcern value based on this instance's settings and a default enabled value.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Resolve(CancellationToken)	Resolves a connection string. If the connection string indicates more information is available in the DNS system, it will acquire that information as well.
	Resolve(Boolean, CancellationToken)	Resolves a connection string. If the connection string indicates more information is available in the DNS system, it will acquire that information as well.
	ResolveAsync(CancellationToken)	Resolves a connection string. If the connection string indicates more information is available in the DNS system, it will acquire that information as well.
	ResolveAsync(Boolean, CancellationToken)	Resolves a connection string. If the connection string indicates more information is available in the DNS system, it will acquire that information as well.
	ToString	Returns the canonical URL based on the settings in this MongoUrlBuilder. (Overrides ObjectToString.)

Top

Operators

	Name	Description
	Equality	Compares two MongoUrls.
	Inequality	Compares two MongoUrls.

Top

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.)

Top

Reference

MongoDB.Driver Namespace