Class DatabaseClient

Constructors

constructor

new DatabaseClient(options: ClientOptions): DatabaseClient
Parameters
- options: ClientOptions
Returns DatabaseClient
- Defined in client.ts:96

Methods

createDatabaseCatalog

createDatabaseCatalog(
req: CreateDatabaseCatalogRequest,
options?: CallOptions,
): Promise<DatabaseCatalog>
Create a Database Catalog.
Parameters
- req: CreateDatabaseCatalogRequest
- Optionaloptions: CallOptions
Returns Promise<DatabaseCatalog>
- Defined in client.ts:112

createDatabaseInstance

createDatabaseInstance(
req: CreateDatabaseInstanceRequest,
options?: CallOptions,
): Promise<CreateDatabaseInstanceWaiter>
Create a Database Instance.
Parameters
- req: CreateDatabaseInstanceRequest
- Optionaloptions: CallOptions
Returns Promise<CreateDatabaseInstanceWaiter>
- Defined in client.ts:175

createDatabaseInstanceRole

createDatabaseInstanceRole(
req: CreateDatabaseInstanceRoleRequest,
options?: CallOptions,
): Promise<DatabaseInstanceRole>
Create a role for a Database Instance.
Parameters
- req: CreateDatabaseInstanceRoleRequest
- Optionaloptions: CallOptions
Returns Promise<DatabaseInstanceRole>
- Defined in client.ts:187

createDatabaseTable

createDatabaseTable(
req: CreateDatabaseTableRequest,
options?: CallOptions,
): Promise<DatabaseTable>
Create a Database Table. Useful for registering pre-existing PG tables in UC. See CreateSyncedDatabaseTable for creating synced tables in PG from a source table in UC.
Parameters
- req: CreateDatabaseTableRequest
- Optionaloptions: CallOptions
Returns Promise<DatabaseTable>
- Defined in client.ts:235

createSyncedDatabaseTable

createSyncedDatabaseTable(
req: CreateSyncedDatabaseTableRequest,
options?: CallOptions,
): Promise<SyncedDatabaseTable>
Create a Synced Database Table.
Parameters
- req: CreateSyncedDatabaseTableRequest
- Optionaloptions: CallOptions
Returns Promise<SyncedDatabaseTable>
- Defined in client.ts:265

deleteDatabaseCatalog

deleteDatabaseCatalog(
req: DeleteDatabaseCatalogRequest,
options?: CallOptions,
): Promise<void>
Delete a Database Catalog.
Parameters
- req: DeleteDatabaseCatalogRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:298

deleteDatabaseInstance

deleteDatabaseInstance(
req: DeleteDatabaseInstanceRequest,
options?: CallOptions,
): Promise<void>
Delete a Database Instance.
Parameters
- req: DeleteDatabaseInstanceRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:321

deleteDatabaseInstanceRole

deleteDatabaseInstanceRole(
req: DeleteDatabaseInstanceRoleRequest,
options?: CallOptions,
): Promise<void>
Deletes a role for a Database Instance.
Parameters
- req: DeleteDatabaseInstanceRoleRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:353

deleteDatabaseTable

deleteDatabaseTable(
req: DeleteDatabaseTableRequest,
options?: CallOptions,
): Promise<void>
Delete a Database Table.
Parameters
- req: DeleteDatabaseTableRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:385

deleteSyncedDatabaseTable

deleteSyncedDatabaseTable(
req: DeleteSyncedDatabaseTableRequest,
options?: CallOptions,
): Promise<void>
Delete a Synced Database Table.
Parameters
- req: DeleteSyncedDatabaseTableRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:408

findDatabaseInstanceByUid

findDatabaseInstanceByUid(
req: FindDatabaseInstanceByUidRequest,
options?: CallOptions,
): Promise<DatabaseInstance>
Find a Database Instance by uid.
Parameters
- req: FindDatabaseInstanceByUidRequest
- Optionaloptions: CallOptions
Returns Promise<DatabaseInstance>
- Defined in client.ts:437

generateDatabaseCredential

generateDatabaseCredential(
req: GenerateDatabaseCredentialRequest,
options?: CallOptions,
): Promise<DatabaseCredential>
Generates a credential that can be used to access database instances.
Parameters
- req: GenerateDatabaseCredentialRequest
- Optionaloptions: CallOptions
Returns Promise<DatabaseCredential>
- Defined in client.ts:472

