Node.js Connection Options

Database server port number

Default database to use when establishing the connection

Permit connecting to the database via Unix domain socket or named pipe, if the server allows it

Compress exchanges with database using gzip. This can give you better performance when accessing a database in a different location.

Connection timeout in milliseconds (default changed from 10000 to 1000 in 2.5.6)

Socket timeout in milliseconds after the connection is established

Return result-sets as array, rather than a JSON object. This is a faster way to get results. For more information, see the and query implementations.

permit to indicate server global variable value to ensure efficient batching. default is 4Mb. see

Whether the query should return last insert id from INSERT/UPDATE command as BigInt or Number. default return BigInt

Whether the query should return decimal as Number. If enable, this might return approximate values.

Whether the query should return BigInt data type as Number. If enable, this might return approximate values.

Permit custom logger configuration. For more information, see the documentation.

Define prepare LRU cache length. 0 means no cache

indicate if user wants to retrieve individual batch results (in order to retrieve generated ids). This might change the performance of batching if set, depending on server version: if set, for server 11.5.1 and above, bulk will be use, pipelining if not

Optional private keys in PEM format. Encrypted keys are decrypted with passphrase if provided

Optional shared passphrase used for a single private key and/or a PFX

Optional cert chains in PEM format. One cert chain should be provided per private key

Optionally override the trusted CA certificates. Default is to trust the well-known CAs curated by Mozilla. For self-signed certificates, the certificate is its own CA, and must be provided

Optional cipher suite specification, replacing the default

Attempt to use the server's cipher suite preferences instead of the client's

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, or false to disable ECDH. Set to auto to select the curve automatically

Optional name of an OpenSSL engine which can provide the client certificate

Optional PEM formatted CRLs (Certificate Revocation Lists)

Diffie Hellman parameters, required for Perfect Forward Secrecy

Optional SSL method to use, default is "SSLv23_method"

Logs all exchanges with the server. Displays in hexa.

String length of logged message / error or trace

indicate if parameters must be logged by query logger.

When enabled, the update number corresponds to update rows. When disabled, it indicates the real rows changed.

Allows you to issue several SQL statements in a single quer() call. (That is, INSERT INTO a VALUES('b'); INSERT INTO c VALUES('d');). This may be a security risk as it allows for SQL Injection attacks.

Allows the use of named placeholders.

Allows the use of LOAD DATA INFILE statements. Loading data from a file from the client may be a security issue, as a man-in-the-middle proxy server can change the actual file the server loads. Being able to execute a query on the client gives you access to files on the client.

Forces use of the indicated timezone, rather than the current Node.js timezone. This has to be set when database timezone differ from Node.js timezone. Possible values are (ex: 'America/New_York')

Presents result-sets by table to avoid results with colliding fields. See the query() description for more information.

Sends queries one by one without waiting on the results of the previous entry. For more information, see Pipelining

Adds the stack trace at the time of query creation to the error stack trace, making it easier to identify the part of the code that issued the query. Note: This feature is disabled by default due to the performance cost of stack creation. Only turn it on when you need to debug issues.

Allows you to cast result types.

Sends information, (client name, version, operating system, Node.js version, and so on) to the . When enabled, the Connector sends JSON attributes in addition to the defaults.

Compatibility option causes Promise to return an array object, [rows, metadata] rather than the rows as JSON objects with a meta property.

Compatibility option to permit setting multiple value by a JSON object to replace one question mark. key values will replace the question mark with format like key1=val,key2='val2'. Since it doesn't respect the usual prepared statement format that one value is for one question mark, this can lead to incomprehension, even if badly use to possible injection. this only works using query function (not compatible with batch and execute functions)

Permit to set session variables when connecting. Example: sessionVariables:{'idle_transaction_timeout':10000}

When a connection is established, permit to execute commands before using connection

disabled bulk command in batch

Permit a user with expired password to connect. Only possible operation in this case will be to change password ('SET PASSWORD=PASSWORD('XXX')')

Force server version check by explicitly using SELECT VERSION(), not relying on server initial packet. Since version 2.2.0

Indicate to throw an exception if result-set will not contain some data due to having duplicate identifier. JSON cannot have multiple identical key, so query like SELECT 1 as i, 2 as i cannot result in { i:1, i:2 }, 'i:1' would be skipped. When checkDuplicate is enable (default) driver will throw an error if some data are skipped. Duplication error can be avoided by multiple ways, like using unique aliases or using options rowsAsArray / nestTables for example Since version 2.3.0

Indicate if array are included in parenthesis. This option permit compatibility with version < 2.5

indicate if JSON fields for MariaDB server 10.5.2+ results in JSON format (or String if disabled)

force JSON fields as string (MySQL JSON field or MariaDB server 10.5.2+ results in JSON format). When set, autoJsonMap is forced to false

permit to enable socket keep alive, setting delay. 0 means not enabled. Keep in mind that this don't reset server (use pool option idleTimeout for that). in ms. For mysql2 compatibility, setting enableKeepAlive and keepAliveInitialDelay alias is permitted. i.e. enableKeepAlive=true&keepAliveInitialDelay=1000 corresponds to setting keepAliveDelay=1000 directly

Indicate path/content to MySQL server RSA public key. use requires Node.js v11.6+

Indicate path/content to MySQL server caching RSA public key. use requires Node.js v11.6+

Indicate that if rsaPublicKey or cachingRsaPublicKey public key are not provided, if client can ask server to send public key.

if set, restrict authentication plugin to secure list. Default provided plugins are mysql_native_password, mysql_clear_password, client_ed25519, dialog, sha256_password and caching_sha2_password

(deprecated) DECIMAL/BIGINT data type will be returned as number if in safe integer range, as string if not.

(deprecated) if set with supportBigNumbers DECIMAL/BIGINT data type will be returned as string

permits to set a function with parameter to set stream (since 3.0)

return BIT(1) values as boolean

when used in conjunction of decimalAsNumber, insertIdAsNumber or bigIntAsNumber, if BigInt conversion to number is not exact, connector will throw an error (since 3.0.1)

make resultset meta property enumerable (since 3.0.2)

When LOAD LOCAL command executed, permit to set a callback function of type (filepath?: string) => stream.Readable. Connector will then not send file from LOAD LOCAL, but Readable content. This can permit to set extra validation of file path for example.