MongoUrl Class |
Represents an immutable URL style connection string. See also MongoUrlBuilder.
Inheritance HierarchyNamespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.5.0+57.Branch.master.Sha.6a4e00a2d91090c65a9b11364b9ebfdb9c7da076
SyntaxThe MongoUrl type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
 | ApplicationName |
Gets the application name.
|
| AuthenticationMechanism |
Gets the authentication mechanism.
|
| AuthenticationMechanismProperties |
Gets the authentication mechanism properties.
|
| AuthenticationSource |
Gets the authentication source.
|
| ComputedWaitQueueSize |
Gets the actual wait queue size (either WaitQueueSize or WaitQueueMultiple x MaxConnectionPoolSize).
|
| ConnectionMode |
Gets the connection mode.
|
| ConnectTimeout |
Gets the connect timeout.
|
| DatabaseName |
Gets the optional database name.
|
| FSync |
Gets the FSync component of the write concern.
|
| GuidRepresentation |
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.
|
| Journal |
Gets the Journal component of the write concern.
|
| LocalThreshold |
Gets the local threshold.
|
| 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.
|
| RetryWrites |
Gets whether writes will be retried.
|
| Scheme |
Gets the 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.
|
| Url |
Gets the URL (in canonical form).
|
| Username |
Gets the username.
|
| UseSsl |
Gets a value indicating whether to use SSL.
|
| VerifySslCertificate |
Gets a value indicating whether to verify an SSL certificate.
|
| W |
Gets the W component of the write concern.
|
| WaitQueueMultiple |
Gets the wait queue multiple (the actual wait queue size will be WaitQueueMultiple x MaxConnectionPoolSize).
|
| WaitQueueSize |
Gets the wait queue size.
|
| WaitQueueTimeout |
Gets the wait queue timeout.
|
| WTimeout |
Gets the WTimeout component of the write concern.
|
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 |
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 |
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.) |
Operators| Name | Description | |
|---|---|---|
 | Equality |
Compares two MongoUrls.
|
| Inequality |
Compares two MongoUrls.
|
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