Class DatabaseConnection<TAPI>`Abstract`

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

Implements

IDatabaseConnection

Type Parameters

TAPI

Hierarchy (View Summary)

DatabaseConnection
- MySQLConnection

Implements

IDatabaseConnection

Constructors

constructor

new DatabaseConnection<TAPI>(
    api: TAPI,
    isReadOnly: boolean,
    instantiationStack: string,
): DatabaseConnection<TAPI>
Type Parameters
- TAPI
Parameters
- api: TAPI
- isReadOnly: boolean
- instantiationStack: string
Returns DatabaseConnection<TAPI>
- Defined in src/DatabaseConnection.ts:45

Methods

`Protected` `Abstract`_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
- Defined in src/DatabaseConnection.ts:263

`Protected` `Abstract`_query

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

Async
- Defined in src/DatabaseConnection.ts:273

`Protected` `Abstract`_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
- Defined in src/DatabaseConnection.ts:284

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
Implementation of IDatabaseConnection.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
Implementation of IDatabaseConnection.commit
- Defined in src/DatabaseConnection.ts:244

`Abstract`endTransaction

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

Async
- Defined in src/DatabaseConnection.ts:235

`Abstract`formatQuery

formatQuery(query: IQueryable<any>, params?: any): string
Parameters
- query: IQueryable<any>
- Optionalparams: any
Returns string
Since
8.4.0
Implementation of IDatabaseConnection.formatQuery
- Defined in src/DatabaseConnection.ts:102

getAPI

getAPI(): TAPI
Gets the underlying Database API

Returns TAPI
any
Implementation of IDatabaseConnection.getAPI
- Defined in src/DatabaseConnection.ts:98

`Abstract`getCurrentDatabasePosition

getCurrentDatabasePosition(): Promise<IDatabasePosition>
Returns Promise<IDatabasePosition>
Since
8.1.0
Implementation of IDatabaseConnection.getCurrentDatabasePosition
- Defined in src/DatabaseConnection.ts:289

getInstantiationStack

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

Returns string
string - A stacktrace
Implementation of IDatabaseConnection.getInstantiationStack
- Defined in src/DatabaseConnection.ts:80

getTimeout

getTimeout(): number
Returns the current timeout setting

Returns number
number in milliseconds
Implementation of IDatabaseConnection.getTimeout
- Defined in src/DatabaseConnection.ts:130

`Abstract`hasReplicationEnabled

hasReplicationEnabled(): boolean
Returns boolean
Implementation of IDatabaseConnection.hasReplicationEnabled
- Defined in src/DatabaseConnection.ts:65

isClosed

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

Returns boolean
Implementation of IDatabaseConnection.isClosed
- Defined in src/DatabaseConnection.ts:206

`Abstract`isMaster

isMaster(): boolean
Returns boolean
Implementation of IDatabaseConnection.isMaster
- Defined in src/DatabaseConnection.ts:61

isReadOnly

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

Returns boolean
boolean
Implementation of IDatabaseConnection.isReadOnly
- Defined in src/DatabaseConnection.ts:109

`Abstract`isReplication

isReplication(): boolean
Returns boolean
Implementation of IDatabaseConnection.isReplication
- Defined in src/DatabaseConnection.ts:63

`Abstract`isTransaction

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

Returns boolean
boolean
Implementation of IDatabaseConnection.isTransaction
- Defined in src/DatabaseConnection.ts:225

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
Implementation of IDatabaseConnection.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
Implementation of IDatabaseConnection.rollback
- Defined in src/DatabaseConnection.ts:253

setInstantiationStack

setInstantiationStack(stack: string): void
Parameters
- stack: string
Returns void
Implementation of IDatabaseConnection.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
Implementation of IDatabaseConnection.setTimeout
- Defined in src/DatabaseConnection.ts:118

`Abstract`startTransaction

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

Async
Implementation of IDatabaseConnection.startTransaction
- Defined in src/DatabaseConnection.ts:217

stream

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