An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)
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
The auth settings for when connection to server.
Specify the authentication mechanism that MongoDB will use to authenticate the connection.
Specify properties for the specified authMechanism as a comma-separated list of colon-separated key-value pairs.
Specify the database name associated with the user’s credentials.
Optionally enable client side auto encryption
return BSON regular expressions as BSONRegExp instances.
Optionally override the trusted CA certificates. Default is to trust the well-known CAs curated by Mozilla. Mozilla's CAs are completely replaced when CAs are explicitly specified using this option.
Cert chains in PEM format. One cert chain should be provided per private key. Each cert chain should consist of the PEM formatted certificate for a provided private key, followed by the PEM formatted intermediate certificates (if any), in order, and not including the root CA (the root CA must be pre-known to the peer, see ca). When providing multiple cert chains, they do not have to be in the same order as their private keys in key. If the intermediate certificates are not provided, the peer will not be able to validate the certificate, and the handshake will fail.
the serializer will check if keys are valid.
Verifies the certificate cert is issued to hostname.
Returns Error object, populating it with reason, host, and cert on
failure. On success, returns undefined.
This function can be overwritten by providing alternative function as part of
the options.checkServerIdentity option passed to tls.connect(). The
overwriting function can call tls.checkServerIdentity() of course, to augment
the checks done with additional verification.
This function is only called if the certificate passed all other checks, such as
being issued by trusted CA (options.ca).
The host name or IP address to verify the certificate against.
A certificate object representing the peer's certificate.
Cipher suite specification, replacing the default. For more information, see modifying the default cipher suite. Permitted ciphers can be obtained via tls.getCiphers(). Cipher names must be uppercased in order for OpenSSL to accept them.
An array or comma-delimited string of compressors to enable network compression for communication between this client and a mongod/mongos instance.
The time in milliseconds to attempt a connection before timing out.
PEM formatted CRLs (Certificate Revocation Lists).
Allow a driver to force a Single topology type with a connection string containing one host
Allows a wrapping driver to amend the client metadata generated by the driver to include information about the wrapping driver
A string describing a named curve or a colon separated list of curve NIDs or names, for example P-521:P-384:P-256, to use for ECDH key agreement. Set to auto to select the curve automatically. Use crypto.getCurves() to obtain a list of available curve names. On recent releases, openssl ecparam -list_curves will also display the name and description of each available elliptic curve. Default: tls.DEFAULT_ECDH_CURVE.
Enable utf8 validation when deserializing BSON documents. Defaults to true.
allow to specify if there what fields we wish to return as unserialized raw buffer.
Force server to assign _id values instead of driver
heartbeatFrequencyMS controls when the driver checks the state of the MongoDB deployment. Specify the interval (in milliseconds) between checks, counted from the end of the previous check until the beginning of the next one.
serialize will not emit undefined fields (default:true)
The journal write concern
TCP Connection keep alive enabled
The number of milliseconds to wait before initiating keepAlive on the TCP socket
Private keys in PEM format. PEM allows the option of private keys
being encrypted. Encrypted keys will be decrypted with
options.passphrase. Multiple keys using different algorithms can be
provided either as an array of unencrypted key strings or buffers,
or an array of objects in the form {pem: <string|buffer>[,
passphrase:
Instruct the driver it is connecting to a load balancer fronting a mongos like service
The size (in milliseconds) of the latency window for selecting among multiple suitable MongoDB instances.
Custom logger object
The logging level
The maximum number of milliseconds that a connection can remain idle in the pool before being removed and closed.
The maximum number of connections in the connection pool.
Specifies, in seconds, how stale a secondary can be before the client stops using it for read operations.
Sets the minimum heartbeat frequency. In the event that the driver has to frequently re-check a server's availability, it will wait at least this long since the previous check to avoid wasted effort.
The minimum number of connections in the connection pool.
Enable command monitoring for this client
TCP Connection no delay
Shared passphrase used for a single private key and/or a PFX.
PFX or PKCS12 encoded private key and certificate chain. pfx is an
alternative to providing key and cert individually. PFX is usually
encrypted, if it is, passphrase will be used to decrypt it. Multiple
PFX can be provided either as an array of unencrypted PFX buffers,
or an array of objects in the form {buf: <string|buffer>[,
passphrase:
A primary key factory function for generation of custom _id keys
A Promise library class the application wishes to use such as Bluebird, must be ES6 compatible
when deserializing a Binary will return it as a node.js Buffer instance.
when deserializing a Long will fit it into a Number if it's smaller than 53 bits
when deserializing will promote BSON values to their Node.js closest equivalent types.
Configures a Socks5 proxy host used for creating TCP connections.
Configures a Socks5 proxy password when the proxy in proxyHost requires username/password authentication.
Configures a Socks5 proxy port used for creating TCP connections.
Configures a Socks5 proxy username when the proxy in proxyHost requires username/password authentication.
Return document results as raw BSON buffers
Specify a read concern for the collection (only MongoDB 3.2 or higher supported)
The level of isolation
Specifies the read preferences for this connection
Specifies the tags document as a comma-separated list of colon-separated key-value pairs.
If true the server will reject any connection which is not authorized with the list of supplied CAs. This option only has an effect if requestCert is true.
Specifies the name of the replica set, if the mongod is a member of a replica set.
Enables retryable reads.
Enable retryable writes.
An optional TLS context object from tls.createSecureContext()
Legacy mechanism to select the TLS protocol version to use, it does not support independent control of the minimum and maximum version, and does not support limiting the protocol to TLSv1.3. Use minVersion and maxVersion instead. The possible values are listed as SSL_METHODS, use the function names as strings. For example, use 'TLSv1_1_method' to force TLS version 1.1, or 'TLS_method' to allow any TLS protocol version up to TLSv1.3. It is not recommended to use TLS versions less than 1.2, but it may be required for interoperability. Default: none, see minVersion.
serialize the javascript functions (default:false).
Server API version
Specifies how long (in milliseconds) to block for server selection before throwing an exception.
The time in milliseconds to attempt a send or receive on a socket before the attempt times out.
The maximum number of hosts to connect to when using an srv connection string, a setting of 0 means unlimited hosts
Modifies the srv URI to look like:
_{srvServiceName}._tcp.{hostname}.{domainname}
Querying this DNS URI is expected to respond with SRV records
A boolean to enable or disables TLS/SSL for the connection. (The ssl option is equivalent to the tls option.)
SSL Certificate file path.
SSL Certificate revocation list file path.
SSL Certificate file path.
SSL Key file file path.
SSL Certificate pass phrase.
Validate mongod server certificate against Certificate Authority
Enables or disables TLS/SSL for the connection.
Bypasses validation of the certificates presented by the mongod/mongos instance
Disables hostname validation of the certificate presented by the mongod/mongos instance.
Specifies the location of a local .pem file that contains the root certificate chain from the Certificate Authority. This file is used to validate the certificate presented by the mongod/mongos instance.
Specifies the location of a local TLS Certificate
Specifies the location of a local .pem file that contains either the client's TLS/SSL certificate and key or only the client's TLS/SSL key when tlsCertificateFile is used to provide the certificate.
Specifies the password to de-crypt the tlsCertificateKeyFile.
Disables various certificate validations.
The write concern w value
The maximum time in milliseconds that a thread can wait for a connection to become available.
The write concern timeout
An integer that specifies the compression level if using zlib for network compression.
Generated using TypeDoc
Describes all possible URI query options for the mongo client
https://www.mongodb.com/docs/manual/reference/connection-string