Optional ALPNProtocolsAn array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)
Optional appThe 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
Optional authThe auth settings for when connection to server.
Optional authSpecify the authentication mechanism that MongoDB will use to authenticate the connection.
Optional authSpecify properties for the specified authMechanism as a comma-separated list of colon-separated key-value pairs.
Optional authSpecify the database name associated with the user’s credentials.
Optional autoSet to true to make Mongoose automatically call createCollection() on every model created on this connection.
Optional autoOptionally enable in-use auto encryption
Automatic encryption is an enterprise only feature that only applies to operations on a collection. Automatic encryption is not supported for operations on a database or view, and operations that are not bypassed will result in error (see libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption for all operations, set bypassAutoEncryption=true in AutoEncryptionOpts.
Automatic encryption requires the authenticated user to have the listCollections privilege action.
If a MongoClient with a limited connection pool size (i.e a non-zero maxPoolSize) is configured with AutoEncryptionOptions, a separate internal MongoClient is created if any of the following are true:
If an internal MongoClient is created, it is configured with the same options as the parent MongoClient except minPoolSize is set to 0 and AutoEncryptionOptions is omitted.
Optional autoSet to false to disable automatic index creation for all models associated with this connection.
Optional bsonreturn BSON regular expressions as BSONRegExp instances.
false
Optional bufferSet to false to disable buffering on all models associated with this connection.
Optional caOptionally 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.
Optional certCert 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.
Optional checkthe serializer will check if keys are valid.
false
Optional checkVerifies 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.
v0.8.4
Optional ciphersCipher 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.
Optional compressorsAn array or comma-delimited string of compressors to enable network compression for communication between this client and a mongod/mongos instance.
Optional connectThe time in milliseconds to attempt a connection before timing out.
Optional crlPEM formatted CRLs (Certificate Revocation Lists).
Optional dbThe name of the database you want to use. If not provided, Mongoose uses the database name from connection string.
Optional directAllow a driver to force a Single topology type with a connection string containing one host
Optional driverAllows a wrapping driver to amend the client metadata generated by the driver to include information about the wrapping driver
Optional ecdhA 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.
Optional enableEnable utf8 validation when deserializing BSON documents. Defaults to true.
Optional familyOptional fieldsallow to specify if there what fields we wish to return as unserialized raw buffer.
null
Optional forceForce server to assign _id values instead of driver
Optional heartbeatheartbeatFrequencyMS 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.
Optional hintsOptional ignoreserialize will not emit undefined fields
note that the driver sets this to false
true
Optional journalThe journal write concern
Please use the writeConcern option instead
Optional keepTCP Connection keep alive enabled. Will not be able to turn off in the future.
Optional keepThe number of milliseconds to wait before initiating keepAlive on the TCP socket. Will not be configurable in the future.
Optional keyPrivate 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:
Optional loadInstruct the driver it is connecting to a load balancer fronting a mongos like service
Optional localOptional localOptional localThe size (in milliseconds) of the latency window for selecting among multiple suitable MongoDB instances.
Optional lookupOptional maxThe maximum number of connections that may be in the process of being established concurrently by the connection pool.
Optional maxThe maximum number of milliseconds that a connection can remain idle in the pool before being removed and closed.
Optional maxThe maximum number of connections in the connection pool.
Optional maxSpecifies, in seconds, how stale a secondary can be before the client stops using it for read operations.
Optional minDHSizeOptional minSets 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.
Optional minThe minimum number of connections in the connection pool.
Optional monitorEnable command monitoring for this client
Optional noTCP Connection no delay
Optional passpassword for authentication, equivalent to options.auth.password. Maintained for backwards compatibility.
Optional passphraseShared passphrase used for a single private key and/or a PFX.
Optional pfxPFX 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:
Optional pkA primary key factory function for generation of custom _id keys
Optional promotewhen deserializing a Binary will return it as a node.js Buffer instance.
false
Optional promotewhen deserializing a Long will fit it into a Number if it's smaller than 53 bits.
true
Optional promotewhen deserializing will promote BSON values to their Node.js closest equivalent types.
true
Optional proxyConfigures a Socks5 proxy host used for creating TCP connections.
Optional proxyConfigures a Socks5 proxy password when the proxy in proxyHost requires username/password authentication.
Optional proxyConfigures a Socks5 proxy port used for creating TCP connections.
Optional proxyConfigures a Socks5 proxy username when the proxy in proxyHost requires username/password authentication.
Optional rawEnabling the raw option will return a Node.js Buffer which is allocated using allocUnsafe API. See this section from the Node.js Docs here for more detail about what "unsafe" refers to in this context. If you need to maintain your own editable clone of the bytes returned for an extended life time of the process, it is recommended you allocate your own buffer and clone the contents:
const raw = await collection.findOne({}, { raw: true });
const myBuffer = Buffer.alloc(raw.byteLength);
myBuffer.set(raw, 0);
// Only save and use `myBuffer` beyond this point
Please note there is a known limitation where this option cannot be used at the MongoClient level (see NODE-3946).
It does correctly work at Db, Collection, and per operation the same as other BSON options work.
Optional readSpecify a read concern for the collection (only MongoDB 3.2 or higher supported)
Optional readThe level of isolation
Optional readSpecifies the read preferences for this connection
Optional readSpecifies the tags document as a comma-separated list of colon-separated key-value pairs.
Optional rejectIf 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.
true
Optional replicaSpecifies the name of the replica set, if the mongod is a member of a replica set.
Optional retryEnables retryable reads.
Optional retryEnable retryable writes.
Optional secureAn optional TLS context object from tls.createSecureContext()
Optional secureLegacy 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.
Optional serializeserialize the javascript functions
false
Optional serverServer API version
Optional serverSpecifies how long (in milliseconds) to block for server selection before throwing an exception.
Optional servernameOptional sessionAn optional Buffer instance containing a TLS session.
Optional socketThe time in milliseconds to attempt a send or receive on a socket before the attempt times out.
Optional srvThe maximum number of hosts to connect to when using an srv connection string, a setting of 0 means unlimited hosts
Optional srvModifies the srv URI to look like:
_{srvServiceName}._tcp.{hostname}.{domainname}
Querying this DNS URI is expected to respond with SRV records
Optional sslA boolean to enable or disables TLS/SSL for the connection. (The ssl option is equivalent to the tls option.)
Optional sslCASSL Certificate file path.
Will be removed in the next major version. Please use tlsCAFile instead.
Optional sslCRLSSL Certificate revocation list file path.
Will be removed in the next major version. Please use tlsCertificateKeyFile instead.
Optional sslSSL Certificate file path.
Will be removed in the next major version. Please use tlsCertificateKeyFile instead.
Optional sslSSL Key file file path.
Will be removed in the next major version. Please use tlsCertificateKeyFile instead.
Optional sslSSL Certificate pass phrase.
Will be removed in the next major version. Please use tlsCertificateKeyFilePassword instead.
Optional sslValidate mongod server certificate against Certificate Authority
Will be removed in the next major version. Please use tlsAllowInvalidCertificates instead.
Optional tlsEnables or disables TLS/SSL for the connection.
Optional tlsBypasses validation of the certificates presented by the mongod/mongos instance
Optional tlsDisables hostname validation of the certificate presented by the mongod/mongos instance.
Optional tlsCAFileSpecifies 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.
Optional tlsSpecifies the location of a local TLS Certificate
Will be removed in the next major version. Please use tlsCertificateKeyFile instead.
Optional tlsSpecifies 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.
Optional tlsSpecifies the password to de-crypt the tlsCertificateKeyFile.
Optional tlsDisables various certificate validations.
Optional usewhen deserializing a Long return as a BigInt.
false
Optional userusername for authentication, equivalent to options.auth.user. Maintained for backwards compatibility.
Optional wThe write concern w value
Please use the writeConcern option instead
Optional waitThe maximum time in milliseconds that a thread can wait for a connection to become available.
Optional writeA MongoDB WriteConcern, which describes the level of acknowledgement requested from MongoDB for write operations.
Optional wtimeoutMSThe write concern timeout
Please use the writeConcern option instead
Optional zlibAn 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
See
https://www.mongodb.com/docs/manual/reference/connection-string