@types/mysql

property config

config: ConnectionConfig;

property createQuery

createQuery: QueryFunction;

property query

query: QueryFunction;

property state

state:
    | 'connected'
    | 'authenticated'
    | 'disconnected'
    | 'protocol_error'
    | (string & {});

property threadId

threadId: number | null;

method beginTransaction

beginTransaction: {
    (options?: QueryOptions, callback?: (err: MysqlError) => void): void;
    (callback: (err: MysqlError) => void): void;
};

method changeUser

changeUser: {
    (options: ConnectionOptions, callback?: (err: MysqlError) => void): void;
    (callback: (err: MysqlError) => void): void;
};

method commit

commit: {
    (options?: QueryOptions, callback?: (err: MysqlError) => void): void;
    (callback: (err: MysqlError) => void): void;
};

method connect

connect: {
    (callback?: (err: MysqlError, ...args: any[]) => void): void;
    (options: any, callback?: (err: MysqlError, ...args: any[]) => void): void;
};

method destroy

destroy: () => void;

• Close the connection immediately, without waiting for any queued data (eg queries) to be sent. No further events or callbacks will be triggered.

method end

end: {
    (callback?: (err?: MysqlError) => void): void;
    (options: any, callback: (err?: MysqlError) => void): void;
};

• Close the connection. Any queued data (eg queries) will be sent first. If there are any fatal errors, the connection will be immediately closed.

  Parameter callback

  Handler for any fatal error

method pause

pause: () => void;

• Pause the connection. No more 'result' events will fire until resume() is called.

method ping

ping: {
    (options?: QueryOptions, callback?: (err: MysqlError) => void): void;
    (callback: (err: MysqlError) => void): void;
};

method resume

resume: () => void;

• Resume the connection.

method rollback

rollback: {
    (options?: QueryOptions, callback?: (err: MysqlError) => void): void;
    (callback: (err: MysqlError) => void): void;
};

method statistics

statistics: {
    (options?: QueryOptions, callback?: (err: MysqlError) => void): void;
    (callback: (err: MysqlError) => void): void;
};

property bigNumberStrings

bigNumberStrings?: boolean | undefined;

• 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.

property connectTimeout

connectTimeout?: number | undefined;

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

property dateStrings

dateStrings?: boolean | Array<'TIMESTAMP' | 'DATETIME' | 'DATE'> | undefined;

• 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)

property debug

debug?: boolean | string[] | Types[] | undefined;

• 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)

property flags

flags?: string | string[] | undefined;

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

property host

host?: string | undefined;

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

property insecureAuth

insecureAuth?: boolean | undefined;

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

property localAddress

localAddress?: string | undefined;

• The source IP address to use for TCP connection

property multipleStatements

multipleStatements?: boolean | undefined;

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

property port

port?: number | undefined;

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

property socketPath

socketPath?: string | undefined;

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

property ssl

ssl?:
    | string
    | (tls.SecureContextOptions & { rejectUnauthorized?: boolean | undefined })
    | undefined;

• object with ssl parameters or a string containing name of ssl profile

property stringifyObjects

stringifyObjects?: boolean | undefined;

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

property supportBigNumbers

supportBigNumbers?: boolean | undefined;

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

property timezone

timezone?: string | undefined;

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

property trace

trace?: boolean | undefined;

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

property typeCast

typeCast?: TypeCast | undefined;

• 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

method queryFormat

queryFormat: (query: string, values: any) => string;

• A custom query format function

property charset

charset?: string | undefined;

• 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')

property database

database?: string | undefined;

• Name of the database to use for this connection

property password

password?: string | undefined;

• The password of that MySQL user

property timeout

timeout?: number | undefined;

• Number of milliseconds

property user

user?: string | undefined;

• The MySQL user to authenticate as

method escape

escape: (value: any, stringifyObjects?: boolean, timeZone?: string) => string;

• Escape an untrusted string to be used as a SQL value. Use this on user provided data.

  Parameter value

  Value to escape

  Parameter stringifyObjects

  If true, don't convert objects into SQL lists

  Parameter timeZone

  Convert dates from UTC to the given timezone.

method escapeId

escapeId: (value: string, forbidQualified?: boolean) => string;

• Escape an untrusted string to be used as a SQL identifier (database, table, or column name). Use this on user provided data.

  Parameter value

  Value to escape.

  Parameter forbidQualified

  Don't allow qualified identifiers (eg escape '.')

method format

format: (
    sql: string,
    values?: any[],
    stringifyObjects?: boolean,
    timeZone?: string
) => string;

