mongoc_uri

Synopsis

typedef struct _mongoc_uri_t mongoc_uri_t;

Description

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.

See Connection String URI Reference on the MongoDB website for more information.

Format

mongodb://                                   <1>
   [username:password@]                      <2>
   host1                                     <3>
   [:port1]                                  <4>
   [,host2[:port2],...[,hostN[:portN]]]      <5>
   [/[database]                              <6>
   [?options]]                               <7>

mongodb is the specifier of the MongoDB protocol.
An optional username and password.
The only required part of the uri. This specifies either a hostname, IP address or UNIX domain socket.
An optional port number. Defaults to :27017.
Extra optional hosts and ports. You would specify multiple hosts, for example, for connections to replica sets.
The name of the database to authenticate if the connection string includes authentication credentials. If /database is not specified and the connection string includes credentials, defaults to the 'admin' database.
Connection specific options.

Replica Set Example

To describe a connection to a replica set named 'test' with the following mongod hosts:

db1.example.com on port 27017
db2.example.com on port 2500

You would use the connection string that resembles the following.

mongodb://db1.example.com,db2.example.com:2500/?replicaSet=test

Connection Options

ssl	{true\|false}, idicating if SSL must be used.
connectTimeoutMS	A timeout in milliseconds to attempt a connection before timing out. The default is no timeout.
socketTimeoutMS	The time in milliseconds to attempt to send or receive on a socket before the attempt times out. The default is 5 minutes.

Connection Pool Options

maxPoolSize	The maximum number of connections in the pool. The default value is 100.
minPoolSize	The minimum number of connections in the connection pool. Default value is 0. These are lazily created.
maxIdleTimeMS	Not implemented.
waitQueueMultiple	Not implemented.
waitQueueTimeoutMS	Not implemented.

Write Concern Options

w

-1	The driver will not acknowledge write operations and will suppress all network or socket errors.
0	The driver will not acknowledge write operations but will pass or handle any network and socket errors that it receives to the client. If you disable write concern but enable the getLastError command’s w option, w overrides the w option.
1	Provides basic acknowledgment of write operations. By specifying 1, you require that a standalone mongod instance, or the primary for replica sets, acknowledge all write operations. For drivers released after the default write concern change, this is the default write concern setting.
majority	For replica sets, if you specify the special majority value to w option, write operations will only return successfully after a majority of the configured replica set members have acknowledged the write operation.
n	For replica sets, if you specify a number n greater than 1, operations with this write concern return only after n members of the set have acknowledged the write. If you set n to a number that is greater than the number of available set members or members that hold data, MongoDB will wait, potentially indefinitely, for these members to become available.
tags	For replica sets, you can specify a tag set to require that all members of the set that have these tags configured return confirmation of the write operation.

wtimeoutMS

The time in milliseconds to wait for replication to succeed, as specified in the w option, before timing out. When wtimeoutMS is 0, write operations will never time out.

journal

Controls whether write operations will wait until the mongod acknowledges the write operations and commits the data to the on disk journal.

true	Enables journal commit acknowledgment write concern. Equivalent to specifying the getLastError command with the j option enabled.
false	Does not require that mongod commit write operations to the journal before acknowledging the write operation. This is the default option for the journal parameter.

Read Preference Options

readPreference	Specifies the replica set read preference for this connection. This setting overrides any slaveOk value. The read preference values are the following: primary primaryPreferred secondary secondaryPreferred nearest
readPreferenceTags	Specifies a tag set as a comma-seperated list of colon-separted key-value pairs.