Class MySQL

Hierarchy

EventEmitter
- MySQL

Index

Constructors

Properties

Methods

beginTransaction close commitTransaction connection createTable dropTable listTables multiInsert multiUpdate on prepareCreateTable prepareMultiInsert prepareMultiUpdate query rollbackTransaction transaction use

Constructors

constructor

new MySQL(config: PoolConfig & {
rejectUnauthorized?: boolean;
}): MySQL
Creates a new instance of the class
Parameters
- config: PoolConfig & {
  rejectUnauthorized?: boolean;
  }
Returns MySQL

Overrides EventEmitter.constructor

Properties

`Readonly` config

config: PoolConfig & {
rejectUnauthorized?: boolean;
}

`Readonly` pool

pool: Pool

tableOptions

tableOptions: string = 'ENGINE=InnoDB PACK_KEYS=1 ROW_FORMAT=COMPRESSED'

Methods

`Protected` beginTransaction

beginTransaction(connection: PoolConnection): Promise<void>
Protected
Starts a transaction on the specified connection
Parameters
- connection: PoolConnection
Returns Promise<void>

close

close(): Promise<void>
Closes all the pooled connections

Returns Promise<void>

`Protected` commitTransaction

commitTransaction(connection: PoolConnection): Promise<void>
Protected
Commits a transaction on the specified connection
Parameters
- connection: PoolConnection
Returns Promise<void>

`Protected` connection

connection(): Promise<PoolConnection>
Protected
Returns a database connection from the pool

Returns Promise<PoolConnection>

createTable

createTable(name: string, fields: Column[], primaryKey: string[], tableOptions?: string, useTransaction?: boolean): Promise<void>
Prepares and executes the creation of a table including the relevant indexes and constraints
Parameters
- name: string
- fields: Column[]
- primaryKey: string[]
- tableOptions: string = ...
- useTransaction: boolean = true
Returns Promise<void>

dropTable

dropTable(tables: string | string[]): Promise<QueryResult<any>[]>
Drop the tables from the database
Parameters
- tables: string | string[]
Returns Promise<QueryResult<any>[]>

listTables

listTables(database?: undefined | string): Promise<string[]>
Lists the tables in the specified database
Parameters
- database: undefined | string = ...
Returns Promise<string[]>

multiInsert

multiInsert(table: string, columns?: string[], values: any[][], useTransaction?: boolean): Promise<QueryResult<any>>
Prepares and performs a query that performs a multi-insert statement which is far faster than a bunch of individual insert statements
Parameters
- table: string
- columns: string[] = []
- values: any[][]
- useTransaction: boolean = true
Returns Promise<QueryResult<any>>

multiUpdate

multiUpdate(table: string, primaryKey: string[], columns: string[], values: any[][], useTransaction?: boolean): Promise<QueryResult<any>>
Prepares and executes a query to that performs a multi-update statement which is based upon a multi-insert statement that performs an UPSERT which is a lot faster than a bunch of update statements
Parameters
- table: string
- primaryKey: string[]
- columns: string[]
- values: any[][]
- useTransaction: boolean = true
Returns Promise<QueryResult<any>>

on

on(event: "error", listener: ((error: Error) => void)): MySQL
Parameters
- event: "error"
- listener: ((error: Error) => void)
  - - (error: Error): void
    - Parameters
      
      error: Error
      
      Returns void
Returns MySQL

Overrides EventEmitter.on
on(event: "acquire", listener: ((connection: PoolConnection) => void)): MySQL
Parameters
- event: "acquire"
- listener: ((connection: PoolConnection) => void)
  - - (connection: PoolConnection): void
    - Parameters
      
      connection: PoolConnection
      
      Returns void
Returns MySQL

Overrides EventEmitter.on
on(event: "connection", listener: ((connection: PoolConnection) => void)): MySQL
Parameters
- event: "connection"
- listener: ((connection: PoolConnection) => void)
  - - (connection: PoolConnection): void
    - Parameters
      
      connection: PoolConnection
      
      Returns void
Returns MySQL

Overrides EventEmitter.on
on(event: "enqueue", listener: (() => void)): MySQL
Parameters
- event: "enqueue"
- listener: (() => void)
  - - (): void
    - Returns void
