js-bao-wss-client / DatabaseTypeConfigsAPI
Interface: DatabaseTypeConfigsAPI
Sub-API for database type configurations (client.databaseTypeConfigs.*). A configuration controls behavior for all databases of a given databaseType: which rule set governs access, which CEL-driven triggers run on writes, and how metadata access is gated.
Methods
create()
create(
params):Promise<DatabaseTypeConfigInfo>
Creates a new database type configuration.
Parameters
params
CreateDatabaseTypeConfigParams
Configuration for the new database type
Returns
Promise<DatabaseTypeConfigInfo>
delete()
delete(
databaseType):Promise<{success:boolean; }>
Deletes a database type configuration.
Parameters
databaseType
string
The database type identifier to delete
Returns
Promise<{ success: boolean; }>
get()
get(
databaseType):Promise<DatabaseTypeConfigInfo>
Retrieves the configuration for a specific database type.
Parameters
databaseType
string
The database type identifier to look up
Returns
Promise<DatabaseTypeConfigInfo>
list()
list():
Promise<DatabaseTypeConfigInfo[]>
Lists all database type configurations for the current app.
Returns
Promise<DatabaseTypeConfigInfo[]>
update()
update(
databaseType,params):Promise<DatabaseTypeConfigInfo>
Updates an existing database type configuration.
Parameters
databaseType
string
The database type identifier to update
params
UpdateDatabaseTypeConfigParams
Fields to update on the database type configuration
Returns
Promise<DatabaseTypeConfigInfo>