Class MysqlEndpoint

Hierarchy

MysqlEndpoint

Index

Constructors

constructor

Properties

client

Methods

Constructors

constructor

new MysqlEndpoint(client: BegetRequest): MysqlEndpoint

- Defined in src/endpoints/mysql.ts:5
Parameters
- client: BegetRequest
Returns MysqlEndpoint

Properties

Private Readonly client

client: BegetRequest

Methods

addAccess

addAccess(params: DBConf): Promise<boolean>

- Defined in src/endpoints/mysql.ts:36
The method adds the specified access to the specified MySql database.

Parameters
- params: DBConf
Returns Promise<boolean>

Returns property of successful or unsuccessful execution.

addDb

addDb(params: Pick<DBConf, "suffix" | "password">): Promise<boolean>

- Defined in src/endpoints/mysql.ts:28
The method adds the task to the queue for creating a new MySql database with the specified suffix and creates access for localhost with the specified password. The database creation process can take several minutes.

Parameters
- params: Pick<DBConf, "suffix" | "password">
Returns Promise<boolean>

Returns property of successful or unsuccessful execution.

changeAccessPassword

changeAccessPassword(params: DBConf): Promise<boolean>

- Defined in src/endpoints/mysql.ts:60
The method changes the password on the specified access.

Parameters
- params: DBConf
Returns Promise<boolean>

Returns property of successful or unsuccessful execution.

dropAccess

dropAccess(params: Pick<DBConf, "suffix" | "access">): Promise<boolean>

- Defined in src/endpoints/mysql.ts:52
The method removes the specified access from the database.

Parameters
- params: Pick<DBConf, "suffix" | "access">
Returns Promise<boolean>

Returns property of successful or unsuccessful execution.

dropDb

dropDb(params: Pick<DBConf, "suffix">): Promise<boolean>

- Defined in src/endpoints/mysql.ts:44
The method deletes the specified database and all accesses to it.

Parameters
- params: Pick<DBConf, "suffix">
Returns Promise<boolean>

Returns property of successful or unsuccessful execution.

getList

getList(): Promise<DB[]>

- Defined in src/endpoints/mysql.ts:18
The method returns a list of MySQL databases with their accesses.

Returns Promise<DB[]>

Private method

method<T>(method: Methods["mysql"], data?: object): Promise<T>

- Defined in src/endpoints/mysql.ts:11
Type parameters
- T
Parameters
- method: Methods["mysql"]
- Optional data: object
Returns Promise<T>

Generated using TypeDoc