com.databricks.sdk.service.database

Class DatabaseAPI

java.lang.Object

com.databricks.sdk.service.database.DatabaseAPI

@Generated
public class DatabaseAPI
extends Object

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

Constructor Summary

Constructors

Constructor and Description
DatabaseAPI(ApiClient apiClient) Regular-use constructor
DatabaseAPI(DatabaseService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
DatabaseCatalog	createDatabaseCatalog(CreateDatabaseCatalogRequest request) Create a Database Catalog.
Wait<DatabaseInstance,DatabaseInstance>	createDatabaseInstance(CreateDatabaseInstanceRequest request) Create a Database Instance.
DatabaseInstanceRole	createDatabaseInstanceRole(CreateDatabaseInstanceRoleRequest request) Create a role for a Database Instance.
DatabaseTable	createDatabaseTable(CreateDatabaseTableRequest request) Create a Database Table.
SyncedDatabaseTable	createSyncedDatabaseTable(CreateSyncedDatabaseTableRequest request) Create a Synced Database Table.
void	deleteDatabaseCatalog(DeleteDatabaseCatalogRequest request) Delete a Database Catalog.
void	deleteDatabaseCatalog(String name)
void	deleteDatabaseInstance(DeleteDatabaseInstanceRequest request) Delete a Database Instance.
void	deleteDatabaseInstance(String name)
void	deleteDatabaseInstanceRole(DeleteDatabaseInstanceRoleRequest request) Deletes a role for a Database Instance.
void	deleteDatabaseInstanceRole(String instanceName, String name)
void	deleteDatabaseTable(DeleteDatabaseTableRequest request) Delete a Database Table.
void	deleteDatabaseTable(String name)
void	deleteSyncedDatabaseTable(DeleteSyncedDatabaseTableRequest request) Delete a Synced Database Table.
void	deleteSyncedDatabaseTable(String name)
DatabaseInstance	findDatabaseInstanceByUid(FindDatabaseInstanceByUidRequest request) Find a Database Instance by uid.
DatabaseCredential	generateDatabaseCredential(GenerateDatabaseCredentialRequest request) Generates a credential that can be used to access database instances.
DatabaseCatalog	getDatabaseCatalog(GetDatabaseCatalogRequest request) Get a Database Catalog.
DatabaseCatalog	getDatabaseCatalog(String name)
DatabaseInstance	getDatabaseInstance(GetDatabaseInstanceRequest request) Get a Database Instance.
DatabaseInstance	getDatabaseInstance(String name)
DatabaseInstanceRole	getDatabaseInstanceRole(GetDatabaseInstanceRoleRequest request) Gets a role for a Database Instance.
DatabaseInstanceRole	getDatabaseInstanceRole(String instanceName, String name)
DatabaseTable	getDatabaseTable(GetDatabaseTableRequest request) Get a Database Table.
DatabaseTable	getDatabaseTable(String name)
SyncedDatabaseTable	getSyncedDatabaseTable(GetSyncedDatabaseTableRequest request) Get a Synced Database Table.
SyncedDatabaseTable	getSyncedDatabaseTable(String name)
DatabaseService	impl()
Iterable<DatabaseCatalog>	listDatabaseCatalogs(ListDatabaseCatalogsRequest request) This API is currently unimplemented, but exposed for Terraform support.
Iterable<DatabaseCatalog>	listDatabaseCatalogs(String instanceName)
Iterable<DatabaseInstanceRole>	listDatabaseInstanceRoles(ListDatabaseInstanceRolesRequest request) START OF PG ROLE APIs Section These APIs are marked a PUBLIC with stage < PUBLIC_PREVIEW.
Iterable<DatabaseInstanceRole>	listDatabaseInstanceRoles(String instanceName)
Iterable<DatabaseInstance>	listDatabaseInstances(ListDatabaseInstancesRequest request) List Database Instances.
Iterable<SyncedDatabaseTable>	listSyncedDatabaseTables(ListSyncedDatabaseTablesRequest request) This API is currently unimplemented, but exposed for Terraform support.
Iterable<SyncedDatabaseTable>	listSyncedDatabaseTables(String instanceName)
DatabaseCatalog	updateDatabaseCatalog(UpdateDatabaseCatalogRequest request) This API is currently unimplemented, but exposed for Terraform support.
DatabaseInstance	updateDatabaseInstance(UpdateDatabaseInstanceRequest request) Update a Database Instance.
SyncedDatabaseTable	updateSyncedDatabaseTable(UpdateSyncedDatabaseTableRequest request) This API is currently unimplemented, but exposed for Terraform support.
DatabaseInstance	waitGetDatabaseInstanceDatabaseAvailable(String name)
DatabaseInstance	waitGetDatabaseInstanceDatabaseAvailable(String name, Duration timeout, Consumer<DatabaseInstance> callback)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DatabaseAPI

public DatabaseAPI(ApiClient apiClient)

Regular-use constructor

DatabaseAPI

public DatabaseAPI(DatabaseService mock)

Constructor for mocks

Method Detail

waitGetDatabaseInstanceDatabaseAvailable

public DatabaseInstance waitGetDatabaseInstanceDatabaseAvailable(String name)
                                                          throws TimeoutException

Throws:

TimeoutException

waitGetDatabaseInstanceDatabaseAvailable

public DatabaseInstance waitGetDatabaseInstanceDatabaseAvailable(String name,
                                                                 Duration timeout,
                                                                 Consumer<DatabaseInstance> callback)
                                                          throws TimeoutException

Throws:

TimeoutException

createDatabaseCatalog

public DatabaseCatalog createDatabaseCatalog(CreateDatabaseCatalogRequest request)

Create a Database Catalog.

createDatabaseInstance

public Wait<DatabaseInstance,DatabaseInstance> createDatabaseInstance(CreateDatabaseInstanceRequest request)

Create a Database Instance.

createDatabaseInstanceRole

public DatabaseInstanceRole createDatabaseInstanceRole(CreateDatabaseInstanceRoleRequest request)

Create a role for a Database Instance.

createDatabaseTable

public DatabaseTable createDatabaseTable(CreateDatabaseTableRequest request)

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

public SyncedDatabaseTable createSyncedDatabaseTable(CreateSyncedDatabaseTableRequest request)

Create a Synced Database Table.

deleteDatabaseCatalog

public void deleteDatabaseCatalog(String name)

deleteDatabaseCatalog

public void deleteDatabaseCatalog(DeleteDatabaseCatalogRequest request)

Delete a Database Catalog.

deleteDatabaseInstance

public void deleteDatabaseInstance(String name)

deleteDatabaseInstance

public void deleteDatabaseInstance(DeleteDatabaseInstanceRequest request)

Delete a Database Instance.

deleteDatabaseInstanceRole

public void deleteDatabaseInstanceRole(String instanceName,
                                       String name)

deleteDatabaseInstanceRole

public void deleteDatabaseInstanceRole(DeleteDatabaseInstanceRoleRequest request)

Deletes a role for a Database Instance.

deleteDatabaseTable

public void deleteDatabaseTable(String name)

deleteDatabaseTable

public void deleteDatabaseTable(DeleteDatabaseTableRequest request)

Delete a Database Table.

deleteSyncedDatabaseTable

public void deleteSyncedDatabaseTable(String name)

deleteSyncedDatabaseTable

public void deleteSyncedDatabaseTable(DeleteSyncedDatabaseTableRequest request)

Delete a Synced Database Table.

findDatabaseInstanceByUid

public DatabaseInstance findDatabaseInstanceByUid(FindDatabaseInstanceByUidRequest request)

Find a Database Instance by uid.

generateDatabaseCredential

public DatabaseCredential generateDatabaseCredential(GenerateDatabaseCredentialRequest request)

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

getDatabaseCatalog

public DatabaseCatalog getDatabaseCatalog(String name)

getDatabaseCatalog

public DatabaseCatalog getDatabaseCatalog(GetDatabaseCatalogRequest request)

Get a Database Catalog.

getDatabaseInstance

public DatabaseInstance getDatabaseInstance(String name)

getDatabaseInstance

public DatabaseInstance getDatabaseInstance(GetDatabaseInstanceRequest request)

Get a Database Instance.

getDatabaseInstanceRole

public DatabaseInstanceRole getDatabaseInstanceRole(String instanceName,
                                                    String name)

getDatabaseInstanceRole

public DatabaseInstanceRole getDatabaseInstanceRole(GetDatabaseInstanceRoleRequest request)

Gets a role for a Database Instance.

getDatabaseTable

public DatabaseTable getDatabaseTable(String name)

getDatabaseTable

public DatabaseTable getDatabaseTable(GetDatabaseTableRequest request)

Get a Database Table.

getSyncedDatabaseTable

public SyncedDatabaseTable getSyncedDatabaseTable(String name)

getSyncedDatabaseTable

public SyncedDatabaseTable getSyncedDatabaseTable(GetSyncedDatabaseTableRequest request)

Get a Synced Database Table.

listDatabaseCatalogs

public Iterable<DatabaseCatalog> listDatabaseCatalogs(String instanceName)

listDatabaseCatalogs

public Iterable<DatabaseCatalog> listDatabaseCatalogs(ListDatabaseCatalogsRequest request)

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

listDatabaseInstanceRoles

public Iterable<DatabaseInstanceRole> listDatabaseInstanceRoles(String instanceName)

listDatabaseInstanceRoles

public Iterable<DatabaseInstanceRole> listDatabaseInstanceRoles(ListDatabaseInstanceRolesRequest request)

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

public Iterable<DatabaseInstance> listDatabaseInstances(ListDatabaseInstancesRequest request)

List Database Instances.

listSyncedDatabaseTables

public Iterable<SyncedDatabaseTable> listSyncedDatabaseTables(String instanceName)

listSyncedDatabaseTables

public Iterable<SyncedDatabaseTable> listSyncedDatabaseTables(ListSyncedDatabaseTablesRequest request)

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

updateDatabaseCatalog

public DatabaseCatalog updateDatabaseCatalog(UpdateDatabaseCatalogRequest request)

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

updateDatabaseInstance

public DatabaseInstance updateDatabaseInstance(UpdateDatabaseInstanceRequest request)

Update a Database Instance.

updateSyncedDatabaseTable

public SyncedDatabaseTable updateSyncedDatabaseTable(UpdateSyncedDatabaseTableRequest request)

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

impl

public DatabaseService impl()