The Linux Manuals (man pages) document is an important part of Linux documents. Linux Manuals are organized as several sections. Each section has a group of commands for a specific area in Linux usage, administration or development.
mongoc_uri_unescape() – Unescapes an URI encoded string. For example, "%40" would become "@". Synopsischar * mongoc_uri_unescape (const char *escaped_string);Parametersescaped_string A utf8 encoded string.DescriptionUnescapes an URI encoded string. For example, "%40" would become "@". ReturnsReturns a newly allocated string that should be freed with bson_free(3) \&. ColophonThis page is part of MongoDB C Driver. Please report…
mongoc_uri_t – mongoc_uri_t provides an abstraction on top of the MongoDB connection URI format. It provides standardized parsing as well as convenience methods for extracting useful information such as replica hosts or authorization information. Synopsistypedef struct _mongoc_uri_t mongoc_uri_t;Descriptionmongoc_uri_t provides an abstraction on top of the MongoDB connection URI format. It provides standardized parsing as well…
mongoc_uri_new_for_host_port() – Creates a new mongoc_uri_t based on the hostname and port provided. Synopsismongoc_uri_t * mongoc_uri_new_for_host_port (const char *hostname, uint16_t port);Parametershostname A string containing the hostname.port A uint16_t.DescriptionCreates a new mongoc_uri_t based on the hostname and port provided. ReturnsReturns a newly allocated mongoc_uri_t that should be freed with mongoc_uri_destroy(3) when no longer in use. ColophonThis…
mongoc_uri_new() – Parses a string containing a MongoDB style URI connection string. Synopsismongoc_uri_t * mongoc_uri_new (const char *uri_string) BSON_GNUC_WARN_UNUSED_RESULT;Parametersuri_string A string containing a URI.DescriptionParses a string containing a MongoDB style URI connection string. ReturnsA newly allocated mongoc_uri_t if successful. Otherwise NULL \&. NOTE Failure to handle the result of this function is a programming error.ExamplesExamples…
mongoc_uri_get_write_concern() – Fetches a write concern that is owned by the URI instance. This write concern is configured based on URI parameters. Synopsisconst mongoc_write_concern_t * mongoc_uri_get_write_concern (const mongoc_uri_t *uri);Parametersuri A mongoc_uri_t \&.DescriptionFetches a write concern that is owned by the URI instance. This write concern is configured based on URI parameters. ReturnsReturns a mongoc_write_concern_t that…
mongoc_uri_get_username() – Fetches the username portion of a URI. Synopsisconst char * mongoc_uri_get_username (const mongoc_uri_t *uri);Parametersuri A mongoc_uri_t \&.DescriptionFetches the username portion of a URI. ReturnsReturns a string which should not be modified or freed. ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
mongoc_uri_get_string() – Fetches the URI as a string. Synopsisconst char * mongoc_uri_get_string (const mongoc_uri_t *uri);Parametersuri A mongoc_uri_t \&.DescriptionFetches the URI as a string. ReturnsReturns a string which should not be modified or freed. ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
mongoc_uri_get_ssl() – Fetches a boolean indicating if SSL was specified for use in the URI. Synopsisbool mongoc_uri_get_ssl (const mongoc_uri_t *uri);Parametersuri A mongoc_uri_t \&.DescriptionFetches a boolean indicating if SSL was specified for use in the URI. ReturnsReturns a boolean, true indicating that SSL should be used. ColophonThis page is part of MongoDB C Driver. Please report…
mongoc_uri_get_replica_set() – Fetches the replicaSet parameter of an URI. Synopsisconst char * mongoc_uri_get_replica_set (const mongoc_uri_t *uri);Parametersuri A mongoc_uri_t \&.DescriptionFetches the replicaSet parameter of an URI. ReturnsReturns a string which should not be modified or freed. ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
mongoc_uri_get_read_prefs_t() – Fetches a read preference that is owned by the URI instance. This read preference concern is configured based on URI parameters. Synopsisconst mongoc_read_prefs_t * mongoc_uri_get_read_prefs_t (const mongoc_uri_t *uri);Parametersuri A mongoc_uri_t \&.DescriptionFetches a read preference that is owned by the URI instance. This read preference concern is configured based on URI parameters. ReturnsReturns a…
mongoc_uri_get_read_prefs() – Fetches a bson document containing read preference tag information from a URI. Note that this does not include the read preference mode. Synopsisconst bson_t * mongoc_uri_get_read_prefs (const mongoc_uri_t *uri);DeprecatedNOTE This function is deprecated and should not be used in new code. Please use mongoc_uri_get_read_prefs_t(3) instead. Parametersuri A mongoc_uri_t \&.DescriptionFetches a bson document containing…
mongoc_uri_get_read_concern() – Fetches a read concern that is owned by the URI instance. This read concern is configured based on URI parameters. Synopsisconst mongoc_read_concern_t * mongoc_uri_get_read_concern (const mongoc_uri_t *uri);Parametersuri A mongoc_uri_t \&.DescriptionFetches a read concern that is owned by the URI instance. This read concern is configured based on URI parameters. ReturnsReturns a mongoc_read_concern_t that…
mongoc_uri_get_password() – Fetches the password portion of an URI. Synopsisconst char * mongoc_uri_get_password (const mongoc_uri_t *uri);Parametersuri A mongoc_uri_t \&.DescriptionFetches the password portion of an URI. ReturnsA string which should not be modified or freed. ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
mongoc_uri_get_options() – Fetches a bson document containing all of the options provided after the ? of a URI. Synopsisconst bson_t * mongoc_uri_get_options (const mongoc_uri_t *uri);Parametersuri A mongoc_uri_t \&.DescriptionFetches a bson document containing all of the options provided after the ? of a URI. ReturnsA bson_t which should not be modified or freed. ColophonThis page is…
mongoc_uri_get_hosts() – Fetches a linked list of hosts that were defined in the URI (the comma-separated host section). Synopsisconst mongoc_host_list_t * mongoc_uri_get_hosts (const mongoc_uri_t *uri);Parametersuri A mongoc_uri_t \&.DescriptionFetches a linked list of hosts that were defined in the URI (the comma-separated host section). ReturnsA linked list of mongoc_host_list_t structures that should not be modified or…
mongoc_uri_get_database() – Fetches the database portion of an URI if provided. This is the portion after the / but before the ?. Synopsisconst char * mongoc_uri_get_database (const mongoc_uri_t *uri);Parametersuri A mongoc_uri_t \&.DescriptionFetches the database portion of an URI if provided. This is the portion after the / but before the ? \&. ReturnsA string which…
mongoc_uri_get_auth_source() – Fetches the authSource parameter of an URI if provided. Synopsisconst char * mongoc_uri_get_auth_source (const mongoc_uri_t *uri);Parametersuri A mongoc_uri_t \&.DescriptionFetches the authSource parameter of an URI if provided. ReturnsA string which should not be modified or freed. ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
mongoc_uri_get_auth_mechanism() – Fetches the authMechanism parameter to an URI if provided. Synopsisconst char * mongoc_uri_get_auth_mechanism (const mongoc_uri_t *uri);Parametersuri A mongoc_uri_t \&.DescriptionFetches the authMechanism parameter to an URI if provided. ReturnsA string which should not be modified or freed. ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
mongoc_uri_destroy() – Frees all resources associated with a uri. Synopsisvoid mongoc_uri_destroy (mongoc_uri_t *uri);Parametersuri A mongoc_uri_t \&.DescriptionFrees all resources associated with a uri. ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
mongoc_uri_copy() – Copies the entire contents of a URI. Synopsismongoc_uri_t * mongoc_uri_copy (const mongoc_uri_t *uri);Parametersuri A mongoc_uri_t \&.DescriptionCopies the entire contents of a URI. ReturnsA newly allocated mongoc_uri_t that should be freed with mongoc_uri_destroy(3) \&. ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.