getDatabaseCatalog

getDatabaseCatalog(
req: GetDatabaseCatalogRequest,
options?: CallOptions,
): Promise<DatabaseCatalog>
Get a Database Catalog.
Parameters
- req: GetDatabaseCatalogRequest
- Optionaloptions: CallOptions
Returns Promise<DatabaseCatalog>
- Defined in client.ts:505

getDatabaseInstance

getDatabaseInstance(
req: GetDatabaseInstanceRequest,
options?: CallOptions,
): Promise<DatabaseInstance>
Get a Database Instance.
Parameters
- req: GetDatabaseInstanceRequest
- Optionaloptions: CallOptions
Returns Promise<DatabaseInstance>
- Defined in client.ts:534

getDatabaseInstanceRole

getDatabaseInstanceRole(
req: GetDatabaseInstanceRoleRequest,
options?: CallOptions,
): Promise<DatabaseInstanceRole>
Gets a role for a Database Instance.
Parameters
- req: GetDatabaseInstanceRoleRequest
- Optionaloptions: CallOptions
Returns Promise<DatabaseInstanceRole>
- Defined in client.ts:563

getDatabaseTable

getDatabaseTable(
req: GetDatabaseTableRequest,
options?: CallOptions,
): Promise<DatabaseTable>
Get a Database Table.
Parameters
- req: GetDatabaseTableRequest
- Optionaloptions: CallOptions
Returns Promise<DatabaseTable>
- Defined in client.ts:592

getSyncedDatabaseTable

getSyncedDatabaseTable(
req: GetSyncedDatabaseTableRequest,
options?: CallOptions,
): Promise<SyncedDatabaseTable>
Get a Synced Database Table.
Parameters
- req: GetSyncedDatabaseTableRequest
- Optionaloptions: CallOptions
Returns Promise<SyncedDatabaseTable>
- Defined in client.ts:621

listDatabaseCatalogs

listDatabaseCatalogs(
req: ListDatabaseCatalogsRequest,
options?: CallOptions,
): Promise<ListDatabaseCatalogsResponse>
This API is currently unimplemented, but exposed for Terraform support.
Parameters
- req: ListDatabaseCatalogsRequest
- Optionaloptions: CallOptions
Returns Promise<ListDatabaseCatalogsResponse>
- Defined in client.ts:650

listDatabaseCatalogsIter

listDatabaseCatalogsIter(
req: ListDatabaseCatalogsRequest,
options?: CallOptions,
): AsyncGenerator<DatabaseCatalog>
Parameters
- req: ListDatabaseCatalogsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<DatabaseCatalog>
- Defined in client.ts:690

listDatabaseInstanceRoles

listDatabaseInstanceRoles(
req: ListDatabaseInstanceRolesRequest,
options?: CallOptions,
): Promise<ListDatabaseInstanceRolesResponse>
START OF PG ROLE APIs Section These APIs are marked a PUBLIC with stage < PUBLIC_PREVIEW. With more recent Lakebase V2 plans, we don't plan to ever advance these to PUBLIC_PREVIEW. These APIs will remain effectively undocumented/UI-only and we'll aim for a new public roles API as part of V2 PuPr.
Parameters
- req: ListDatabaseInstanceRolesRequest
- Optionaloptions: CallOptions
Returns Promise<ListDatabaseInstanceRolesResponse>
- Defined in client.ts:713

listDatabaseInstanceRolesIter

listDatabaseInstanceRolesIter(
req: ListDatabaseInstanceRolesRequest,
options?: CallOptions,
): AsyncGenerator<DatabaseInstanceRole>
Parameters
- req: ListDatabaseInstanceRolesRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<DatabaseInstanceRole>
- Defined in client.ts:753

listDatabaseInstances

listDatabaseInstances(
req: ListDatabaseInstancesRequest,
options?: CallOptions,
): Promise<ListDatabaseInstancesResponse>
List Database Instances.
Parameters
- req: ListDatabaseInstancesRequest
- Optionaloptions: CallOptions
Returns Promise<ListDatabaseInstancesResponse>
- Defined in client.ts:771

listDatabaseInstancesIter

listDatabaseInstancesIter(
req: ListDatabaseInstancesRequest,
options?: CallOptions,
): AsyncGenerator<DatabaseInstance>
Parameters
- req: ListDatabaseInstancesRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<DatabaseInstance>
- Defined in client.ts:811

