mariadbPool | buildmsql

Hierarchy

Pool
- mariadbPool

Index

Properties

closed

Methods

Properties

closed

closed: boolean

Methods

activeConnections

activeConnections(): number

Inherited from Pool.activeConnections
- Defined in node_modules/mariadb/types/index.d.ts:237
Get current active connections.

Returns number

batch

batch<T, V>(sql: string | mariadb.QueryOptions, values?: V): Promise<T>

Inherited from Pool.batch
- Defined in node_modules/mariadb/types/index.d.ts:217
Execute a batch on one connection from pool.

Type Parameters
- T = UpsertResult | UpsertResult[]
- V = any
Parameters
- sql: string | mariadb.QueryOptions
- Optional values: V
Returns Promise<T>

emit

emit(eventName: string | symbol, ...args: any[]): boolean

- Defined in src/index.ts:46
Parameters
- eventName: string | symbol
- Rest ...args: any[]
Returns boolean

end

end(): Promise<void>

Inherited from Pool.end
- Defined in node_modules/mariadb/types/index.d.ts:227
Close all connection in pool

Returns Promise<void>

escape

escape(value: any): string

Inherited from Pool.escape
- Defined in node_modules/mariadb/types/index.d.ts:258
This function permits escaping a parameter properly, according to a parameter type, to avoid injection.

Parameters
- value: any
  
  parameter
Returns string

escapeId

escapeId(identifier: string): string

Inherited from Pool.escapeId
- Defined in node_modules/mariadb/types/index.d.ts:270
This function permits escaping an Identifier properly. See Identifier Names for escaping. Value will be enclosed by '' character if content doesn't satisfy: <OL> <LI>ASCII: [0-9,a-z,A-Z$_] (numerals 0-9, basic Latin letters, both lowercase and uppercase, dollar sign, underscore)</LI> <LI>Extended: U+0080 .. U+FFFF and escaping '' character if needed.

Parameters

identifier: string

identifier

Returns string

execute

execute<T, V>(sql: string | mariadb.QueryOptions, values?: V): Promise<T>

Inherited from Pool.execute
- Defined in node_modules/mariadb/types/index.d.ts:222
Execute query using binary (prepare) protocol

Type Parameters
- T = any
- V = any
Parameters
- sql: string | mariadb.QueryOptions
- Optional values: V
Returns Promise<T>

getConnection

getConnection(): Promise<PoolConnection>

Inherited from Pool.getConnection
- Defined in node_modules/mariadb/types/index.d.ts:207
Retrieve a connection from the pool. Create a new one if the limit is not reached. wait until acquireTimeout.

Returns Promise<PoolConnection>

idleConnections

idleConnections(): number

Inherited from Pool.idleConnections
- Defined in node_modules/mariadb/types/index.d.ts:247
Get the current idle connection number.

Returns number

importFile

importFile(config: SqlImportOptions): Promise<void>

Inherited from Pool.importFile
- Defined in node_modules/mariadb/types/index.d.ts:232
import sql file

Parameters
- config: SqlImportOptions
Returns Promise<void>

on

on(ev: "acquire", callback: ((conn: mariadb.Connection) => void)): Pool
on(ev: "connection", callback: ((conn: mariadb.Connection) => void)): Pool
on(ev: "enqueue", callback: (() => void)): Pool
on(ev: "release", callback: ((conn: mariadb.Connection) => void)): Pool

Inherited from Pool.on
- Defined in node_modules/mariadb/types/index.d.ts:278
Parameters
- ev: "acquire"
- callback: ((conn: mariadb.Connection) => void)
  - - (conn: mariadb.Connection): void
    - Parameters
      - conn: mariadb.Connection
      Returns void
Returns Pool
Inherited from Pool.on
- Defined in node_modules/mariadb/types/index.d.ts:279
Parameters
- ev: "connection"
- callback: ((conn: mariadb.Connection) => void)
  - - (conn: mariadb.Connection): void
    - Parameters
      - conn: mariadb.Connection
      Returns void
Returns Pool
Inherited from Pool.on
- Defined in node_modules/mariadb/types/index.d.ts:280
Parameters
- ev: "enqueue"
- callback: (() => void)
  - - (): void
    - Returns void
Returns Pool
Inherited from Pool.on
- Defined in node_modules/mariadb/types/index.d.ts:281
Parameters
- ev: "release"
- callback: ((conn: mariadb.Connection) => void)
  - - (conn: mariadb.Connection): void
    - Parameters
      - conn: mariadb.Connection
      Returns void
Returns Pool

query

query<T, V>(sql: string | mariadb.QueryOptions, values?: V): Promise<T>

Inherited from Pool.query
- Defined in node_modules/mariadb/types/index.d.ts:212
Execute a query on one connection from pool.

Type Parameters
- T = any
- V = any
Parameters
- sql: string | mariadb.QueryOptions
- Optional values: V
Returns Promise<T>

taskQueueSize

taskQueueSize(): number

Inherited from Pool.taskQueueSize
- Defined in node_modules/mariadb/types/index.d.ts:252
Get current stacked connection request.

Returns number

totalConnections

totalConnections(): number

Inherited from Pool.totalConnections
- Defined in node_modules/mariadb/types/index.d.ts:242
Get the current total connection number.

Returns number

Hierarchy

Index

Properties

Methods

Properties

closed

Methods

activeConnections

Returns number

batch

Type Parameters

T = UpsertResult | UpsertResult[]

V = any

Parameters

sql: string | mariadb.QueryOptions

Optional values: V

Returns Promise<T>

emit

Parameters

eventName: string | symbol

Rest ...args: any[]

Returns boolean

end

Returns Promise<void>

escape

Parameters

value: any

Returns string

escapeId

Parameters

identifier: string

Returns string

execute

Type Parameters

T = any

V = any

Parameters

sql: string | mariadb.QueryOptions

Optional values: V

Returns Promise<T>

getConnection

Returns Promise<PoolConnection>

idleConnections

Returns number

importFile

Parameters

config: SqlImportOptions

Returns Promise<void>

on

Parameters

ev: "acquire"

callback: ((conn: mariadb.Connection) => void)

Parameters

conn: mariadb.Connection

Returns void

Returns Pool

Parameters

ev: "connection"

callback: ((conn: mariadb.Connection) => void)

Parameters

conn: mariadb.Connection

Returns void

Returns Pool

Parameters

ev: "enqueue"

callback: (() => void)

Returns void

Returns Pool

Parameters

ev: "release"

callback: ((conn: mariadb.Connection) => void)

Parameters

conn: mariadb.Connection

Returns void

Returns Pool

query

Type Parameters

T = any

V = any

Parameters