Interface Connection

Hierarchy

PoolConnection
- Connection

Properties

_connection

_connection: mariadb.Connection

_instanceBuildmsqlMeta

_instanceBuildmsqlMeta: UpsertResult | UpsertResult[]

info

info: null | ConnectionInfo

Connection information

Readonly threadId

threadId: null | number

Alias of info.threadId for compatibility

Methods

affectedRows

affectedRows(): number

- Defined in src/index.ts:12
Returns number

batch

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

Inherited from PoolConnection.batch
- Defined in node_modules/mariadb/types/index.d.ts:579
Execute batch. Values are Array of Array.

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

beginTransaction

beginTransaction(): Promise<void>

Inherited from PoolConnection.beginTransaction
- Defined in node_modules/mariadb/types/index.d.ts:549
Start transaction

Returns Promise<void>

changeUser

changeUser(options?: UserConnectionConfig): Promise<void>

Inherited from PoolConnection.changeUser
- Defined in node_modules/mariadb/types/index.d.ts:544
Permit to change user during connection. All user variables will be reset, Prepare commands will be released. !!! mysql has a bug when CONNECT_ATTRS capability is set, that is default !!!!

Parameters
- Optional options: UserConnectionConfig
Returns Promise<void>

commit

commit(): Promise<void>

Inherited from PoolConnection.commit
- Defined in node_modules/mariadb/types/index.d.ts:554
Commit a transaction.

Returns Promise<void>

createStreamQueryInterface

createStreamQueryInterface(opt: StreamInterfaceOptions): Readable

- Defined in src/index.ts:8
Parameters
- opt: StreamInterfaceOptions
Returns Readable

debug

debug(value: boolean): void

Inherited from PoolConnection.debug
- Defined in node_modules/mariadb/types/index.d.ts:629
Change option "debug" during connection.

Parameters
- value: boolean
Returns void

debugCompress

debugCompress(value: boolean): void

Inherited from PoolConnection.debugCompress
- Defined in node_modules/mariadb/types/index.d.ts:634
Change option "debugCompress" during connection.

Parameters
- value: boolean
Returns void

destroy

destroy(): void

Inherited from PoolConnection.destroy
- Defined in node_modules/mariadb/types/index.d.ts:616
Force connection termination by closing the underlying socket and killing server process if any.

Returns void

end

end(): Promise<void>

Inherited from PoolConnection.end
- Defined in node_modules/mariadb/types/index.d.ts:611
Terminate connection gracefully.

Returns Promise<void>

escape

escape(value: any): string

Inherited from PoolConnection.escape
- Defined in node_modules/mariadb/types/index.d.ts:640
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 PoolConnection.escapeId
- Defined in node_modules/mariadb/types/index.d.ts:652
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 PoolConnection.execute
- Defined in node_modules/mariadb/types/index.d.ts:574
Execute query using binary (prepare) protocol

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

getConfig

getConfig(): ConnectionConfig | PoolConfig | PoolClusterConfig

- Defined in src/index.ts:7
Returns ConnectionConfig | PoolConfig | PoolClusterConfig

getMeta

getMeta(): MetadataResultSet[] | UpsertResult | UpsertResult[]

- Defined in src/index.ts:10
Returns MetadataResultSet[] | UpsertResult | UpsertResult[]

getPool

getPool(): Pool | PoolCluster

- Defined in src/index.ts:32
Returns Pool | PoolCluster

insert

insert<T, V>(table: T, params: Partial<V> | Partial<V>[], options?: InsertOptions): Promise<UpsertResult | UpsertResult[]>

- Defined in src/index.ts:21
Type Parameters
- T extends string
- V = Record<string, any>
Parameters
- table: T
- params: Partial<V> | Partial<V>[]
- Optional options: InsertOptions
Returns Promise<UpsertResult | UpsertResult[]>

isValid

isValid(): boolean

Inherited from PoolConnection.isValid
- Defined in node_modules/mariadb/types/index.d.ts:606
Indicates the state of the connection as the driver knows it

Returns boolean

lastInsertId

lastInsertId<T>(): T