listSyncedDatabaseTables

listSyncedDatabaseTables(
req: ListSyncedDatabaseTablesRequest,
options?: CallOptions,
): Promise<ListSyncedDatabaseTablesResponse>
This API is currently unimplemented, but exposed for Terraform support.
Parameters
- req: ListSyncedDatabaseTablesRequest
- Optionaloptions: CallOptions
Returns Promise<ListSyncedDatabaseTablesResponse>
- Defined in client.ts:829

listSyncedDatabaseTablesIter

listSyncedDatabaseTablesIter(
req: ListSyncedDatabaseTablesRequest,
options?: CallOptions,
): AsyncGenerator<SyncedDatabaseTable>
Parameters
- req: ListSyncedDatabaseTablesRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<SyncedDatabaseTable>
- Defined in client.ts:869

updateDatabaseCatalog

updateDatabaseCatalog(
req: UpdateDatabaseCatalogRequest,
options?: CallOptions,
): Promise<DatabaseCatalog>
This API is currently unimplemented, but exposed for Terraform support.
Parameters
- req: UpdateDatabaseCatalogRequest
- Optionaloptions: CallOptions
Returns Promise<DatabaseCatalog>
- Defined in client.ts:887

updateDatabaseInstance

updateDatabaseInstance(
req: UpdateDatabaseInstanceRequest,
options?: CallOptions,
): Promise<DatabaseInstance>
Update a Database Instance.
Parameters
- req: UpdateDatabaseInstanceRequest
- Optionaloptions: CallOptions
Returns Promise<DatabaseInstance>
- Defined in client.ts:932

updateSyncedDatabaseTable

updateSyncedDatabaseTable(
req: UpdateSyncedDatabaseTableRequest,
options?: CallOptions,
): Promise<SyncedDatabaseTable>
This API is currently unimplemented, but exposed for Terraform support.
Parameters
- req: UpdateSyncedDatabaseTableRequest
- Optionaloptions: CallOptions
Returns Promise<SyncedDatabaseTable>
- Defined in client.ts:977

Class DatabaseClient

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns DatabaseClient

Methods

createDatabaseCatalog

Parameters

Returns Promise<DatabaseCatalog>

createDatabaseInstance

Parameters

Returns Promise<CreateDatabaseInstanceWaiter>

createDatabaseInstanceRole

Parameters

Returns Promise<DatabaseInstanceRole>

createDatabaseTable

Parameters

Returns Promise<DatabaseTable>

createSyncedDatabaseTable

Parameters

Returns Promise<SyncedDatabaseTable>

deleteDatabaseCatalog

Parameters

Returns Promise<void>

deleteDatabaseInstance

Parameters

Returns Promise<void>

deleteDatabaseInstanceRole

Parameters

Returns Promise<void>

deleteDatabaseTable

Parameters

Returns Promise<void>

deleteSyncedDatabaseTable

Parameters

Returns Promise<void>

findDatabaseInstanceByUid

Parameters

Returns Promise<DatabaseInstance>

generateDatabaseCredential

Parameters

Returns Promise<DatabaseCredential>

getDatabaseCatalog

Parameters

Returns Promise<DatabaseCatalog>

getDatabaseInstance

Parameters

Returns Promise<DatabaseInstance>

getDatabaseInstanceRole

Parameters

Returns Promise<DatabaseInstanceRole>

getDatabaseTable

Parameters

Returns Promise<DatabaseTable>

getSyncedDatabaseTable

Parameters

Returns Promise<SyncedDatabaseTable>

listDatabaseCatalogs

Parameters

Returns Promise<ListDatabaseCatalogsResponse>

listDatabaseCatalogsIter

Parameters

Returns AsyncGenerator<DatabaseCatalog>

listDatabaseInstanceRoles

Parameters

Returns Promise<ListDatabaseInstanceRolesResponse>

listDatabaseInstanceRolesIter

Parameters

Returns AsyncGenerator<DatabaseInstanceRole>

listDatabaseInstances

Parameters

Returns Promise<ListDatabaseInstancesResponse>

listDatabaseInstancesIter

Parameters

Returns AsyncGenerator<DatabaseInstance>

listSyncedDatabaseTables

Parameters