Returns MySQL

Overrides EventEmitter.on
on(event: "release", listener: ((connection: PoolConnection) => void)): MySQL
Parameters
- event: "release"
- listener: ((connection: PoolConnection) => void)
  - - (connection: PoolConnection): void
    - Parameters
      
      connection: PoolConnection
      
      Returns void
Returns MySQL

Overrides EventEmitter.on

prepareCreateTable

prepareCreateTable(name: string, fields: Column[], primaryKey: string[], tableOptions?: string): Query[]
Prepares the creation of a table including the relevant indexes and constraints
Parameters
- name: string
- fields: Column[]
- primaryKey: string[]
- tableOptions: string = ...
Returns Query[]

prepareMultiInsert

prepareMultiInsert(table: string, columns?: string[], values: any[][]): Query
Prepares a query to perform a multi-insert statement which is far faster than a bunch of individual insert statements
Parameters
- table: string
- columns: string[] = []
- values: any[][]
Returns Query

prepareMultiUpdate

prepareMultiUpdate(table: string, primaryKey: string[], columns: string[], values: any[][]): Query
Prepares a query to perform a multi-update statement which is based upon a multi-insert statement that performs an UPSERT and this is a lot faster than a bunch of individual update statements
Parameters
- table: string
- primaryKey: string[]
- columns: string[]
- values: any[][]
Returns Query

query

query<RecordType>(query: string | Query, values?: any[], connection?: Pool | PoolConnection): Promise<QueryResult<RecordType>>
Performs an individual query and returns the result
Type Parameters
- RecordType = any
Parameters
- query: string | Query
- values: any[] = []
- connection: Pool | PoolConnection = ...
Returns Promise<QueryResult<RecordType>>

`Protected` rollbackTransaction

rollbackTransaction(connection: PoolConnection): Promise<void>
Protected
Rolls back a transaction on the specified connection
Parameters
- connection: PoolConnection
Returns Promise<void>

transaction

transaction<RecordType>(queries: Query[]): Promise<QueryResult<RecordType>[]>
Performs the specified queries in a transaction
Type Parameters
- RecordType = any
Parameters
- queries: Query[]
Returns Promise<QueryResult<RecordType>[]>

use

use(database: string): Promise<QueryResult<any>>
Switches the default database referenced by the connection
Parameters
- database: string
Returns Promise<QueryResult<any>>

Class MySQL

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

config: PoolConfig & { rejectUnauthorized?: boolean; }

Returns MySQL

Properties

Readonly config

Readonly pool

tableOptions

Methods

Protected beginTransaction

Parameters

connection: PoolConnection

Returns Promise<void>

close

Returns Promise<void>

Protected commitTransaction

Parameters

connection: PoolConnection

Returns Promise<void>

Protected connection

Returns Promise<PoolConnection>

createTable

Parameters

name: string

fields: Column[]

primaryKey: string[]

tableOptions: string = ...

useTransaction: boolean = true

Returns Promise<void>

dropTable

Parameters

tables: string | string[]

Returns Promise<QueryResult<any>[]>

listTables

Parameters

database: undefined | string = ...

Returns Promise<string[]>

multiInsert

Parameters

table: string

columns: string[] = []

values: any[][]

useTransaction: boolean = true

Returns Promise<QueryResult<any>>

multiUpdate

Parameters

table: string

primaryKey: string[]

columns: string[]

values: any[][]

useTransaction: boolean = true

Returns Promise<QueryResult<any>>

on

Parameters

event: "error"

listener: ((error: Error) => void)

Parameters

error: Error

Returns void

Returns MySQL

Parameters

event: "acquire"

listener: ((connection: PoolConnection) => void)

Parameters

connection: PoolConnection

Returns void

Returns MySQL

Parameters

event: "connection"

listener: ((connection: PoolConnection) => void)

Parameters

connection: PoolConnection

Returns void

config: PoolConfig & {
rejectUnauthorized?: boolean;
}

`Readonly` config

`Readonly` pool

`Protected` beginTransaction

`Protected` commitTransaction

`Protected` connection

`Protected` rollbackTransaction