com.databricks.sdk.service.database

Interface DatabaseService

@Generated
public interface DatabaseService

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

This is the high-level interface, that contains generated methods.

Evolving: this interface is under development. Method signatures may change.

Method Summary

Modifier and Type	Method and Description
DatabaseCatalog	createDatabaseCatalog(CreateDatabaseCatalogRequest createDatabaseCatalogRequest) Create a Database Catalog.
DatabaseInstance	createDatabaseInstance(CreateDatabaseInstanceRequest createDatabaseInstanceRequest) Create a Database Instance.
DatabaseInstanceRole	createDatabaseInstanceRole(CreateDatabaseInstanceRoleRequest createDatabaseInstanceRoleRequest) Create a role for a Database Instance.
DatabaseTable	createDatabaseTable(CreateDatabaseTableRequest createDatabaseTableRequest) Create a Database Table.
SyncedDatabaseTable	createSyncedDatabaseTable(CreateSyncedDatabaseTableRequest createSyncedDatabaseTableRequest) Create a Synced Database Table.
void	deleteDatabaseCatalog(DeleteDatabaseCatalogRequest deleteDatabaseCatalogRequest) Delete a Database Catalog.
void	deleteDatabaseInstance(DeleteDatabaseInstanceRequest deleteDatabaseInstanceRequest) Delete a Database Instance.
void	deleteDatabaseInstanceRole(DeleteDatabaseInstanceRoleRequest deleteDatabaseInstanceRoleRequest) Deletes a role for a Database Instance.
void	deleteDatabaseTable(DeleteDatabaseTableRequest deleteDatabaseTableRequest) Delete a Database Table.
void	deleteSyncedDatabaseTable(DeleteSyncedDatabaseTableRequest deleteSyncedDatabaseTableRequest) Delete a Synced Database Table.
DatabaseInstance	findDatabaseInstanceByUid(FindDatabaseInstanceByUidRequest findDatabaseInstanceByUidRequest) Find a Database Instance by uid.
DatabaseCredential	generateDatabaseCredential(GenerateDatabaseCredentialRequest generateDatabaseCredentialRequest) Generates a credential that can be used to access database instances.
DatabaseCatalog	getDatabaseCatalog(GetDatabaseCatalogRequest getDatabaseCatalogRequest) Get a Database Catalog.
DatabaseInstance	getDatabaseInstance(GetDatabaseInstanceRequest getDatabaseInstanceRequest) Get a Database Instance.
DatabaseInstanceRole	getDatabaseInstanceRole(GetDatabaseInstanceRoleRequest getDatabaseInstanceRoleRequest) Gets a role for a Database Instance.
DatabaseTable	getDatabaseTable(GetDatabaseTableRequest getDatabaseTableRequest) Get a Database Table.
SyncedDatabaseTable	getSyncedDatabaseTable(GetSyncedDatabaseTableRequest getSyncedDatabaseTableRequest) Get a Synced Database Table.
ListDatabaseCatalogsResponse	listDatabaseCatalogs(ListDatabaseCatalogsRequest listDatabaseCatalogsRequest) This API is currently unimplemented, but exposed for Terraform support.
ListDatabaseInstanceRolesResponse	listDatabaseInstanceRoles(ListDatabaseInstanceRolesRequest listDatabaseInstanceRolesRequest) START OF PG ROLE APIs Section These APIs are marked a PUBLIC with stage < PUBLIC_PREVIEW.
ListDatabaseInstancesResponse	listDatabaseInstances(ListDatabaseInstancesRequest listDatabaseInstancesRequest) List Database Instances.
ListSyncedDatabaseTablesResponse	listSyncedDatabaseTables(ListSyncedDatabaseTablesRequest listSyncedDatabaseTablesRequest) This API is currently unimplemented, but exposed for Terraform support.
DatabaseCatalog	updateDatabaseCatalog(UpdateDatabaseCatalogRequest updateDatabaseCatalogRequest) This API is currently unimplemented, but exposed for Terraform support.
DatabaseInstance	updateDatabaseInstance(UpdateDatabaseInstanceRequest updateDatabaseInstanceRequest) Update a Database Instance.
SyncedDatabaseTable	updateSyncedDatabaseTable(UpdateSyncedDatabaseTableRequest updateSyncedDatabaseTableRequest) This API is currently unimplemented, but exposed for Terraform support.

Method Detail

createDatabaseCatalog

DatabaseCatalog createDatabaseCatalog(CreateDatabaseCatalogRequest createDatabaseCatalogRequest)

