Class: MongoClient

Methods

connect(url, options, callback){Promise}

lib/mongo_client.js, line 144

Connect to MongoDB using a url as documented at

docs.mongodb.org/manual/reference/connection-string/

Note that for replicasets the replicaSet query parameter is required in the 2.0 driver

Name	Type	Description
url	string	The connection URI string
options	object	optional Optional settings. Name Type Default Description poolSize number 5 optional poolSize The maximum size of the individual server pool. ssl boolean false optional Enable SSL connection. sslCA Buffer optional SSL Certificate store binary buffer sslCRL Buffer optional SSL Certificate revocation list binary buffer sslCert Buffer optional SSL Certificate binary buffer sslKey Buffer optional SSL Key file binary buffer sslPass string optional SSL Certificate pass phrase checkServerIdentity boolean | function true optional Ensure we check server identify during SSL, set to false to disable checking. Only works for Node 0.12.x or higher. You can pass in a boolean or your own checkServerIdentity override function. autoReconnect boolean true optional Enable autoReconnect for single server instances noDelay boolean true optional TCP Connection no delay family number 4 optional Version of IP stack. Defaults to 4. keepAlive boolean 30000 optional The number of milliseconds to wait before initiating keepAlive on the TCP socket. connectTimeoutMS number 30000 optional TCP Connection timeout setting socketTimeoutMS number 360000 optional TCP Socket timeout setting reconnectTries number 30 optional Server attempt to reconnect #times reconnectInterval number 1000 optional Server will wait # milliseconds between retries ha boolean true optional Control if high availability monitoring runs for Replicaset or Mongos proxies. haInterval number 10000 optional The High availability period for replicaset inquiry replicaSet string optional The Replicaset set name secondaryAcceptableLatencyMS number 15 optional Cutoff latency point in MS for Replicaset member selection acceptableLatencyMS number 15 optional Cutoff latency point in MS for Mongos proxies selection. connectWithNoPrimary boolean false optional Sets if the driver should connect even if no primary is available authSource string optional Define the database to authenticate against auth.user string optional The username for auth auth.password string optional The password for auth w number | string null optional The write concern. wtimeout number null optional The write concern timeout. j boolean false optional Specify a journal write concern. forceServerObjectId boolean false optional Force server to assign _id values instead of driver. serializeFunctions boolean false optional Serialize functions on any object. ignoreUndefined Boolean false optional Specify if the BSON serializer should ignore undefined fields. raw boolean false optional Return document results as raw BSON buffers. promoteLongs boolean true optional Promotes Long values to number if they fit inside the 53 bits resolution. promoteBuffers boolean false optional Promotes Binary BSON values to native Node Buffers. promoteValues boolean true optional Promotes BSON values to native types where possible, set to false to only receive wrapper types. bufferMaxEntries number -1 optional Sets a cap on how many operations the driver will buffer up before giving up on getting a working connection, default is -1 which is unlimited. readPreference ReadPreference | string null optional The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST). domainsEnabled boolean false optional Enable the wrapping of the callback in the current domain, disabled by default to avoid perf hit. pkFactory object null optional A primary key factory object for generation of custom _id keys. promiseLibrary object null optional A Promise library class the application wishes to use such as Bluebird, must be ES6 compatible readConcern object null optional Specify a read concern for the collection. (only MongoDB 3.2 or higher supported) Name Type Default Description level string 'local' optional Specify a read concern level for the collection operations, one of [local|majority]. (only MongoDB 3.2 or higher supported) maxStalenessSeconds number optional The max staleness to secondary reads (values under 10 seconds cannot be guaranteed); appname string optional The name of the application that created this MongoClient instance. MongoDB 3.4 and newer will print this value in the server log upon establishing each connection. It is also recorded in the slow query log and profile collections. loggerLevel string optional The logging level (error/warn/info/debug) logger object optional Custom logger object validateOptions object false optional Validate MongoClient passed in options for correctness.
callback	MongoClient~connectCallback	optional The command result callback

Returns:

Promise if no callback passed

staticMongoClient.connect(url, options, callback){Promise}

lib/mongo_client.js, line 215

