Class default`Abstract`

Abstract class outlining Database API operations supported by the SDK.

Hierarchy

default
- default

Index

Constructors

Methods

createDatabase deleteDatabase getAllDatabases getDatabase

Constructors

constructor

new default(): default
Returns default

Methods

`Abstract` 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>
- Defined in src/databases/databasesApiClient.ts:29

`Abstract` 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>
- Defined in src/databases/databasesApiClient.ts:40

`Abstract` getAllDatabases

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

Returns
- All databases for the user.
Returns Promise<default[]>
- Defined in src/databases/databasesApiClient.ts:12

`Abstract` 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>
- Defined in src/databases/databasesApiClient.ts:19

Generated using TypeDoc