Scroll to navigation

MONGOC_URI_NEW_WITH_ERROR(3) libmongoc MONGOC_URI_NEW_WITH_ERROR(3)

NAME

mongoc_uri_new_with_error - mongoc_uri_new_with_error()

SYNOPSIS

mongoc_uri_t *
mongoc_uri_new_with_error (const char *uri_string,


                           bson_error_t *error) BSON_GNUC_WARN_UNUSED_RESULT;


PARAMETERS

  • uri_string: A string containing a URI.
  • error: An optional location for a bson_error_t or NULL.

DESCRIPTION

Parses a string containing a MongoDB style URI connection string.

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"

AUTHOR

MongoDB, Inc

COPYRIGHT

2017-present, MongoDB, Inc

August 31, 2022 1.23.0