Class Database<TDatabaseConfig, TConnectionAPI>`Abstract`

Type Parameters

TDatabaseConfig
TConnectionAPI

Hierarchy (View Summary)

Database
- MySQLDatabase

Index

Constructors

Methods

_addNode _destroy _getConnection _removeNode addMaster addSlave destroy escape getConnection removeMaster removeSlave

Constructors

constructor

new Database<TDatabaseConfig, TConnectionAPI>(): Database<
TDatabaseConfig,
TConnectionAPI,
>
Type Parameters
- TDatabaseConfig
- TConnectionAPI
Returns Database<TDatabaseConfig, TConnectionAPI>
- Defined in src/Database.ts:28

Methods

`Protected` `Abstract`_addNode

_addNode(name: string, config: TDatabaseConfig): void
Parameters
- name: string
- config: TDatabaseConfig
Returns void
- Defined in src/Database.ts:83

`Protected` `Abstract`_destroy

_destroy(): Promise<void>
Returns Promise<void>
- Defined in src/Database.ts:82

`Protected` `Abstract`_getConnection

_getConnection(
    query: string,
    requireWriteAccess: boolean,
    requiredPosition?: IDatabasePosition,
): Promise<DatabaseConnection<TConnectionAPI>>
Parameters
- query: string
- requireWriteAccess: boolean
- OptionalrequiredPosition: IDatabasePosition
Returns Promise<DatabaseConnection<TConnectionAPI>>
- Defined in src/Database.ts:85

`Protected` `Abstract`_removeNode

_removeNode(name: string): void
Parameters
- name: string
Returns void
- Defined in src/Database.ts:84

addMaster

addMaster(config: TDatabaseConfig): void
Parameters
- config: TDatabaseConfig
Returns void
- Defined in src/Database.ts:32

addSlave

addSlave(slaveID: string, config: TDatabaseConfig): string
Parameters
- slaveID: string
- config: TDatabaseConfig
Returns string
- Defined in src/Database.ts:46

destroy

destroy(): Promise<void>
Returns Promise<void>
- Defined in src/Database.ts:78

`Abstract`escape

escape(query: string): string
Parameters
- query: string
Returns string
- Defined in src/Database.ts:86

getConnection

getConnection(
    requireWriteAccess?: boolean,
    nodeID?: string,
    requiredPosition?: IDatabasePosition,
): Promise<DatabaseConnection<TConnectionAPI>>
Parameters
- requireWriteAccess: boolean = false
- OptionalnodeID: string
- OptionalrequiredPosition: IDatabasePosition
Returns Promise<DatabaseConnection<TConnectionAPI>>
- Defined in src/Database.ts:65

removeMaster

removeMaster(): void
Returns void
- Defined in src/Database.ts:41

removeSlave

removeSlave(slaveID: string): void
Parameters
- slaveID: string
Returns void
- Defined in src/Database.ts:55