Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MySQLConnection

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

  • new MySQLConnection(connection: PoolConnection, instantiationStack: string, isReadOnly?: boolean): MySQLConnection

Methods

Protected _close

  • _close(forceClose: boolean): Promise<void>

Protected _query

  • _query(query: string, params?: any): Promise<any>

Protected _stream

  • _stream(query: string, params?: any, streamOptions?: any): Readable

close

  • close(forceClose?: boolean): Promise<void>

  • Closes the connection. May error if connection has an active transaction. if forceClose boolean is true, it will force close the connection, regardless of transaction state.

    async

    Parameters

    • Default value forceClose: boolean = false

      optional boolean

    Returns Promise<void>

    Promise

commit

  • commit(): Promise<void>

endTransaction

  • endTransaction(requiresRollback?: boolean): Promise<void>

getAPI

  • getAPI(): any

getInstantiationStack

  • getInstantiationStack(): string

getTimeout

  • getTimeout(): number

isClosed

  • isClosed(): boolean

isOpen

  • isOpen(): boolean

isReadOnly

  • isReadOnly(): boolean

isTransaction

  • isTransaction(): boolean

query

rollback

  • rollback(): Promise<void>

setInstantiationStack

  • setInstantiationStack(stack: string): void

setTimeout

  • setTimeout(timeout: number): void

startTransaction

  • startTransaction(): Promise<void>

stream

  • stream(query: string | Query, params?: any, streamOptions?: any): Readable

Generated using TypeDoc