mariadbPool | buildmsql

Hierarchy

Pool
- mariadbPool

Index

Methods

activeConnections

activeConnections(): number

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

Returns number

batch

batch(sql: string | mariadb.QueryOptions, values?: any): Promise<UpsertResult> | Promise<UpsertResult[]>

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

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

emit

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

- Defined in src/index.ts:45
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:691
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:717
This function permit to escape a parameter properly according to 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:729
This function permit to escape a 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(sql: string | mariadb.QueryOptions, values?: any): Promise<any>

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

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

getConnection

getConnection(): Promise<PoolConnection>

Inherited from Pool.getConnection
- Defined in node_modules/mariadb/types/index.d.ts:671
Retrieve a connection from pool. Create a new one, if 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:706
Get current idle connection number.

Returns number

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:731
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:732
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:733
Parameters
- ev: "enqueue"
- callback: (() => void)
  - - (): void
    - Returns void
Returns Pool
Inherited from Pool.on
- Defined in node_modules/mariadb/types/index.d.ts:734
Parameters
- ev: "release"
- callback: ((conn: mariadb.Connection) => void)
  - - (conn: mariadb.Connection): void
    - Parameters
      - conn: mariadb.Connection
      Returns void
Returns Pool

query

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

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

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

taskQueueSize

taskQueueSize(): number

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

Returns number

totalConnections

totalConnections(): number

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

Returns number

Hierarchy

Index

Methods

Methods

activeConnections

Returns number

batch

Parameters

sql: string | mariadb.QueryOptions

Optional values: any

Returns Promise<UpsertResult> | Promise<UpsertResult[]>

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

Parameters

sql: string | mariadb.QueryOptions

Optional values: any

Returns Promise<any>

getConnection

Returns Promise<PoolConnection>

idleConnections

Returns number

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

Parameters

sql: string | mariadb.QueryOptions

Optional values: any

Returns Promise<any>

taskQueueSize

Returns number

totalConnections

Returns number