The MySQL user to authenticate as

The password of that MySQL user

Alias for the MySQL user password. Makes a bit more sense in a multifactor authentication setup (see "password2" and "password3")

2nd factor authentication password. Mandatory when the authentication policy for the MySQL user account requires an additional authentication method that needs a password. https://dev.mysql.com/doc/refman/8.0/en/multifactor-authentication.html

3rd factor authentication password. Mandatory when the authentication policy for the MySQL user account requires two additional authentication methods and the last one needs a password. https://dev.mysql.com/doc/refman/8.0/en/multifactor-authentication.html

Name of the database to use for this connection

The charset for the connection. This is called 'collation' in the SQL-level of MySQL (like utf8_general_ci). If a SQL-level charset is specified (like utf8mb4) then the default collation for that charset is used. (Default: 'UTF8_GENERAL_CI')

The hostname of the database you are connecting to. (Default: localhost)

The port number to connect to. (Default: 3306)

The source IP address to use for TCP connection

The path to a unix domain socket to connect to. When used host and port are ignored

The timezone used to store local dates. (Default: 'local')

The milliseconds before a timeout occurs during the initial connection to the MySQL server. (Default: 10 seconds)

Stringify objects instead of converting to values. (Default: 'false')

Allow connecting to MySQL instances that ask for the old (insecure) authentication method. (Default: false)

Determines if column values should be converted to native JavaScript types. It is not recommended (and may go away / change in the future) to disable type casting, but you can currently do so on either the connection or query level. (Default: true)

You can also specify a function (field: any, next: () => void) => {} to do the type casting yourself.

WARNING: YOU MUST INVOKE the parser using one of these three field functions in your custom typeCast callback. They can only be called once.

field.string() field.buffer() field.geometry()

are aliases for

parser.parseLengthCodedString() parser.parseLengthCodedBuffer() parser.parseGeometryValue()

You can find which field function you need to use by looking at: RowDataPacket.prototype._typeCast

A custom query format function

When dealing with big numbers (BIGINT and DECIMAL columns) in the database, you should enable this option (Default: false)

Enabling both supportBigNumbers and bigNumberStrings forces big numbers (BIGINT and DECIMAL columns) to be always returned as JavaScript String objects (Default: false). Enabling supportBigNumbers but leaving bigNumberStrings disabled will return big numbers as String objects only when they cannot be accurately represented with [JavaScript Number objects] (http://ecma262-5.com/ELS5_HTML.htm#Section_8.5) (which happens when they exceed the [-2^{53, +2}53] range), otherwise they will be returned as Number objects. This option is ignored if supportBigNumbers is disabled.

Force date types (TIMESTAMP, DATETIME, DATE) to be returned as strings rather then inflated into JavaScript Date objects. Can be true/false or an array of type names to keep as strings.

(Default: false)

This will print all incoming and outgoing packets on stdout. You can also restrict debugging to packet types by passing an array of types (strings) to debug;

(Default: false)

Generates stack traces on Error to include call site of library entrance ('long stack traces'). Slight performance penalty for most calls. (Default: true)

Allow multiple mysql statements per query. Be careful with this, it exposes you to SQL injection attacks. (Default: false)

List of connection flags to use other than the default ones. It is also possible to blacklist default ones

Return each row as an array, not as an object. This is useful when you have duplicate column names. This can also be set in the QueryOption object to be applied per-query.