Skip to main content
Version: 4.5

Interface: MySql2ConnectionConfig#

knex.Knex.MySql2ConnectionConfig

Hierarchy#

Properties#

authPlugins#

Optional authPlugins: object

Type declaration:#

Defined in: node_modules/knex/types/index.d.ts:2014


authSwitchHandler#

Optional authSwitchHandler: (data: any, callback: () => void) => any

Type declaration:#

▸ (data: any, callback: () => void): any

Parameters:#

NameType
dataany
callback() => void

Returns: any

Defined in: node_modules/knex/types/index.d.ts:2015

Defined in: node_modules/knex/types/index.d.ts:2015


bigNumberStrings#

Optional bigNumberStrings: boolean

Inherited from: MySqlConnectionConfig.bigNumberStrings

Defined in: node_modules/knex/types/index.d.ts:2000


charset#

Optional charset: string

Inherited from: MySqlConnectionConfig.charset

Defined in: node_modules/knex/types/index.d.ts:1992


charsetNumber#

Optional charsetNumber: number

Defined in: node_modules/knex/types/index.d.ts:2016


compress#

Optional compress: boolean

Defined in: node_modules/knex/types/index.d.ts:2017


connectAttributes#

Optional connectAttributes: object

Type declaration:#

Defined in: node_modules/knex/types/index.d.ts:2018


connectTimeout#

Optional connectTimeout: number

Inherited from: MySqlConnectionConfig.connectTimeout

Defined in: node_modules/knex/types/index.d.ts:1994


database#

Optional database: string

Inherited from: MySqlConnectionConfig.database

Defined in: node_modules/knex/types/index.d.ts:1991


dateStrings#

Optional dateStrings: boolean

Inherited from: MySqlConnectionConfig.dateStrings

Defined in: node_modules/knex/types/index.d.ts:2001


debug#

Optional debug: boolean

Inherited from: MySqlConnectionConfig.debug

Defined in: node_modules/knex/types/index.d.ts:2002


decimalNumbers#

Optional decimalNumbers: boolean

Inherited from: MySqlConnectionConfig.decimalNumbers

Defined in: node_modules/knex/types/index.d.ts:2007


enableKeepAlive#

Optional enableKeepAlive: boolean

Defined in: node_modules/knex/types/index.d.ts:2019


flags#

Optional flags: string

Inherited from: MySqlConnectionConfig.flags

Defined in: node_modules/knex/types/index.d.ts:2005


host#

Optional host: string

Inherited from: MySqlConnectionConfig.host

Defined in: node_modules/knex/types/index.d.ts:1985


insecureAuth#

Optional insecureAuth: boolean

Inherited from: MySqlConnectionConfig.insecureAuth

Defined in: node_modules/knex/types/index.d.ts:1996


keepAliveInitialDelay#

Optional keepAliveInitialDelay: number

Defined in: node_modules/knex/types/index.d.ts:2020


localAddress#

Optional localAddress: string

Inherited from: MySqlConnectionConfig.localAddress

Defined in: node_modules/knex/types/index.d.ts:1987


maxPreparedStatements#

Optional maxPreparedStatements: number

Defined in: node_modules/knex/types/index.d.ts:2021


multipleStatements#

Optional multipleStatements: boolean

Inherited from: MySqlConnectionConfig.multipleStatements

Defined in: node_modules/knex/types/index.d.ts:2004


namedPlaceholders#

Optional namedPlaceholders: boolean

Defined in: node_modules/knex/types/index.d.ts:2022


nestTables#

Optional nestTables: string | boolean

Defined in: node_modules/knex/types/index.d.ts:2023


password#

Optional password: string

Inherited from: MySqlConnectionConfig.password

Defined in: node_modules/knex/types/index.d.ts:1990


passwordSha1#

Optional passwordSha1: string

Defined in: node_modules/knex/types/index.d.ts:2024


port#

Optional port: number

Inherited from: MySqlConnectionConfig.port

Defined in: node_modules/knex/types/index.d.ts:1986


queryFormat#

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

Type declaration:#

▸ (query: string, values: any): string

Parameters:#

NameType
querystring
valuesany

Returns: string

Defined in: node_modules/knex/types/index.d.ts:1998

Inherited from: MySqlConnectionConfig.queryFormat

Defined in: node_modules/knex/types/index.d.ts:1998


rowsAsArray#

Optional rowsAsArray: boolean

Defined in: node_modules/knex/types/index.d.ts:2025


socketPath#

Optional socketPath: string

Inherited from: MySqlConnectionConfig.socketPath

Defined in: node_modules/knex/types/index.d.ts:1988


ssl#

Optional ssl: string | MariaSslConfiguration

Inherited from: MySqlConnectionConfig.ssl

Defined in: node_modules/knex/types/index.d.ts:2006


stream#

Optional stream: boolean | (opts: any) => Stream | Stream

Defined in: node_modules/knex/types/index.d.ts:2026


stringifyObjects#

Optional stringifyObjects: boolean

Inherited from: MySqlConnectionConfig.stringifyObjects

Defined in: node_modules/knex/types/index.d.ts:1995


supportBigNumbers#

Optional supportBigNumbers: boolean

Inherited from: MySqlConnectionConfig.supportBigNumbers

Defined in: node_modules/knex/types/index.d.ts:1999


timezone#

Optional timezone: string

Inherited from: MySqlConnectionConfig.timezone

Defined in: node_modules/knex/types/index.d.ts:1993


trace#

Optional trace: boolean

Inherited from: MySqlConnectionConfig.trace

Defined in: node_modules/knex/types/index.d.ts:2003


typeCast#

Optional typeCast: any

Inherited from: MySqlConnectionConfig.typeCast

Defined in: node_modules/knex/types/index.d.ts:1997


uri#

Optional uri: string

Defined in: node_modules/knex/types/index.d.ts:2027


user#

Optional user: string

Inherited from: MySqlConnectionConfig.user

Defined in: node_modules/knex/types/index.d.ts:1989

Methods#

expirationChecker#

OptionalexpirationChecker(): boolean

Returns: boolean

Inherited from: MySqlConnectionConfig

Defined in: node_modules/knex/types/index.d.ts:2008

Last updated on by Martin Adámek