Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

arrayParenthesis?: boolean

Indicate if an array is included in parentheses. This option permits compatibility with the connector version < 2.5

autoJsonMap?: boolean

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

bigIntAsNumber?: boolean

Force returning BIGINT data as Number in place of BigInt.

Default: false;

bigNumberStrings?: boolean
deprecated

when used with supportBigNumbers, big numbers (BIGINT and DECIMAL columns) will always result as string even if in safe number range. now replaced by decimalAsNumber, bigIntAsNumber and checkNumberRange options

bulk?: boolean

disabled bulk command in batch.

checkDuplicate?: boolean

indicate to throw an exception if a result-set does not contain some data due to having duplicate identifier (Default: true)

checkNumberRange?: boolean

Throw if conversion to Number is not safe.

Default: false;

dateStrings?: boolean

Whether to retrieve dates as strings or as Date objects.

decimalAsNumber?: boolean

force returning decimal values as Number in place of String

Default: false;

forceVersionCheck?: boolean

Force server version check by explicitly using SELECT VERSION(), not relying on server initial handshake information

insertIdAsNumber?: boolean

force returning insertId as Number in place of BigInt

logger?: LoggerConfig

Configure logger

metaAsArray?: boolean

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

namedPlaceholders?: boolean

Allows the use of named placeholders.

nestTables?: string | boolean

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

permitLocalInfile?: boolean

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. (Default: false)

permitSetMultiParamEntries?: boolean

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 you badly use to possible injection.

pipelining?: boolean

Sends queries one by one without waiting on the results of the previous entry. (Default: true)

rowsAsArray?: boolean

Return result-sets as array, rather than a JSON object. This is a faster way to get results

supportBigNumbers?: boolean
deprecated

big numbers (BIGINT and DECIMAL columns) will result as string when not in safe number range. now replaced by decimalAsNumber, bigIntAsNumber and checkNumberRange options

timeout?: number

Allows timeout for command execution.

timezone?: string

Forces use of the indicated timezone, rather than the current Node.js timezone. Possible values are Z for UTC, local or ±HH:MM format

typeCast?: TypeCastFunction

Allows casting result types.

Methods

  • infileStreamFactory(filepath: string): Readable
  • Permit to defined function calling for LOAD LOCAL command, for extra verification like path restriction.

    Parameters

    • filepath: string

    Returns Readable

Generated using TypeDoc