• Safely format a SQL query containing multiple untrusted values.

  Parameter sql

  Query, with insertion points specified with ? (for values) or ?? (for identifiers)

  Parameter values

  Array of objects to insert.

  Parameter stringifyObjects

  If true, don't convert objects into SQL lists

  Parameter timeZone

  Convert dates from UTC to the given timezone.

property type

type: Types;

property x

x: number;

property y

y: number;

property code

code: string;

• Either a MySQL server error (e.g. 'ER_ACCESS_DENIED_ERROR'), a node.js error (e.g. 'ECONNREFUSED') or an internal error (e.g. 'PROTOCOL_CONNECTION_LOST').

property errno

errno: number;

• The error number for the error code

property fatal

fatal: boolean;

• Boolean, indicating if this error is terminal to the connection object.

property fieldCount

fieldCount?: number | undefined;

• The field count

property sql

sql?: string | undefined;

• SQL of failed query

property sqlMessage

sqlMessage?: string | undefined;

• Error message from MySQL

property sqlState

sqlState?: string | undefined;

• The sql state

property sqlStateMarker

sqlStateMarker?: string | undefined;

• The sql state marker

property affectedRows

affectedRows: number;

• The number of affected rows from an insert, update, or delete statement.

property changedRows

changedRows: number;

• The number of changed rows from an update statement. "changedRows" differs from "affectedRows" in that it does not count updated rows whose values were not changed.

property fieldCount

fieldCount: number;

property insertId

insertId: number;

• The insert id after inserting a row into a table with an auto increment primary key.

property message

message: string;

• The server result message from an insert, update, or delete statement.

property protocol41

protocol41: boolean;

property serverStatus

serverStatus?: number | undefined;

property warningCount

warningCount?: number | undefined;

property config

config: PoolActualConfig;

property query

query: QueryFunction;

method acquireConnection

acquireConnection: (
    connection: PoolConnection,
    callback: (err: MysqlError, connection: PoolConnection) => void
) => void;

method end

end: (callback?: (err: MysqlError) => void) => void;

• Close the connection. Any queued data (eg queries) will be sent first. If there are any fatal errors, the connection will be immediately closed.

  Parameter callback

  Handler for any fatal error

method getConnection

getConnection: (
    callback: (err: MysqlError, connection: PoolConnection) => void
) => void;

property connectionConfig

connectionConfig: ConnectionConfig;

property config

config: PoolClusterConfig;

method add

add: { (config: PoolConfig): void; (id: string, config: PoolConfig): void };

method end

end: (callback?: (err: MysqlError) => void) => void;

• Close the connection. Any queued data (eg queries) will be sent first. If there are any fatal errors, the connection will be immediately closed.

  Parameter callback

  Handler for any fatal error

method getConnection

getConnection: {
    (callback: (err: MysqlError, connection: PoolConnection) => void): void;
    (
        pattern: string,
        callback: (err: MysqlError, connection: PoolConnection) => void
    ): void;
    (
        pattern: string,
        selector: string,
        callback: (err: MysqlError, connection: PoolConnection) => void
    ): void;
};

method of

of: {
    (pattern: string, selector?: string): Pool;
    (pattern: false, selector: string): Pool;
};

method remove

remove: (pattern: string) => void;

• remove all pools which match pattern

property canRetry

canRetry?: boolean | undefined;

• If true, PoolCluster will attempt to reconnect when connection fails. (Default: true)

property defaultSelector

defaultSelector?: string | undefined;

• The default selector. (Default: RR) RR: Select one alternately. (Round-Robin) RANDOM: Select the node by random function. ORDER: Select the first node available unconditionally.

property removeNodeErrorCount

removeNodeErrorCount?: number | undefined;

• If connection fails, node's errorCount increases. When errorCount is greater than removeNodeErrorCount, remove a node in the PoolCluster. (Default: 5)

property restoreNodeTimeout

restoreNodeTimeout?: number | undefined;

• If connection fails, specifies the number of milliseconds before another connection attempt will be made. If set to 0, then node will be removed instead and never re-used. (Default: 0)

method destroy

destroy: () => void;

• Close the connection immediately, without waiting for any queued data (eg queries) to be sent. No further events or callbacks will be triggered.

method end

end: () => void;

• Close the connection. Any queued data (eg queries) will be sent first. If there are any fatal errors, the connection will be immediately closed.

  Parameter callback

  Handler for any fatal error

method release

release: () => void;

property acquireTimeout

acquireTimeout?: number | undefined;

• The milliseconds before a timeout occurs during the connection acquisition. This is slightly different from connectTimeout, because acquiring a pool connection does not always involve making a connection. (Default: 10 seconds)

property connectionLimit

connectionLimit?: number | undefined;

• The maximum number of connections to create at once. (Default: 10)

