DatabaseApi | @inetsoft/api-client

DatabaseApi provides operations used to manage the configuration database.

Hierarchy

DatabaseApi

Index

Methods

Methods

getDatabase

getDatabase(): Promise<DatabaseProperties>

- Defined in client/database/database-api.ts:79
Gets the configuration database settings.

Returns Promise<DatabaseProperties>

the database settings.

installSchema

installSchema(): Promise<void>

- Defined in client/database/database-api.ts:94
Installs the database schema. It is typically unnecessary to call this, as it is done automatically.

Returns Promise<void>

setDatabase

setDatabase(properties: DatabaseProperties): Promise<DatabaseProperties>

- Defined in client/database/database-api.ts:88
Sets the configuration database settings.

Parameters
- properties: DatabaseProperties
  
  the database settings.
Returns Promise<DatabaseProperties>

the updated database settings.

uninstallSchema

uninstallSchema(): Promise<void>

- Defined in client/database/database-api.ts:101
Uninstalls the database schema. Extreme caution should be used when uninstalling the schema. It causes all data to be irrevocably lost. It should never be done on a database that is currently being used as a data space because it will make that server unusable.

Returns Promise<void>

Generated using TypeDoc