Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MongoClientOptions

Describes all possible URI query options for the mongo client

see

https://www.mongodb.com/docs/manual/reference/connection-string

Hierarchy

Index

Properties

Properties

Optional ALPNProtocols

ALPNProtocols?: string[] | Uint8Array | Uint8Array[]

An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)

Optional appName

appName?: string

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

Optional auth

auth?: Auth

The auth settings for when connection to server.

Optional authMechanism

authMechanism?: AuthMechanism

Specify the authentication mechanism that MongoDB will use to authenticate the connection.

Optional authMechanismProperties

authMechanismProperties?: AuthMechanismProperties

Specify properties for the specified authMechanism as a comma-separated list of colon-separated key-value pairs.

Optional authSource

authSource?: string

Specify the database name associated with the user’s credentials.

Optional autoEncryption

autoEncryption?: AutoEncryptionOptions

Optionally enable in-use auto encryption

remarks

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:

  • AutoEncryptionOptions.keyVaultClient is not passed.
  • AutoEncryptionOptions.bypassAutomaticEncryption is false.

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 bsonRegExp

bsonRegExp?: boolean

return BSON regular expressions as BSONRegExp instances.

defaultvalue

false

Optional ca

ca?: string | Buffer | (string | Buffer)[]

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.

Optional cert

cert?: string | Buffer | (string | Buffer)[]

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.

Optional checkKeys

checkKeys?: boolean

the serializer will check if keys are valid.

defaultvalue

false

Optional checkServerIdentity

checkServerIdentity?: (hostname: string, cert: PeerCertificate) => Error | undefined

Type declaration

    • (hostname: string, cert: PeerCertificate): Error | undefined

    • 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 is intended to be used in combination with thecheckServerIdentity option that can be passed to connect and as such operates on a certificate object. For other purposes, consider using x509.checkHost() instead.

      This function can be overwritten by providing an alternative function as theoptions.checkServerIdentity option that is 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).

      Earlier versions of Node.js incorrectly accepted certificates for a givenhostname if a matching uniformResourceIdentifier subject alternative name was present (see CVE-2021-44531). Applications that wish to acceptuniformResourceIdentifier subject alternative names can use a customoptions.checkServerIdentity function that implements the desired behavior.

      since

      v0.8.4

      Parameters

      • hostname: string

        The host name or IP address to verify the certificate against.

      • cert: PeerCertificate

        A certificate object representing the peer's certificate.

      Returns Error | undefined

Optional ciphers

ciphers?: string

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.

Optional compressors

compressors?: string | ("none" | "snappy" | "zlib" | "zstd")[]

An array or comma-delimited string of compressors to enable network compression for communication between this client and a mongod/mongos instance.

Optional connectTimeoutMS

connectTimeoutMS?: number

The time in milliseconds to attempt a connection before timing out.

Optional crl

crl?: string | Buffer | (string | Buffer)[]

PEM formatted CRLs (Certificate Revocation Lists).

Optional directConnection

directConnection?: boolean

Allow a driver to force a Single topology type with a connection string containing one host

Optional driverInfo

driverInfo?: DriverInfo

Allows a wrapping driver to amend the client metadata generated by the driver to include information about the wrapping driver

Optional ecdhCurve

ecdhCurve?: string

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.

Optional enableUtf8Validation

enableUtf8Validation?: boolean

Enable utf8 validation when deserializing BSON documents. Defaults to true.

Optional family

family?: number

Optional fieldsAsRaw

fieldsAsRaw?: Document

allow to specify if there what fields we wish to return as unserialized raw buffer.

defaultvalue

null

Optional forceServerObjectId

forceServerObjectId?: boolean

Force server to assign _id values instead of driver

Optional heartbeatFrequencyMS

heartbeatFrequencyMS?: number

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.

Optional hints

hints?: number

Optional ignoreUndefined

ignoreUndefined?: boolean

serialize will not emit undefined fields note that the driver sets this to false

