Class BackupEndpoint

Hierarchy

BackupEndpoint

Index

Constructors

constructor

Properties

client

Methods

Constructors

constructor

new BackupEndpoint(client: BegetRequest): BackupEndpoint

- Defined in src/endpoints/backup.ts:5
Parameters
- client: BegetRequest
Returns BackupEndpoint

Properties

Private Readonly client

client: BegetRequest

Methods

downloadFile

downloadFile(params?: Pick<Mysql, "backup_id" | "paths">): Promise<boolean>

- Defined in src/endpoints/backup.ts:67
Method creates query for up- and downloading data from backup to account root.

Parameters
- Optional params: Pick<Mysql, "backup_id" | "paths">
Returns Promise<boolean>

Returns property of successful or unsuccessful execution.

downloadMysql

downloadMysql(params?: Pick<Mysql, "backup_id" | "bases">): Promise<boolean>

- Defined in src/endpoints/backup.ts:74
Method creates query for up- and downloading of data from backup to account root.

Parameters
- Optional params: Pick<Mysql, "backup_id" | "bases">
Returns Promise<boolean>

getFileBackupList

getFileBackupList(): Promise<FileBackup[]>

- Defined in src/endpoints/backup.ts:18
Method returns available list of file backups.

Returns Promise<FileBackup[]>

getFileList

getFileList(params?: Pick<Mysql, "backup_id" | "path">): Promise<FileInfo[]>

- Defined in src/endpoints/backup.ts:33
Method returns a list of files and directories from a backup according to the given path and identifier.

Parameters
- Optional params: Pick<Mysql, "backup_id" | "path">
Returns Promise<FileInfo[]>

getLog

getLog(): Promise<LogTask[]>

- Defined in src/endpoints/backup.ts:81
Method returns list and statuses of tasks for recovery and downloading.

Returns Promise<LogTask[]>

getMysqlBackupList

getMysqlBackupList(): Promise<FileBackup[]>

- Defined in src/endpoints/backup.ts:25
Method returns available list of mysql database backups

Returns Promise<FileBackup[]>

getMysqlList

getMysqlList(params?: Pick<Mysql, "backup_id">): Promise<string[]>

- Defined in src/endpoints/backup.ts:41
Method returns a list of databases from backup respective given identifier.

Parameters
- Optional params: Pick<Mysql, "backup_id">
Returns Promise<string[]>

Returns list of database names.

Private method

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

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

restoreFile

restoreFile(params?: Pick<Mysql, "backup_id" | "paths">): Promise<boolean>

- Defined in src/endpoints/backup.ts:50
Method creates query for data restoring from backup according to given path and backup copy.

Parameters
- Optional params: Pick<Mysql, "backup_id" | "paths">
Returns Promise<boolean>

Returns property of successful or unsuccessful execution.

restoreMysql

restoreMysql(params?: Pick<Mysql, "backup_id" | "bases">): Promise<boolean>

- Defined in src/endpoints/backup.ts:59
Method creates query for DB recovery from backup according to given DB name and backup identifier.

Parameters
- Optional params: Pick<Mysql, "backup_id" | "bases">
Returns Promise<boolean>

Returns property of successful or unsuccessful execution.

Generated using TypeDoc