com.databricks.sdk.service.postgres

Class PostgresAPI

java.lang.Object

com.databricks.sdk.service.postgres.PostgresAPI

@Generated
public class PostgresAPI
extends Object

Use the Postgres API to create and manage Lakebase Autoscaling Postgres infrastructure, including projects, branches, compute endpoints, and roles.

This API manages database infrastructure only. To query or modify data, use the Data API or direct SQL connections.

**About resource IDs and names**

Resources are identified by hierarchical resource names like `projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}`. The `name` field on each resource contains this full path and is output-only. Note that `name` refers to this resource path, not the user-visible `display_name`.

Constructor Summary

Constructors

Constructor and Description
PostgresAPI(ApiClient apiClient) Regular-use constructor
PostgresAPI(PostgresService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
CreateBranchOperation	createBranch(CreateBranchRequest request) Creates a new database branch in the project.
CreateCatalogOperation	createCatalog(CreateCatalogRequest request) Register a Postgres database in the Unity Catalog.
CreateDatabaseOperation	createDatabase(CreateDatabaseRequest request) Create a Database.
CreateEndpointOperation	createEndpoint(CreateEndpointRequest request) Creates a new compute endpoint in the branch.
CreateProjectOperation	createProject(CreateProjectRequest request) Creates a new Lakebase Autoscaling Postgres database project, which contains branches and compute endpoints.
CreateRoleOperation	createRole(CreateRoleRequest request) Creates a new Postgres role in the branch.
CreateSyncedTableOperation	createSyncedTable(CreateSyncedTableRequest request) Create a Synced Table.
DeleteBranchOperation	deleteBranch(DeleteBranchRequest request) Deletes the specified database branch.
DeleteBranchOperation	deleteBranch(String name)
DeleteCatalogOperation	deleteCatalog(DeleteCatalogRequest request) Delete a Database Catalog.
DeleteCatalogOperation	deleteCatalog(String name)
DeleteDatabaseOperation	deleteDatabase(DeleteDatabaseRequest request) Delete a Database.
DeleteDatabaseOperation	deleteDatabase(String name)
DeleteEndpointOperation	deleteEndpoint(DeleteEndpointRequest request) Deletes the specified compute endpoint.
DeleteEndpointOperation	deleteEndpoint(String name)
DeleteProjectOperation	deleteProject(DeleteProjectRequest request) Deletes the specified database project.
DeleteProjectOperation	deleteProject(String name)
DeleteRoleOperation	deleteRole(DeleteRoleRequest request) Deletes the specified Postgres role.
DeleteRoleOperation	deleteRole(String name)
DeleteSyncedTableOperation	deleteSyncedTable(DeleteSyncedTableRequest request) Delete a Synced Table.
DeleteSyncedTableOperation	deleteSyncedTable(String name)
DatabaseCredential	generateDatabaseCredential(GenerateDatabaseCredentialRequest request) Generate OAuth credentials for a Postgres database.
Branch	getBranch(GetBranchRequest request) Retrieves information about the specified database branch.
Branch	getBranch(String name)
Catalog	getCatalog(GetCatalogRequest request) Get a Database Catalog.
Catalog	getCatalog(String name)
Database	getDatabase(GetDatabaseRequest request) Get a Database.
Database	getDatabase(String name)
Endpoint	getEndpoint(GetEndpointRequest request) Retrieves information about the specified compute endpoint, including its connection details and operational state.
Endpoint	getEndpoint(String name)
Operation	getOperation(GetOperationRequest request) Retrieves the status of a long-running operation.
Operation	getOperation(String name)
Project	getProject(GetProjectRequest request) Retrieves information about the specified database project.
Project	getProject(String name)
Role	getRole(GetRoleRequest request) Retrieves information about the specified Postgres role, including its authentication method and permissions.
Role	getRole(String name)
SyncedTable	getSyncedTable(GetSyncedTableRequest request) Get a Synced Table.
SyncedTable	getSyncedTable(String name)
PostgresService	impl()
Iterable<Branch>	listBranches(ListBranchesRequest request) Returns a paginated list of database branches in the project.
Iterable<Branch>	listBranches(String parent)
Iterable<Database>	listDatabases(ListDatabasesRequest request) List Databases.
Iterable<Database>	listDatabases(String parent)
Iterable<Endpoint>	listEndpoints(ListEndpointsRequest request) Returns a paginated list of compute endpoints in the branch.
Iterable<Endpoint>	listEndpoints(String parent)
Iterable<Project>	listProjects(ListProjectsRequest request) Returns a paginated list of database projects in the workspace that the user has permission to access.
Iterable<Role>	listRoles(ListRolesRequest request) Returns a paginated list of Postgres roles in the branch.
Iterable<Role>	listRoles(String parent)
UndeleteProjectOperation	undeleteProject(UndeleteProjectRequest request) Undeletes a soft-deleted project.
UpdateBranchOperation	updateBranch(UpdateBranchRequest request) Updates the specified database branch.
UpdateDatabaseOperation	updateDatabase(UpdateDatabaseRequest request) Update a Database.
UpdateEndpointOperation	updateEndpoint(UpdateEndpointRequest request) Updates the specified compute endpoint.
UpdateProjectOperation	updateProject(UpdateProjectRequest request) Updates the specified database project.
UpdateRoleOperation	updateRole(UpdateRoleRequest request) Update a role for a branch.

Methods inherited from class java.lang.Object

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

Constructor Detail

PostgresAPI

public PostgresAPI(ApiClient apiClient)

Regular-use constructor

PostgresAPI

public PostgresAPI(PostgresService mock)

Constructor for mocks

Method Detail

createBranch

public CreateBranchOperation createBranch(CreateBranchRequest request)

Creates a new database branch in the project.

createCatalog

public CreateCatalogOperation createCatalog(CreateCatalogRequest request)

Register a Postgres database in the Unity Catalog.

createDatabase

public CreateDatabaseOperation createDatabase(CreateDatabaseRequest request)

Create a Database.

Creates a database in the specified branch. A branch can have multiple databases.

createEndpoint

public CreateEndpointOperation createEndpoint(CreateEndpointRequest request)

Creates a new compute endpoint in the branch.

createProject

public CreateProjectOperation createProject(CreateProjectRequest request)

Creates a new Lakebase Autoscaling Postgres database project, which contains branches and compute endpoints.

createRole

public CreateRoleOperation createRole(CreateRoleRequest request)

Creates a new Postgres role in the branch.

createSyncedTable

public CreateSyncedTableOperation createSyncedTable(CreateSyncedTableRequest request)

Create a Synced Table.

deleteBranch

public DeleteBranchOperation deleteBranch(String name)

deleteBranch

public DeleteBranchOperation deleteBranch(DeleteBranchRequest request)

Deletes the specified database branch.

deleteCatalog

public DeleteCatalogOperation deleteCatalog(String name)

deleteCatalog

public DeleteCatalogOperation deleteCatalog(DeleteCatalogRequest request)

Delete a Database Catalog.

deleteDatabase

public DeleteDatabaseOperation deleteDatabase(String name)

deleteDatabase

public DeleteDatabaseOperation deleteDatabase(DeleteDatabaseRequest request)

Delete a Database.

deleteEndpoint

public DeleteEndpointOperation deleteEndpoint(String name)

deleteEndpoint

public DeleteEndpointOperation deleteEndpoint(DeleteEndpointRequest request)

Deletes the specified compute endpoint.

deleteProject

public DeleteProjectOperation deleteProject(String name)

deleteProject

public DeleteProjectOperation deleteProject(DeleteProjectRequest request)

Deletes the specified database project.

deleteRole

public DeleteRoleOperation deleteRole(String name)

deleteRole

public DeleteRoleOperation deleteRole(DeleteRoleRequest request)

Deletes the specified Postgres role.

deleteSyncedTable

public DeleteSyncedTableOperation deleteSyncedTable(String name)

deleteSyncedTable

public DeleteSyncedTableOperation deleteSyncedTable(DeleteSyncedTableRequest request)

Delete a Synced Table.

generateDatabaseCredential

public DatabaseCredential generateDatabaseCredential(GenerateDatabaseCredentialRequest request)

Generate OAuth credentials for a Postgres database.

getBranch

public Branch getBranch(String name)

getBranch

public Branch getBranch(GetBranchRequest request)

Retrieves information about the specified database branch.

getCatalog

public Catalog getCatalog(String name)

getCatalog

public Catalog getCatalog(GetCatalogRequest request)

Get a Database Catalog.

getDatabase

public Database getDatabase(String name)

getDatabase

public Database getDatabase(GetDatabaseRequest request)

Get a Database.

getEndpoint

public Endpoint getEndpoint(String name)

getEndpoint

public Endpoint getEndpoint(GetEndpointRequest request)

Retrieves information about the specified compute endpoint, including its connection details and operational state.

getOperation

public Operation getOperation(String name)

getOperation

public Operation getOperation(GetOperationRequest request)

Retrieves the status of a long-running operation.

getProject

public Project getProject(String name)

getProject

public Project getProject(GetProjectRequest request)

Retrieves information about the specified database project.

getRole

public Role getRole(String name)

getRole

public Role getRole(GetRoleRequest request)

Retrieves information about the specified Postgres role, including its authentication method and permissions.

getSyncedTable

public SyncedTable getSyncedTable(String name)

getSyncedTable

public SyncedTable getSyncedTable(GetSyncedTableRequest request)

Get a Synced Table.

listBranches

public Iterable<Branch> listBranches(String parent)

listBranches

public Iterable<Branch> listBranches(ListBranchesRequest request)

Returns a paginated list of database branches in the project.

listDatabases

public Iterable<Database> listDatabases(String parent)

listDatabases

public Iterable<Database> listDatabases(ListDatabasesRequest request)

List Databases.

listEndpoints

public Iterable<Endpoint> listEndpoints(String parent)

listEndpoints

public Iterable<Endpoint> listEndpoints(ListEndpointsRequest request)

Returns a paginated list of compute endpoints in the branch.

listProjects

public Iterable<Project> listProjects(ListProjectsRequest request)

Returns a paginated list of database projects in the workspace that the user has permission to access.

listRoles

public Iterable<Role> listRoles(String parent)

listRoles

public Iterable<Role> listRoles(ListRolesRequest request)

Returns a paginated list of Postgres roles in the branch.

undeleteProject

public UndeleteProjectOperation undeleteProject(UndeleteProjectRequest request)

Undeletes a soft-deleted project.

updateBranch

public UpdateBranchOperation updateBranch(UpdateBranchRequest request)

Updates the specified database branch. You can set this branch as the project's default branch, or protect/unprotect it.

updateDatabase

public UpdateDatabaseOperation updateDatabase(UpdateDatabaseRequest request)

Update a Database.

updateEndpoint

public UpdateEndpointOperation updateEndpoint(UpdateEndpointRequest request)

Updates the specified compute endpoint. You can update autoscaling limits, suspend timeout, or enable/disable the compute endpoint.

updateProject

public UpdateProjectOperation updateProject(UpdateProjectRequest request)

Updates the specified database project.

updateRole

public UpdateRoleOperation updateRole(UpdateRoleRequest request)

Update a role for a branch.

impl

public PostgresService impl()