w.database_instances: Database Instances

class databricks.sdk.service.catalog.DatabaseInstancesAPI

Database Instances provide access to a database via REST API or direct SQL.

create_database_catalog(catalog: DatabaseCatalog) → DatabaseCatalog

Create a Database Catalog.

Parameters:

catalog – DatabaseCatalog

Returns:

DatabaseCatalog

create_database_instance(database_instance: DatabaseInstance) → DatabaseInstance

Create a Database Instance.

Parameters:

database_instance – DatabaseInstance A DatabaseInstance represents a logical Postgres instance, comprised of both compute and storage.

Returns:

DatabaseInstance

create_synced_database_table(synced_table: SyncedDatabaseTable) → SyncedDatabaseTable

Create a Synced Database Table.

Parameters:

synced_table – SyncedDatabaseTable Next field marker: 10

Returns:

SyncedDatabaseTable

delete_database_catalog(name: str)

Delete a Database Catalog.

Parameters:

name – str

delete_database_instance(name: str [, force: Optional[bool], purge: Optional[bool]])

Delete a Database Instance.

Parameters:

  • name – str Name of the instance to delete.

  • force – bool (optional) By default, a instance cannot be deleted if it has descendant instances created via PITR. If this flag is specified as true, all descendent instances will be deleted as well.

  • purge – bool (optional) If false, the database instance is soft deleted. Soft deleted instances behave as if they are deleted, and cannot be used for CRUD operations nor connected to. However they can be undeleted by calling the undelete API for a limited time. If true, the database instance is hard deleted and cannot be undeleted.

delete_synced_database_table(name: str)

Delete a Synced Database Table.

Parameters:

name – str

find_database_instance_by_uid([, uid: Optional[str]]) → DatabaseInstance

Find a Database Instance by uid.

Parameters:

uid – str (optional) UID of the cluster to get.

Returns:

DatabaseInstance

get_database_catalog(name: str) → DatabaseCatalog

Get a Database Catalog.

Parameters:

name – str

Returns:

DatabaseCatalog

get_database_instance(name: str) → DatabaseInstance

Get a Database Instance.

Parameters:

name – str Name of the cluster to get.

Returns:

DatabaseInstance

get_synced_database_table(name: str) → SyncedDatabaseTable

Get a Synced Database Table.

Parameters:

name – str

Returns:

SyncedDatabaseTable

list_database_instances([, page_size: Optional[int], page_token: Optional[str]]) → Iterator[DatabaseInstance]

List Database Instances.

Parameters:

  • page_size – int (optional) Upper bound for items returned.

  • page_token – str (optional) Pagination token to go to the next page of Database Instances. Requests first page if absent.

Returns:

Iterator over DatabaseInstance

update_database_instance(name: str, database_instance: DatabaseInstance, update_mask: str) → DatabaseInstance

Update a Database Instance.

Parameters:

  • name – str The name of the instance. This is the unique identifier for the instance.

  • database_instance – DatabaseInstance A DatabaseInstance represents a logical Postgres instance, comprised of both compute and storage.

  • update_mask – str The list of fields to update.

Returns:

DatabaseInstance