mongoc_uri_new_with_error()¶
Synopsis¶
mongoc_uri_t *
mongoc_uri_new_with_error (const char *uri_string,
bson_error_t *error);
Parameters¶
uri_string: A string containing a URI.error: An optional location for a bson_error_t orNULL.
Description¶
Parses a string containing a MongoDB style URI connection string.
Parse errors and warnings do not quote connection string components or arbitrary
option arguments. A diagnostic may identify a known option or authentication
mechanism by its canonical name, or report a successfully parsed integer for a
known, non-sensitive option. Unknown or malformed options are identified by a
zero-based character position within the query, starting immediately after
?. These positions refer to the original query, before percent-decoding, and
do not include the user information.
Diagnostics for options supplied by DNS identify a position within the original
TXT record instead.
Returns¶
A newly allocated mongoc_uri_t if successful. Otherwise NULL
populating error with the error description.
Warning
Failure to handle the result of this function is a programming error.
Examples¶
Examples of some valid MongoDB connection strings can be seen below.
"mongodb://localhost/"
"mongodb://localhost/?replicaSet=myreplset"
"mongodb://myuser:mypass@localhost/"
"mongodb://kerberosuser%40EXAMPLE.COM@example.com/?authMechanism=GSSAPI"
"mongodb://[::1]:27017/"
"mongodb://10.0.0.1:27017,10.0.0.1:27018,[::1]:27019/?tls=true"
"mongodb://%2Ftmp%2Fmongodb-27017.sock"
"mongodb://user:pass@%2Ftmp%2Fmongodb-27017.sock"
"mongodb://localhost,[::1]/mydb?authSource=mydb"