- Defined in src/index.ts:11
Type Parameters
- T = number
Returns T

on

on(ev: "end", callback: (() => void)): mariadb.Connection
on(ev: "error", callback: ((err: mariadb.SqlError) => void)): mariadb.Connection

Inherited from PoolConnection.on
- Defined in node_modules/mariadb/types/index.d.ts:654
Parameters
- ev: "end"
- callback: (() => void)
  - - (): void
    - Returns void
Returns mariadb.Connection
Inherited from PoolConnection.on
- Defined in node_modules/mariadb/types/index.d.ts:655
Parameters
- ev: "error"
- callback: ((err: mariadb.SqlError) => void)
  - - (err: mariadb.SqlError): void
    - Parameters
      - err: mariadb.SqlError
      Returns void
Returns mariadb.Connection

pause

pause(): void

Inherited from PoolConnection.pause
- Defined in node_modules/mariadb/types/index.d.ts:618
Returns void

ping

ping(): Promise<void>

Inherited from PoolConnection.ping
- Defined in node_modules/mariadb/types/index.d.ts:590
Send an empty MySQL packet to ensure connection is active, and reset @@wait_timeout

Returns Promise<void>

prepare

prepare(sql: string): Promise<Prepare>

Inherited from PoolConnection.prepare
- Defined in node_modules/mariadb/types/index.d.ts:569
Prepare query.

Parameters
- sql: string
Returns Promise<Prepare>

proxy

proxy(): Connection

- Defined in src/index.ts:9
Returns Connection

query

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

Overrides PoolConnection.query
- Defined in src/index.ts:20
Execute query using text protocol.

Type Parameters
- T extends unknown = QueryResult
- V = Record<string, any>
Parameters
- sql: string | QueryOptions
- Optional values: Partial<V>
Returns Promise<T>

queryStream

queryStream(sql: string | mariadb.QueryOptions, values?: any): Readable

Inherited from PoolConnection.queryStream
- Defined in node_modules/mariadb/types/index.d.ts:585
Execute query returning a Readable Object that will emit columns/data/end/error events to permit streaming big result-set

Parameters
- sql: string | mariadb.QueryOptions
- Optional values: any
Returns Readable

quote

quote(input: any): string

- Defined in src/index.ts:14
Parameters
- input: any
Returns string

release

release(): Promise<void>

Inherited from PoolConnection.release
- Defined in node_modules/mariadb/types/index.d.ts:662
Release the connection to pool internal cache.

Returns Promise<void>

reset

reset(): Promise<void>

Inherited from PoolConnection.reset
- Defined in node_modules/mariadb/types/index.d.ts:601
Send a reset command that will
- rollback any open transaction
- reset transaction isolation level
- reset session variables
- delete user variables
- remove temporary tables
- remove all PREPARE statement
Returns Promise<void>

resume

resume(): void

Inherited from PoolConnection.resume
- Defined in node_modules/mariadb/types/index.d.ts:619
Returns void

rollback

rollback(): Promise<void>

Inherited from PoolConnection.rollback
- Defined in node_modules/mariadb/types/index.d.ts:559
Roll back a transaction.

Returns Promise<void>

serverVersion

serverVersion(): string

Inherited from PoolConnection.serverVersion
- Defined in node_modules/mariadb/types/index.d.ts:624
Alias for info.serverVersion.raw

Returns string

statistics

statistics(): { count: number; queries: QueriesInfo[]; time: number }

- Defined in src/index.ts:15
Returns { count: number; queries: QueriesInfo[]; time: number }
- count: number
- queries: QueriesInfo[]
- time: number

update

update<T, V>(table: T, where: string, params: Partial<V>, options?: UpdateOptions): Promise<UpsertResult>

- Defined in src/index.ts:26
Type Parameters
- T extends string
- V = Record<string, any>
Parameters
- table: T
- where: string
- params: Partial<V>
- Optional options: UpdateOptions
Returns Promise<UpsertResult>

warningStatus

warningStatus(): number

- Defined in src/index.ts:13
Returns number

Generated using TypeDoc