defaultvalue

true

Optional journal

journal?: boolean

The journal write concern

deprecated

Please use the writeConcern option instead

Optional keepAlive

keepAlive?: boolean
deprecated

TCP Connection keep alive enabled. Will not be able to turn off in the future.

Optional keepAliveInitialDelay

keepAliveInitialDelay?: number
deprecated

The number of milliseconds to wait before initiating keepAlive on the TCP socket. Will not be configurable in the future.

Optional key

key?: string | Buffer | (string | Buffer | KeyObject)[]

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: ]}. The object form can only occur in an array. object.passphrase is optional. Encrypted keys will be decrypted with object.passphrase if provided, or options.passphrase if it is not.

Optional loadBalanced

loadBalanced?: boolean

Instruct the driver it is connecting to a load balancer fronting a mongos like service

Optional localAddress

localAddress?: string

Optional localPort

localPort?: number

Optional localThresholdMS

localThresholdMS?: number

The size (in milliseconds) of the latency window for selecting among multiple suitable MongoDB instances.

Optional lookup

lookup?: LookupFunction

Optional maxConnecting

maxConnecting?: number

The maximum number of connections that may be in the process of being established concurrently by the connection pool.

Optional maxIdleTimeMS

maxIdleTimeMS?: number

The maximum number of milliseconds that a connection can remain idle in the pool before being removed and closed.

Optional maxPoolSize

maxPoolSize?: number

The maximum number of connections in the connection pool.

Optional maxStalenessSeconds

maxStalenessSeconds?: number

Specifies, in seconds, how stale a secondary can be before the client stops using it for read operations.

Optional minDHSize

minDHSize?: number

Optional minHeartbeatFrequencyMS

minHeartbeatFrequencyMS?: number

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.

Optional minPoolSize

minPoolSize?: number

The minimum number of connections in the connection pool.

Optional monitorCommands

monitorCommands?: boolean

Enable command monitoring for this client

Optional noDelay

noDelay?: boolean

TCP Connection no delay

Optional passphrase

passphrase?: string

Shared passphrase used for a single private key and/or a PFX.

Optional pfx

pfx?: string | Buffer | (string | Buffer | PxfObject)[]

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: ]}. The object form can only occur in an array. object.passphrase is optional. Encrypted PFX will be decrypted with object.passphrase if provided, or options.passphrase if it is not.

Optional pkFactory

pkFactory?: PkFactory

A primary key factory function for generation of custom _id keys

Optional promoteBuffers

promoteBuffers?: boolean

when deserializing a Binary will return it as a node.js Buffer instance.

defaultvalue

false

Optional promoteLongs

promoteLongs?: boolean

when deserializing a Long will fit it into a Number if it's smaller than 53 bits.

defaultvalue

true

Optional promoteValues

promoteValues?: boolean

when deserializing will promote BSON values to their Node.js closest equivalent types.

defaultvalue

true

Optional proxyHost

proxyHost?: string

Configures a Socks5 proxy host used for creating TCP connections.

Optional proxyPassword

proxyPassword?: string

Configures a Socks5 proxy password when the proxy in proxyHost requires username/password authentication.

Optional proxyPort

proxyPort?: number

Configures a Socks5 proxy port used for creating TCP connections.

Optional proxyUsername

proxyUsername?: string

Configures a Socks5 proxy username when the proxy in proxyHost requires username/password authentication.

Optional raw

raw?: boolean

Enabling 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:

example
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
remarks

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 readConcern

readConcern?: ReadConcernLike

Specify a read concern for the collection (only MongoDB 3.2 or higher supported)

Optional readConcernLevel

readConcernLevel?: ReadConcernLevel

The level of isolation

Optional readPreference

readPreference?: ReadPreference | ReadPreferenceMode

Specifies the read preferences for this connection

Optional readPreferenceTags

readPreferenceTags?: TagSet[]

Specifies the tags document as a comma-separated list of colon-separated key-value pairs.

