Class default

Implementation of DatabasesApiClient that goes through the REST API.

Hierarchy

default
- default

Index

Constructors

Properties

Methods

createDatabase deleteDatabase getAllDatabases getDatabase

Constructors

constructor

new default(sqlClient: default): default
Parameters
- sqlClient: default
  
  SQL API client to send all SQL query requests.
Returns default
Overrides default.constructor
- Defined in src/databases/databasesRestApiClient.ts:18

Properties

sqlClient

sqlClient: default

SQL API client to send all SQL query requests.

Methods

createDatabase

createDatabase(name: string, engine?: string, params?: Record<string, JsonValue>): Promise<default>
Creates a database with the given name, engine, and parameters.

Returns
- Newly created database.
Throws
- Something went wrong creating the database.
Parameters
- name: string
  
  Name of the database to be created.
- Optional engine: string
  
  Optional name of the database engine.
- Optional params: Record<string, JsonValue>
  
  Optional parameters used to connect to the database (e.g. user, password).
Returns Promise<default>
Overrides default.createDatabase
- Defined in src/databases/databasesRestApiClient.ts:65

deleteDatabase

deleteDatabase(name: string): Promise<void>
Deletes a database by name.

Throws
- Something went wrong deleting the database.
Parameters
- name: string
  
  Name of the database to be deleted.
Returns Promise<void>
Overrides default.deleteDatabase
- Defined in src/databases/databasesRestApiClient.ts:101

getAllDatabases

getAllDatabases(): Promise<default[]>
Gets all databases for the authenticated user.

Returns
- All databases for the user.
Returns Promise<default[]>
Overrides default.getAllDatabases
- Defined in src/databases/databasesRestApiClient.ts:27

getDatabase

getDatabase(name: string): Promise<undefined | default>
Gets a database by name for the authenticated user.

Returns
- Matching database, or undefined if it doesn't exist.
Parameters
- name: string
  
  Name of the database.
Returns Promise<undefined | default>
Overrides default.getDatabase
- Defined in src/databases/databasesRestApiClient.ts:40

Generated using TypeDoc