Connect to MongoDB using a url as documented at

docs.mongodb.org/manual/reference/connection-string/

Note that for replicasets the replicaSet query parameter is required in the 2.0 driver

Name	Type	Description
url	string	The connection URI string
options	object	optional Optional settings. Name Type Default Description poolSize number 5 optional poolSize The maximum size of the individual server pool. ssl boolean false optional Enable SSL connection. sslCA Buffer optional SSL Certificate store binary buffer sslCRL Buffer optional SSL Certificate revocation list binary buffer sslCert Buffer optional SSL Certificate binary buffer sslKey Buffer optional SSL Key file binary buffer sslPass string optional SSL Certificate pass phrase checkServerIdentity boolean | function true optional Ensure we check server identify during SSL, set to false to disable checking. Only works for Node 0.12.x or higher. You can pass in a boolean or your own checkServerIdentity override function. autoReconnect boolean true optional Enable autoReconnect for single server instances noDelay boolean true optional TCP Connection no delay family number 4 optional Version of IP stack. Defaults to 4. keepAlive boolean 30000 optional The number of milliseconds to wait before initiating keepAlive on the TCP socket. connectTimeoutMS number 30000 optional TCP Connection timeout setting socketTimeoutMS number 360000 optional TCP Socket timeout setting reconnectTries number 30 optional Server attempt to reconnect #times reconnectInterval number 1000 optional Server will wait # milliseconds between retries ha boolean true optional Control if high availability monitoring runs for Replicaset or Mongos proxies. haInterval number 10000 optional The High availability period for replicaset inquiry replicaSet string optional The Replicaset set name secondaryAcceptableLatencyMS number 15 optional Cutoff latency point in MS for Replicaset member selection acceptableLatencyMS number 15 optional Cutoff latency point in MS for Mongos proxies selection. connectWithNoPrimary boolean false optional Sets if the driver should connect even if no primary is available authSource string optional Define the database to authenticate against auth.user string optional The username for auth auth.password string optional The password for auth w number | string null optional The write concern. wtimeout number null optional The write concern timeout. j boolean false optional Specify a journal write concern. forceServerObjectId boolean false optional Force server to assign _id values instead of driver. serializeFunctions boolean false optional Serialize functions on any object. ignoreUndefined Boolean false optional Specify if the BSON serializer should ignore undefined fields. raw boolean false optional Return document results as raw BSON buffers. promoteLongs boolean true optional Promotes Long values to number if they fit inside the 53 bits resolution. promoteBuffers boolean false optional Promotes Binary BSON values to native Node Buffers. promoteValues boolean true optional Promotes BSON values to native types where possible, set to false to only receive wrapper types. bufferMaxEntries number -1 optional Sets a cap on how many operations the driver will buffer up before giving up on getting a working connection, default is -1 which is unlimited. readPreference ReadPreference | string null optional The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST). domainsEnabled boolean false optional Enable the wrapping of the callback in the current domain, disabled by default to avoid perf hit. pkFactory object null optional A primary key factory object for generation of custom _id keys. promiseLibrary object null optional A Promise library class the application wishes to use such as Bluebird, must be ES6 compatible readConcern object null optional Specify a read concern for the collection. (only MongoDB 3.2 or higher supported) Name Type Default Description level string 'local' optional Specify a read concern level for the collection operations, one of [local|majority]. (only MongoDB 3.2 or higher supported) maxStalenessSeconds number optional The max staleness to secondary reads (values under 10 seconds cannot be guaranteed); appname string optional The name of the application that created this MongoClient instance. MongoDB 3.4 and newer will print this value in the server log upon establishing each connection. It is also recorded in the slow query log and profile collections. loggerLevel string optional The logging level (error/warn/info/debug) logger object optional Custom logger object validateOptions object false optional Validate MongoClient passed in options for correctness.
callback	MongoClient~connectCallback	optional The command result callback

Returns:

Promise if no callback passed

Type Definitions

connectCallback(error, db)

lib/mongo_client.js, line 77

The callback format for results

Name	Type	Description
error	MongoError	An error instance representing the error during the execution.
db	Db	The connected database.