Platforms to show: All Mac Windows Linux Cross-Platform
Back to MongoURIMBS class.
MongoURIMBS.AuthMechanism as String
Function:
Authentication mechanism.
Notes:
Sets the “authMechanism” URI option, such as “SCRAM-SHA-1” or “GSSAPI”, after the URI has been parsed from a string.
Updates the option in-place if already set, otherwise appends it to the URI’s of options.
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | MongoDB | MBS MongoDB Plugin | 22.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
Sets the “authMechanism” URI option, such as “SCRAM-SHA-1” or “GSSAPI”, after the URI has been parsed from a string.
Updates the option in-place if already set, otherwise appends it to the URI’s of options.
(Read and Write property)
MongoURIMBS.AuthSource as String
Function:
Authentication source.
Notes:
Sets the “authSource” URI option, after the URI has been parsed from a string.
Updates the option in-place if already set, otherwise appends it to the URI’s options.
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | MongoDB | MBS MongoDB Plugin | 22.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
Sets the “authSource” URI option, after the URI has been parsed from a string.
Updates the option in-place if already set, otherwise appends it to the URI’s options.
(Read and Write property)
MongoURIMBS.Compressors as String
Function:
Gets or sets compressors to use.
Notes:
Sets the URI’s compressors, after the URI has been parsed from a string. Will overwrite any previously set value.
Value is a text consisting of one or more comma (,) separated compressors (e.g. “snappy,zlib”) or "".
Passing "" clears any existing compressors set on uri.
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | MongoDB | MBS MongoDB Plugin | 22.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
Sets the URI’s compressors, after the URI has been parsed from a string. Will overwrite any previously set value.
Value is a text consisting of one or more comma (,) separated compressors (e.g. “snappy,zlib”) or "".
Passing "" clears any existing compressors set on uri.
(Read and Write property)
MongoURIMBS.DatabaseName as String
Function:
Fetches the database portion of an URI if provided.
Notes:
This is the portion after the / but before the ?.
Sets the URI's database, after the URI has been parsed from a string.
The driver authenticates to this database if the connection string includes authentication credentials. This database is used when you open the default database with DefaultDatabase function.
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | MongoDB | MBS MongoDB Plugin | 22.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
This is the portion after the / but before the ?.
Sets the URI's database, after the URI has been parsed from a string.
The driver authenticates to this database if the connection string includes authentication credentials. This database is used when you open the default database with DefaultDatabase function.
(Read and Write property)
Some examples using this property:
MongoURIMBS.Handle as Integer
Function:
The internal object reference.
Notes: (Read only property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | MongoDB | MBS MongoDB Plugin | 22.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes: (Read only property)
MongoURIMBS.Hosts as MongoHostListMBS
Function:
Fetches a linked list of hosts that were defined in the URI (the comma-separated host section).
Notes: (Read only property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | MongoDB | MBS MongoDB Plugin | 22.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes: (Read only property)
MongoURIMBS.Options as String
Function:
Queries the options from the URL.
Notes:
Fetches a JSON document containing all of the options provided after the ? of a URI.
Can be empty if not set.
(Read only property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | MongoDB | MBS MongoDB Plugin | 23.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
Fetches a JSON document containing all of the options provided after the ? of a URI.
Can be empty if not set.
(Read only property)
MongoURIMBS.Password as String
Function:
Fetches the password portion of an URI.
Example:
Notes:
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | MongoDB | MBS MongoDB Plugin | 22.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Example:
Dim URL As String = "mongodb://myuser:mypass@localhost/"
Dim URI As New MongoURIMBS(URL)
MessageBox URI.Password
MongoURIMBS.ServiceHostName as String
Function:
Queries the hostname for the service.
Notes: (Read only property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | MongoDB | MBS MongoDB Plugin | 22.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes: (Read only property)
MongoURIMBS.ServiceName as String
Function:
Queries the service name.
Notes: (Read only property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | MongoDB | MBS MongoDB Plugin | 22.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes: (Read only property)
MongoURIMBS.TLS as Boolean
Function:
Whether this connection is set to be encrypted.
Notes:
Fetches a boolean indicating if TLS was specified for use in the URI.
Returns a boolean, true indicating that TLS should be used. This returns true if any TLS option is specified.
(Read only property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | MongoDB | MBS MongoDB Plugin | 23.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
Fetches a boolean indicating if TLS was specified for use in the URI.
Returns a boolean, true indicating that TLS should be used. This returns true if any TLS option is specified.
(Read only property)
MongoURIMBS.URI as String
Function:
Fetches the URI as a string.
Example:
Notes:
(Read only property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | MongoDB | MBS MongoDB Plugin | 22.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Example:
dim URL as string = "mongodb://localhost/"
dim URI as new MongoURIMBS(URL)
MessageBox URI.URI
MongoURIMBS.UserName as String
Function:
Fetches the username portion of a URI.
Example:
Notes:
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | MongoDB | MBS MongoDB Plugin | 22.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Example:
dim URL as string = "mongodb://myuser:mypass@localhost/"
dim URI as new MongoURIMBS(URL)
MessageBox URI.UserName+EndOfLine+uri.Password
The items on this page are in the following plugins: MBS MongoDB Plugin.