Optional rejectUnauthorized

rejectUnauthorized?: boolean

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.

default

true

Optional replicaSet

replicaSet?: string

Specifies the name of the replica set, if the mongod is a member of a replica set.

Optional retryReads

retryReads?: boolean

Enables retryable reads.

Optional retryWrites

retryWrites?: boolean

Enable retryable writes.

Optional secureContext

secureContext?: SecureContext

An optional TLS context object from tls.createSecureContext()

Optional secureProtocol

secureProtocol?: string

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.

Optional serializeFunctions

serializeFunctions?: boolean

serialize the javascript functions

defaultvalue

false

Optional serverApi

serverApi?: "1" | ServerApi

Server API version

Optional serverSelectionTimeoutMS

serverSelectionTimeoutMS?: number

Specifies how long (in milliseconds) to block for server selection before throwing an exception.

Optional servername

servername?: string

Optional session

session?: Buffer

Optional socketTimeoutMS

socketTimeoutMS?: number

The time in milliseconds to attempt a send or receive on a socket before the attempt times out.

Optional srvMaxHosts

srvMaxHosts?: number

The maximum number of hosts to connect to when using an srv connection string, a setting of 0 means unlimited hosts

Optional srvServiceName

srvServiceName?: string

Modifies the srv URI to look like:

_{srvServiceName}._tcp.{hostname}.{domainname}

Querying this DNS URI is expected to respond with SRV records

Optional ssl

ssl?: boolean

A boolean to enable or disables TLS/SSL for the connection. (The ssl option is equivalent to the tls option.)

Optional sslCA

sslCA?: string

SSL Certificate file path.

Optional sslCRL

sslCRL?: string

SSL Certificate revocation list file path.

Optional sslCert

sslCert?: string

SSL Certificate file path.

Optional sslKey

sslKey?: string

SSL Key file file path.

Optional sslPass

sslPass?: string

SSL Certificate pass phrase.

Optional sslValidate

sslValidate?: boolean

Validate mongod server certificate against Certificate Authority

Optional tls

tls?: boolean

Enables or disables TLS/SSL for the connection.

Optional tlsAllowInvalidCertificates

tlsAllowInvalidCertificates?: boolean

Bypasses validation of the certificates presented by the mongod/mongos instance

Optional tlsAllowInvalidHostnames

tlsAllowInvalidHostnames?: boolean

Disables hostname validation of the certificate presented by the mongod/mongos instance.

Optional tlsCAFile

tlsCAFile?: string

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.

Optional tlsCertificateFile

tlsCertificateFile?: string

Specifies the location of a local TLS Certificate

Optional tlsCertificateKeyFile

tlsCertificateKeyFile?: string

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.

Optional tlsCertificateKeyFilePassword

tlsCertificateKeyFilePassword?: string

Specifies the password to de-crypt the tlsCertificateKeyFile.

Optional tlsInsecure

tlsInsecure?: boolean

Disables various certificate validations.

Optional useBigInt64

useBigInt64?: boolean

when deserializing a Long return as a BigInt.

defaultvalue

false

Optional w

w?: W

The write concern w value

deprecated

Please use the writeConcern option instead

Optional waitQueueTimeoutMS

waitQueueTimeoutMS?: number

The maximum time in milliseconds that a thread can wait for a connection to become available.

Optional writeConcern

writeConcern?: WriteConcern | WriteConcernSettings

A MongoDB WriteConcern, which describes the level of acknowledgement requested from MongoDB for write operations.

see

https://www.mongodb.com/docs/manual/reference/write-concern/

Optional wtimeoutMS

wtimeoutMS?: number

The write concern timeout

deprecated

Please use the writeConcern option instead

Optional zlibCompressionLevel

zlibCompressionLevel?: 0 | 3 | 9 | 4 | 1 | 2 | 5 | 6 | 7 | 8

An integer that specifies the compression level if using zlib for network compression.

Generated using TypeDoc