Class MySQLDatabase

Hierarchy (View Summary)

Database<MySQL.PoolOptions, MySQL.PoolConnection>
- MySQLDatabase

Index

Constructors

Methods

_addNode _destroy _getConnection _removeNode addMaster addSlave destroy escape getConnection removeMaster removeSlave escape

Constructors

constructor

new MySQLDatabase(): MySQLDatabase
Returns MySQLDatabase
Overrides Database.constructor
- Defined in src/MySQLDatabase.ts:30

Methods

`Protected`_addNode

_addNode(nodeID: string, config: PoolOptions): void
Parameters
- nodeID: string
- config: PoolOptions
Returns void
Overrides Database._addNode
- Defined in src/MySQLDatabase.ts:50

`Protected`_destroy

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

`Protected`_getConnection

_getConnection(
    query: string,
    requireWriteAccess: boolean,
    position?: IDatabasePosition,
): Promise<MySQLConnection>
Parameters
- query: string
- requireWriteAccess: boolean
- Optionalposition: IDatabasePosition
Returns Promise<MySQLConnection>
Overrides Database._getConnection
- Defined in src/MySQLDatabase.ts:77

`Protected`_removeNode

_removeNode(nodeID: string): void
Parameters
- nodeID: string
Returns void
Overrides Database._removeNode
- Defined in src/MySQLDatabase.ts:55

addMaster

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

addSlave

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

destroy

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

escape

escape(value: any): string
Parameters
- value: any
Returns string
Overrides Database.escape
- Defined in src/MySQLDatabase.ts:42

getConnection

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

removeMaster

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

removeSlave

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

`Static`escape

escape(value: any): string
Parameters
- value: any
Returns string
- Defined in src/MySQLDatabase.ts:46