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.

For new workloads, Databricks recommends the Postgres API equivalent: Create a catalog.
Parameters
- req: CreateDatabaseCatalogRequest
- Optionaloptions: CallOptions
Returns Promise<DatabaseCatalog>
- Defined in client.ts:117

createDatabaseInstance

createDatabaseInstance(
req: CreateDatabaseInstanceRequest,
options?: CallOptions,
): Promise<CreateDatabaseInstanceWaiter>
Create a Database Instance.

For new workloads, Databricks recommends the Postgres API equivalent: Create a project.
Parameters
- req: CreateDatabaseInstanceRequest
- Optionaloptions: CallOptions
Returns Promise<CreateDatabaseInstanceWaiter>
- Defined in client.ts:190

createDatabaseInstanceRole

createDatabaseInstanceRole(
req: CreateDatabaseInstanceRoleRequest,
options?: CallOptions,
): Promise<DatabaseInstanceRole>
Create a role for a Database Instance.

For new workloads, Databricks recommends the Postgres API equivalent: Create a role.
Parameters
- req: CreateDatabaseInstanceRoleRequest
- Optionaloptions: CallOptions
Returns Promise<DatabaseInstanceRole>
- Defined in client.ts:207

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:255

createSyncedDatabaseTable

createSyncedDatabaseTable(
req: CreateSyncedDatabaseTableRequest,
options?: CallOptions,
): Promise<SyncedDatabaseTable>
Create a Synced Database Table.

For new workloads, Databricks recommends the Postgres API equivalent: Create a synced table.
Parameters
- req: CreateSyncedDatabaseTableRequest
- Optionaloptions: CallOptions
Returns Promise<SyncedDatabaseTable>
- Defined in client.ts:290

deleteDatabaseCatalog

deleteDatabaseCatalog(
req: DeleteDatabaseCatalogRequest,
options?: CallOptions,
): Promise<void>
Delete a Database Catalog.

For new workloads, Databricks recommends the Postgres API equivalent: Delete a catalog.
Parameters
- req: DeleteDatabaseCatalogRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:328

deleteDatabaseInstance

deleteDatabaseInstance(
req: DeleteDatabaseInstanceRequest,
options?: CallOptions,
): Promise<void>
Delete a Database Instance.

For new workloads, Databricks recommends the Postgres API equivalent: Delete a project.
Parameters
- req: DeleteDatabaseInstanceRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:356

deleteDatabaseInstanceRole

deleteDatabaseInstanceRole(
req: DeleteDatabaseInstanceRoleRequest,
options?: CallOptions,
): Promise<void>
Deletes a role for a Database Instance.

For new workloads, Databricks recommends the Postgres API equivalent: Delete a role.
Parameters
- req: DeleteDatabaseInstanceRoleRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:393

deleteDatabaseTable

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

deleteSyncedDatabaseTable

deleteSyncedDatabaseTable(
req: DeleteSyncedDatabaseTableRequest,
options?: CallOptions,
): Promise<void>
Delete a Synced Database Table.

For new workloads, Databricks recommends the Postgres API equivalent: Delete a synced table.
Parameters
- req: DeleteSyncedDatabaseTableRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:453

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:482

generateDatabaseCredential

generateDatabaseCredential(
req: GenerateDatabaseCredentialRequest,
options?: CallOptions,
): Promise<DatabaseCredential>
Generates a credential that can be used to access database instances.

For new workloads, Databricks recommends the Postgres API equivalent: Generate a database credential.
Parameters
- req: GenerateDatabaseCredentialRequest
- Optionaloptions: CallOptions
Returns Promise<DatabaseCredential>
- Defined in client.ts:522

getDatabaseCatalog

getDatabaseCatalog(
req: GetDatabaseCatalogRequest,
options?: CallOptions,
): Promise<DatabaseCatalog>
Get a Database Catalog.

For new workloads, Databricks recommends the Postgres API equivalent: Get a catalog.
Parameters
- req: GetDatabaseCatalogRequest
- Optionaloptions: CallOptions
Returns Promise<DatabaseCatalog>
- Defined in client.ts:560

getDatabaseInstance

getDatabaseInstance(
req: GetDatabaseInstanceRequest,
options?: CallOptions,
): Promise<DatabaseInstance>
Get a Database Instance.

For new workloads, Databricks recommends the Postgres API equivalent: Get a project.
Parameters
- req: GetDatabaseInstanceRequest
- Optionaloptions: CallOptions
Returns Promise<DatabaseInstance>
- Defined in client.ts:594

getDatabaseInstanceRole

getDatabaseInstanceRole(
req: GetDatabaseInstanceRoleRequest,
options?: CallOptions,
): Promise<DatabaseInstanceRole>
Gets a role for a Database Instance.

For new workloads, Databricks recommends the Postgres API equivalent: Get a role.
Parameters
- req: GetDatabaseInstanceRoleRequest
- Optionaloptions: CallOptions
Returns Promise<DatabaseInstanceRole>
- Defined in client.ts:628

getDatabaseTable

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

getSyncedDatabaseTable

getSyncedDatabaseTable(
req: GetSyncedDatabaseTableRequest,
options?: CallOptions,
): Promise<SyncedDatabaseTable>
Get a Synced Database Table.

For new workloads, Databricks recommends the Postgres API equivalent: Get a synced table.
Parameters
- req: GetSyncedDatabaseTableRequest
- Optionaloptions: CallOptions
Returns Promise<SyncedDatabaseTable>
- Defined in client.ts:691

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:720

listDatabaseCatalogsIter

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

listDatabaseInstanceRoles

listDatabaseInstanceRoles(
req: ListDatabaseInstanceRolesRequest,
options?: CallOptions,
): Promise<ListDatabaseInstanceRolesResponse>
List roles for a Database Instance.

For new workloads, Databricks recommends the Postgres API equivalent: List roles.
Parameters
- req: ListDatabaseInstanceRolesRequest
- Optionaloptions: CallOptions
Returns Promise<ListDatabaseInstanceRolesResponse>
- Defined in client.ts:783

listDatabaseInstanceRolesIter

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

listDatabaseInstances

listDatabaseInstances(
req: ListDatabaseInstancesRequest,
options?: CallOptions,
): Promise<ListDatabaseInstancesResponse>
List Database Instances.

For new workloads, Databricks recommends the Postgres API equivalent: List projects.
Parameters
- req: ListDatabaseInstancesRequest
- Optionaloptions: CallOptions
Returns Promise<ListDatabaseInstancesResponse>
- Defined in client.ts:846

listDatabaseInstancesIter

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

listSyncedDatabaseTables

listSyncedDatabaseTables(
req: ListSyncedDatabaseTablesRequest,
options?: CallOptions,
): Promise<ListSyncedDatabaseTablesResponse>
List synced database tables in a Database Instance.
Parameters
- req: ListSyncedDatabaseTablesRequest
- Optionaloptions: CallOptions
Returns Promise<ListSyncedDatabaseTablesResponse>
- Defined in client.ts:904

listSyncedDatabaseTablesIter

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

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:962

updateDatabaseInstance

updateDatabaseInstance(
req: UpdateDatabaseInstanceRequest,
options?: CallOptions,
): Promise<DatabaseInstance>
Update a Database Instance.

For new workloads, Databricks recommends the Postgres API equivalents: Update a project and Update an endpoint.
Parameters
- req: UpdateDatabaseInstanceRequest
- Optionaloptions: CallOptions
Returns Promise<DatabaseInstance>
- Defined in client.ts:1013

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:1058