Create a Database Catalog.

createDatabaseInstance

DatabaseInstance createDatabaseInstance(CreateDatabaseInstanceRequest createDatabaseInstanceRequest)

Create a Database Instance.

createDatabaseInstanceRole

DatabaseInstanceRole createDatabaseInstanceRole(CreateDatabaseInstanceRoleRequest createDatabaseInstanceRoleRequest)

Create a role for a Database Instance.

createDatabaseTable

DatabaseTable createDatabaseTable(CreateDatabaseTableRequest createDatabaseTableRequest)

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.

createSyncedDatabaseTable

SyncedDatabaseTable createSyncedDatabaseTable(CreateSyncedDatabaseTableRequest createSyncedDatabaseTableRequest)

Create a Synced Database Table.

deleteDatabaseCatalog

void deleteDatabaseCatalog(DeleteDatabaseCatalogRequest deleteDatabaseCatalogRequest)

Delete a Database Catalog.

deleteDatabaseInstance

void deleteDatabaseInstance(DeleteDatabaseInstanceRequest deleteDatabaseInstanceRequest)

Delete a Database Instance.

deleteDatabaseInstanceRole

void deleteDatabaseInstanceRole(DeleteDatabaseInstanceRoleRequest deleteDatabaseInstanceRoleRequest)

Deletes a role for a Database Instance.

deleteDatabaseTable

void deleteDatabaseTable(DeleteDatabaseTableRequest deleteDatabaseTableRequest)

Delete a Database Table.

deleteSyncedDatabaseTable

void deleteSyncedDatabaseTable(DeleteSyncedDatabaseTableRequest deleteSyncedDatabaseTableRequest)

Delete a Synced Database Table.

findDatabaseInstanceByUid

DatabaseInstance findDatabaseInstanceByUid(FindDatabaseInstanceByUidRequest findDatabaseInstanceByUidRequest)

Find a Database Instance by uid.

generateDatabaseCredential

DatabaseCredential generateDatabaseCredential(GenerateDatabaseCredentialRequest generateDatabaseCredentialRequest)

Generates a credential that can be used to access database instances.

getDatabaseCatalog

DatabaseCatalog getDatabaseCatalog(GetDatabaseCatalogRequest getDatabaseCatalogRequest)

Get a Database Catalog.

getDatabaseInstance

DatabaseInstance getDatabaseInstance(GetDatabaseInstanceRequest getDatabaseInstanceRequest)

Get a Database Instance.

getDatabaseInstanceRole

DatabaseInstanceRole getDatabaseInstanceRole(GetDatabaseInstanceRoleRequest getDatabaseInstanceRoleRequest)

Gets a role for a Database Instance.

getDatabaseTable

DatabaseTable getDatabaseTable(GetDatabaseTableRequest getDatabaseTableRequest)

Get a Database Table.

getSyncedDatabaseTable

SyncedDatabaseTable getSyncedDatabaseTable(GetSyncedDatabaseTableRequest getSyncedDatabaseTableRequest)

Get a Synced Database Table.

listDatabaseCatalogs

ListDatabaseCatalogsResponse listDatabaseCatalogs(ListDatabaseCatalogsRequest listDatabaseCatalogsRequest)

This API is currently unimplemented, but exposed for Terraform support.

listDatabaseInstanceRoles

ListDatabaseInstanceRolesResponse listDatabaseInstanceRoles(ListDatabaseInstanceRolesRequest listDatabaseInstanceRolesRequest)

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.

listDatabaseInstances

ListDatabaseInstancesResponse listDatabaseInstances(ListDatabaseInstancesRequest listDatabaseInstancesRequest)

List Database Instances.

listSyncedDatabaseTables

ListSyncedDatabaseTablesResponse listSyncedDatabaseTables(ListSyncedDatabaseTablesRequest listSyncedDatabaseTablesRequest)

This API is currently unimplemented, but exposed for Terraform support.

updateDatabaseCatalog

DatabaseCatalog updateDatabaseCatalog(UpdateDatabaseCatalogRequest updateDatabaseCatalogRequest)

This API is currently unimplemented, but exposed for Terraform support.

updateDatabaseInstance

DatabaseInstance updateDatabaseInstance(UpdateDatabaseInstanceRequest updateDatabaseInstanceRequest)

Update a Database Instance.

updateSyncedDatabaseTable

SyncedDatabaseTable updateSyncedDatabaseTable(UpdateSyncedDatabaseTableRequest updateSyncedDatabaseTableRequest)

This API is currently unimplemented, but exposed for Terraform support.