property queueLimit

queueLimit?: number | undefined;

• The maximum number of connection requests the pool will queue before returning an error from getConnection. If set to 0, there is no limit to the number of queued connection requests. (Default: 0)

property waitForConnections

waitForConnections?: boolean | undefined;

• Determines the pool's action when no connections are available and the limit has been reached. If true, the pool will queue the connection request and call it when one becomes available. If false, the pool will immediately call back with an error. (Default: true)

property EofPacket

EofPacket: packetCallback;

property ErrorPacket

ErrorPacket: packetCallback;

property FieldPacket

FieldPacket: packetCallback;

property nestedTables

nestedTables: boolean;

• Default false

property OkPacket

OkPacket: packetCallback;

property ResultSetHeaderPacket

ResultSetHeaderPacket: packetCallback;

property sql

sql: string;

• Template query

property typeCast

typeCast?: TypeCast | undefined;

• Default true

property values

values?: string[] | undefined;

• Values for template query

method determinePacket

determinePacket: (byte: number, parser: any) => any;

• Determines the packet class to use given the first byte of the packet.

  Parameter byte

  The first byte of the packet

  Parameter parser

  The packet parser

method on

on: {
    (ev: string, callback: (...args: any[]) => void): Query;
    (ev: 'result', callback: (row: any, index: number) => void): Query;
    (ev: 'error', callback: (err: MysqlError) => void): Query;
    (
        ev: 'fields',
        callback: (fields: FieldInfo[], index: number) => void
    ): Query;
    (ev: 'packet', callback: (packet: any) => void): Query;
    (ev: 'end', callback: () => void): Query;
};

method RowDataPacket

RowDataPacket: (packet: any, parser: any, connection: Connection) => void;

method start

start: () => void;

• Emits a query packet to start the query

method stream

stream: (options?: stream.ReadableOptions) => stream.Readable;

• Creates a Readable stream with the given options

  Parameter options

  The options for the stream. (see readable-stream package)

call signature

(query: Query): Query;

call signature

(options: string | QueryOptions, callback?: queryCallback): Query;

call signature

(options: string | QueryOptions, values: any, callback?: queryCallback): Query;

property nestTables

nestTables?: any;

• Either a boolean or string. If true, tables will be nested objects. If string (e.g. '_'), tables will be nested as tableName_fieldName

property sql

sql: string;

• The SQL for the query

property timeout

timeout?: number | undefined;

• Every operation takes an optional inactivity timeout option. This allows you to specify appropriate timeouts for operations. It is important to note that these timeouts are not part of the MySQL protocol, and rather timeout operations through the client. This means that when a timeout is reached, the connection it occurred on will be destroyed and no further operations can be performed.

property typeCast

typeCast?: TypeCast | undefined;

• 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

property values

values?: any;

• Values for template query

property catalog

catalog: string;

property charsetNr

charsetNr: number;

property db

db: string;

property decimals

decimals: number;

property default

default?: string | undefined;

property flags

flags: number;

property length

length: number;

property name

name: string;

property orgName

orgName: string;

property orgTable

orgTable: string;

property protocol41

protocol41: boolean;

property table

table: string;

property zeroFill

zeroFill: boolean;

member BIT

BIT = 0x10

member BLOB

BLOB = 0xfc

member DATE

DATE = 0x0a

member DATETIME

DATETIME = 0x0c

member DATETIME2

DATETIME2 = 0x12

member DECIMAL

DECIMAL = 0x00

member DOUBLE

DOUBLE = 0x05

member ENUM

ENUM = 0xf7

member FLOAT

FLOAT = 0x04

member GEOMETRY

GEOMETRY = 0xff

member INT24

INT24 = 0x09

member JSON

JSON = 0xf5

member LONG

LONG = 0x03

member LONG_BLOB

LONG_BLOB = 0xfb

member LONGLONG

LONGLONG = 0x08

member MEDIUM_BLOB

MEDIUM_BLOB = 0xfa

member NEWDATE

NEWDATE = 0x0e

member NEWDECIMAL

NEWDECIMAL = 0xf6

member NULL

NULL = 0x06

member SET

SET = 0xf8

member SHORT

SHORT = 0x02

member STRING

STRING = 0xfe

member TIME

TIME = 0x0b

member TIME2

TIME2 = 0x13

member TIMESTAMP

TIMESTAMP = 0x07

member TIMESTAMP2

TIMESTAMP2 = 0x11

member TINY

TINY = 0x01

member TINY_BLOB

TINY_BLOB = 0xf9

member VAR_STRING

VAR_STRING = 0xfd

member VARCHAR

VARCHAR = 0x0f

member YEAR

YEAR = 0x0d