Class MySQLConnection

Do not call new Database directly. Use Database.getConnection to create a DatabaseConnection object.

Implements

IDatabaseConnection

Hierarchy (View Summary)

DatabaseConnection<MySQL.PoolConnection>
- MySQLConnection

Constructors

constructor

new MySQLConnection(
    connection: PoolConnection,
    instantiationStack: string,
    isReadOnly?: boolean,
): MySQLConnection
Parameters
- connection: PoolConnection
- instantiationStack: string
- isReadOnly: boolean = true
Returns MySQLConnection
Overrides DatabaseConnection.constructor
- Defined in src/MySQLConnection.ts:72

Methods

__internal_init

__internal_init(): Promise<void>
Internal
- Do not use in application code
Returns Promise<void>
- Defined in src/MySQLConnection.ts:116

`Protected`_close

_close(forceClose: boolean): Promise<void>
Implementation to close the connection, if forceClose is true, close the connection no matter what. Silently error if it means the connection is closed.
Parameters
- forceClose: boolean
  boolean, if true, should close the connection no matter what.
Returns Promise<void>
Promise

Async
Overrides DatabaseConnection._close
- Defined in src/MySQLConnection.ts:342

`Protected`_query

_query(query: string, params?: any): Promise<any>
Implementation method to return a dataset from the database
Parameters
- query: string
  The database query
- Optionalparams: any
  The query parameters
Returns Promise<any>
Promise

Async
Overrides DatabaseConnection._query
- Defined in src/MySQLConnection.ts:196

`Protected`_stream

_stream(query: string, params?: any, streamOptions?: any): Readable
Implementation method to return a dataset from the database like query(), but returns a Readable stream instead.
Parameters
- query: string
  The database query
- Optionalparams: any
  The query parameters
- OptionalstreamOptions: any
  Readable stream options
Returns Readable
Readable
Overrides DatabaseConnection._stream
- Defined in src/MySQLConnection.ts:261

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.
Parameters
- forceClose: boolean = false
  optional boolean
Returns Promise<void>
Promise

Async
Inherited from DatabaseConnection.close
- Defined in src/DatabaseConnection.ts:193

`Abstract`commit

commit(): Promise<void>
Commits a transaction. This will end a transaction.

Returns Promise<void>
Promise

Async
Overrides DatabaseConnection.commit
- Defined in src/MySQLConnection.ts:326

`Abstract`endTransaction

endTransaction(requiresRollback?: boolean): Promise<void>
Ends a transaction. if requiresRollback is true, then rollback() is invoked. Otherwise, commit() is invoked.
Parameters
- requiresRollback: boolean = false
  optional boolean
Returns Promise<void>
Promise

Async
Overrides DatabaseConnection.endTransaction
- Defined in src/MySQLConnection.ts:306

formatQuery

formatQuery(query: IQueryable<any>): string
Parameters
- query: IQueryable<any>
Returns string
Since
8.4.0
Overrides DatabaseConnection.formatQuery
- Defined in src/MySQLConnection.ts:145

getAPI

getAPI(): PoolConnection
Gets the underlying Database API

Returns PoolConnection
any
Inherited from DatabaseConnection.getAPI
- Defined in src/DatabaseConnection.ts:98

getCurrentDatabasePosition

getCurrentDatabasePosition(): Promise<IDatabasePosition>
Returns Promise<IDatabasePosition>
Since
8.1.0
Overrides DatabaseConnection.getCurrentDatabasePosition
- Defined in src/MySQLConnection.ts:179

getInstantiationStack

getInstantiationStack(): string
Gets the callback stacktrace to determine what opened this connection. Useful for debugging lingering connections.

Returns string
string - A stacktrace
Inherited from DatabaseConnection.getInstantiationStack
- Defined in src/DatabaseConnection.ts:80

getTimeout

getTimeout(): number
Returns the current timeout setting

Returns number
number in milliseconds
Inherited from DatabaseConnection.getTimeout
- Defined in src/DatabaseConnection.ts:130

getVersion

getVersion(): Promise<IGetMySQLVersionResult>
Returns Promise<IGetMySQLVersionResult>
- Defined in src/MySQLConnection.ts:137

hasReplicationEnabled

hasReplicationEnabled(): boolean
Returns true if this server is part of a replication cluster.

Returns boolean
Overrides DatabaseConnection.hasReplicationEnabled
- Defined in src/MySQLConnection.ts:160

isClosed

isClosed(): boolean
Returns true if the connection has been closed.

Returns boolean
Inherited from DatabaseConnection.isClosed
- Defined in src/DatabaseConnection.ts:206

isMaster

isMaster(): boolean
Returns true if this server is the source. Will also return true if there is no replication detected.

Returns boolean
Overrides DatabaseConnection.isMaster
- Defined in src/MySQLConnection.ts:153

isOpen

isOpen(): boolean
Returns boolean
- Defined in src/MySQLConnection.ts:175

isReadOnly

isReadOnly(): boolean
Returns true if connection was created without write access

Returns boolean
boolean
Inherited from DatabaseConnection.isReadOnly
- Defined in src/DatabaseConnection.ts:109

isReplication

isReplication(): boolean
Returns true if this server is a replication server.

Returns boolean
Overrides DatabaseConnection.isReplication
- Defined in src/MySQLConnection.ts:167

`Abstract`isTransaction

isTransaction(): boolean
Implementation method to determine if the connection is in an active transaction.

Returns boolean
boolean
Overrides DatabaseConnection.isTransaction
- Defined in src/MySQLConnection.ts:171

query

query<TQueryResult = any>(
query: IQueryable<TQueryResult>,
): Promise<TQueryResult>
Queries the database for a dataset.
Type Parameters
- TQueryResult = any
Parameters
- query: IQueryable<TQueryResult>
  The database query
Returns Promise<TQueryResult>
Promise

Async
Inherited from DatabaseConnection.query
- Defined in src/DatabaseConnection.ts:141

`Abstract`rollback

rollback(): Promise<void>
Rollsback a transaction. This will end a transaction.

Returns Promise<void>
Promise

Async
Overrides DatabaseConnection.rollback
- Defined in src/MySQLConnection.ts:310

setInstantiationStack

setInstantiationStack(stack: string): void
Parameters
- stack: string
Returns void
Inherited from DatabaseConnection.setInstantiationStack
- Defined in src/DatabaseConnection.ts:71

setTimeout

setTimeout(timeout: number): void
Sets the timeout of this connectino
Parameters
- timeout: number
  in milliseconds
Returns void
Inherited from DatabaseConnection.setTimeout
- Defined in src/DatabaseConnection.ts:118

`Abstract`startTransaction

startTransaction(
isolationLevel?: IsolationLevel,
accessLevel?: TransactionAccessLevel,
): Promise<void>
Implementation method to start a transaction.
Parameters
- OptionalisolationLevel: IsolationLevel
- accessLevel: TransactionAccessLevel = TransactionAccessLevel.RW
Returns Promise<void>
Promise

Async
Overrides DatabaseConnection.startTransaction
- Defined in src/MySQLConnection.ts:280

stream

stream(query: IQueryable<any>, streamOptions?: any): Readable
Parameters
- query: IQueryable<any>
  The database query
- OptionalstreamOptions: any
  Stream options
Returns Readable
Readable
Inherited from DatabaseConnection.stream
- Defined in src/DatabaseConnection.ts:176