Class DatabaseClient

Hierarchy

DatabaseClient

Index

Constructors

constructor

Methods

Constructors

constructor

new DatabaseClient(_request: IRequest): DatabaseClient

- Defined in src/client/index.ts:322
Parameters
- _request: IRequest
Returns DatabaseClient

Methods

create

create(serverID: string, args: IClientServerDatabaseRequest): Promise<IClientServerDatabase>

- Defined in src/client/index.ts:337
Creates a new database

Parameters
- serverID: string
  
  Server Identifier
- args: IClientServerDatabaseRequest
  
  Create database arguments
Returns Promise<IClientServerDatabase>

delete

delete(serverID: string, databaseID: string): Promise<boolean>

- Defined in src/client/index.ts:345
Deletes the specified database

Parameters
- serverID: string
  
  Server Identifier
- databaseID: string
  
  Database Identifier/ID
Returns Promise<boolean>

getAll

getAll(serverID: string): Promise<IClientServerBackups[]>

- Defined in src/client/index.ts:330
Lists all schedules added to the server

Parameters
- serverID: string
  
  Server Identifier
Returns Promise<IClientServerBackups[]>

rotate

rotate(serverID: string, databaseID: string): Promise<IClientServerDatabase>

- Defined in src/client/index.ts:353
Changes the password of a specified database

Parameters
- serverID: string
  
  Server Identifier
- databaseID: string
  
  Database Identifier/ID
Returns Promise<IClientServerDatabase>

Generated using TypeDoc