Class MySQL

MySQL Adapter

Hierarchy

default
- MySQL

Index

Properties

dataSource repository db

Methods

close deleteAllRulesets deleteRuleset getRuleset listRulesets newModel saveRuleset getDB

Properties

`Protected` `Readonly`dataSource

dataSource: DataSource

The connection to the database

`Protected` `Readonly`repository

repository: Repository<SQLModel>

The repository

`Protected` `Static`db

db: undefined | TypeORM

The database instance (singleton pattern)

Methods

close

close(): Promise<void>
Closes the connection to the Database.

Returns Promise<void>
Inherited from TypeORM.close
- Defined in persistent-rita/src/Database/TypeORM.ts:98

deleteAllRulesets

deleteAllRulesets(): Promise<void>
Deletes all rulesets.

Returns Promise<void>
Inherited from TypeORM.deleteAllRulesets
- Defined in persistent-rita/src/Database/TypeORM.ts:94

deleteRuleset

deleteRuleset(id): Promise<void>
Deletes a ruleset with the given ID.
Parameters
- id: string
  The ID of the ruleset
Returns Promise<void>
Inherited from TypeORM.deleteRuleset
- Defined in persistent-rita/src/Database/TypeORM.ts:39

getRuleset

getRuleset(id): Promise<undefined | Ruleset>
Gets a specific ruleset by it ID. If there is no ruleset with this ID, undefined will be returned.
Parameters
- id: string
  The ID of the ruleset
Returns Promise<undefined | Ruleset>
Inherited from TypeORM.getRuleset
- Defined in persistent-rita/src/Database/TypeORM.ts:53

listRulesets

listRulesets(): Promise<Ruleset[]>
Returns a list containing all rulesets.

Returns Promise<Ruleset[]>
Inherited from TypeORM.listRulesets
- Defined in persistent-rita/src/Database/TypeORM.ts:69

newModel

newModel(): SQLModel
Gets a new model to save data into

Returns SQLModel
Overrides TypeORM.newModel
- Defined in persistent-rita/src/Database/MySQL.ts:47

saveRuleset

saveRuleset(id, data): Promise<void>
Saves a ruleset with the given ID. If it already exists it will be updated, otherwise it will be created.
Parameters
- id: string
  The ID of the ruleset
- data: Ruleset
  The actual ruleset
Returns Promise<void>
Inherited from TypeORM.saveRuleset
- Defined in persistent-rita/src/Database/TypeORM.ts:82

`Static`getDB

getDB(config, logger?): Promise<MySQL>
Gets the singleton database.
Parameters
- config: DatabaseConfig
  Configuration
- logger: PersistentRitaLogger = ...
  A custom Logger
Returns Promise<MySQL>
- Defined in persistent-rita/src/Database/MySQL.ts:17