Class PostgresClient

Constructors

constructor

new PostgresClient(options: ClientOptions): PostgresClient
Parameters
- options: ClientOptions
Returns PostgresClient
- Defined in client.ts:142

Methods

createBranch

createBranch(
req: CreateBranchRequest,
options?: CallOptions,
): Promise<CreateBranchOperation>
Creates a new database branch in the project.
Parameters
- req: CreateBranchRequest
- Optionaloptions: CallOptions
Returns Promise<CreateBranchOperation>
- Defined in client.ts:203

createCatalog

createCatalog(
req: CreateCatalogRequest,
options?: CallOptions,
): Promise<CreateCatalogOperation>
Register a Postgres database in the Unity Catalog.
Parameters
- req: CreateCatalogRequest
- Optionaloptions: CallOptions
Returns Promise<CreateCatalogOperation>
- Defined in client.ts:256

createDataApi

createDataApi(
req: CreateDataApiRequest,
options?: CallOptions,
): Promise<CreateDataApiOperation>
Enable Data API for a database.
Parameters
- req: CreateDataApiRequest
- Optionaloptions: CallOptions
Returns Promise<CreateDataApiOperation>
- Defined in client.ts:297

createDatabase

createDatabase(
req: CreateDatabaseRequest,
options?: CallOptions,
): Promise<CreateDatabaseOperation>
Create a Database.

Creates a database in the specified branch. A branch can have multiple databases.
Parameters
- req: CreateDatabaseRequest
- Optionaloptions: CallOptions
Returns Promise<CreateDatabaseOperation>
- Defined in client.ts:358

createEndpoint

createEndpoint(
req: CreateEndpointRequest,
options?: CallOptions,
): Promise<CreateEndpointOperation>
Creates a new compute endpoint in the branch.
Parameters
- req: CreateEndpointRequest
- Optionaloptions: CallOptions
Returns Promise<CreateEndpointOperation>
- Defined in client.ts:414

createProject

createProject(
req: CreateProjectRequest,
options?: CallOptions,
): Promise<CreateProjectOperation>
Creates a new Lakebase Autoscaling Postgres database project, which contains branches and compute endpoints.
Parameters
- req: CreateProjectRequest
- Optionaloptions: CallOptions
Returns Promise<CreateProjectOperation>
- Defined in client.ts:467

createRole

createRole(
req: CreateRoleRequest,
options?: CallOptions,
): Promise<CreateRoleOperation>
Creates a new Postgres role in the branch.
Parameters
- req: CreateRoleRequest
- Optionaloptions: CallOptions
Returns Promise<CreateRoleOperation>
- Defined in client.ts:520

createSyncedTable

createSyncedTable(
req: CreateSyncedTableRequest,
options?: CallOptions,
): Promise<CreateSyncedTableOperation>
Create a Synced Table.
Parameters
- req: CreateSyncedTableRequest
- Optionaloptions: CallOptions
Returns Promise<CreateSyncedTableOperation>
- Defined in client.ts:573

deleteBranch

deleteBranch(
req: DeleteBranchRequest,
options?: CallOptions,
): Promise<DeleteBranchOperation>
Deletes the specified database branch.
Parameters
- req: DeleteBranchRequest
- Optionaloptions: CallOptions
Returns Promise<DeleteBranchOperation>
- Defined in client.ts:619

deleteCatalog

deleteCatalog(
req: DeleteCatalogRequest,
options?: CallOptions,
): Promise<DeleteCatalogOperation>
Delete a Database Catalog.
Parameters
- req: DeleteCatalogRequest
- Optionaloptions: CallOptions
Returns Promise<DeleteCatalogOperation>
- Defined in client.ts:659

deleteDataApi

deleteDataApi(
req: DeleteDataApiRequest,
options?: CallOptions,
): Promise<DeleteDataApiOperation>
Disable Data API for a database.
Parameters
- req: DeleteDataApiRequest
- Optionaloptions: CallOptions
Returns Promise<DeleteDataApiOperation>
- Defined in client.ts:699

deleteDatabase

deleteDatabase(
req: DeleteDatabaseRequest,
options?: CallOptions,
): Promise<DeleteDatabaseOperation>
Delete a Database.
Parameters
- req: DeleteDatabaseRequest
- Optionaloptions: CallOptions
Returns Promise<DeleteDatabaseOperation>
- Defined in client.ts:739

deleteEndpoint

deleteEndpoint(
req: DeleteEndpointRequest,
options?: CallOptions,
): Promise<DeleteEndpointOperation>
Deletes the specified compute endpoint.
Parameters
- req: DeleteEndpointRequest
- Optionaloptions: CallOptions
Returns Promise<DeleteEndpointOperation>
- Defined in client.ts:779

deleteProject

deleteProject(
req: DeleteProjectRequest,
options?: CallOptions,
): Promise<DeleteProjectOperation>
Deletes the specified database project.
Parameters
- req: DeleteProjectRequest
- Optionaloptions: CallOptions
Returns Promise<DeleteProjectOperation>
- Defined in client.ts:825

deleteRole

deleteRole(
req: DeleteRoleRequest,
options?: CallOptions,
): Promise<DeleteRoleOperation>
Deletes the specified Postgres role.
Parameters
- req: DeleteRoleRequest
- Optionaloptions: CallOptions
Returns Promise<DeleteRoleOperation>
- Defined in client.ts:871

deleteSyncedTable

deleteSyncedTable(
req: DeleteSyncedTableRequest,
options?: CallOptions,
): Promise<DeleteSyncedTableOperation>
Delete a Synced Table.
Parameters
- req: DeleteSyncedTableRequest
- Optionaloptions: CallOptions
Returns Promise<DeleteSyncedTableOperation>
- Defined in client.ts:911

generateDatabaseCredential

generateDatabaseCredential(
req: GenerateDatabaseCredentialRequest,
options?: CallOptions,
): Promise<DatabaseCredential>
Generate OAuth credentials for a Postgres database.
Parameters
- req: GenerateDatabaseCredentialRequest
- Optionaloptions: CallOptions
Returns Promise<DatabaseCredential>
- Defined in client.ts:922

getBranch

getBranch(req: GetBranchRequest, options?: CallOptions): Promise<Branch>
Retrieves information about the specified database branch.
Parameters
- req: GetBranchRequest
- Optionaloptions: CallOptions
Returns Promise<Branch>
- Defined in client.ts:955

getCatalog

getCatalog(req: GetCatalogRequest, options?: CallOptions): Promise<Catalog>
Get a Database Catalog.
Parameters
- req: GetCatalogRequest
- Optionaloptions: CallOptions
Returns Promise<Catalog>
- Defined in client.ts:984

getDataApi

getDataApi(req: GetDataApiRequest, options?: CallOptions): Promise<DataApi>
Get Data API configuration for a database.
Parameters
- req: GetDataApiRequest
- Optionaloptions: CallOptions
Returns Promise<DataApi>
- Defined in client.ts:1013

getDatabase

getDatabase(req: GetDatabaseRequest, options?: CallOptions): Promise<Database>
Get a Database.
Parameters
- req: GetDatabaseRequest
- Optionaloptions: CallOptions
Returns Promise<Database>
- Defined in client.ts:1042

getEndpoint

getEndpoint(req: GetEndpointRequest, options?: CallOptions): Promise<Endpoint>
Retrieves information about the specified compute endpoint, including its connection details and operational state.
Parameters
- req: GetEndpointRequest
- Optionaloptions: CallOptions
Returns Promise<Endpoint>
- Defined in client.ts:1071

getProject

getProject(req: GetProjectRequest, options?: CallOptions): Promise<Project>
Retrieves information about the specified database project.
Parameters
- req: GetProjectRequest
- Optionaloptions: CallOptions
Returns Promise<Project>
- Defined in client.ts:1129

getRole

getRole(req: GetRoleRequest, options?: CallOptions): Promise<Role>
Retrieves information about the specified Postgres role, including its authentication method and permissions.
Parameters
- req: GetRoleRequest
- Optionaloptions: CallOptions
Returns Promise<Role>
- Defined in client.ts:1158

getSyncedTable

getSyncedTable(
req: GetSyncedTableRequest,
options?: CallOptions,
): Promise<SyncedTable>
Get a Synced Table.
Parameters
- req: GetSyncedTableRequest
- Optionaloptions: CallOptions
Returns Promise<SyncedTable>
- Defined in client.ts:1184

listBranches

listBranches(
req: ListBranchesRequest,
options?: CallOptions,
): Promise<ListBranchesResponse>
Returns a paginated list of database branches in the project.
Parameters
- req: ListBranchesRequest
- Optionaloptions: CallOptions
Returns Promise<ListBranchesResponse>
- Defined in client.ts:1213

listBranchesIter

listBranchesIter(
req: ListBranchesRequest,
options?: CallOptions,
): AsyncGenerator<Branch>
Parameters
- req: ListBranchesRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<Branch>
- Defined in client.ts:1253

listDatabases

listDatabases(
req: ListDatabasesRequest,
options?: CallOptions,
): Promise<ListDatabasesResponse>
List Databases.
Parameters
- req: ListDatabasesRequest
- Optionaloptions: CallOptions
Returns Promise<ListDatabasesResponse>
- Defined in client.ts:1271

listDatabasesIter

listDatabasesIter(
req: ListDatabasesRequest,
options?: CallOptions,
): AsyncGenerator<Database>
Parameters
- req: ListDatabasesRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<Database>
- Defined in client.ts:1308

listEndpoints

listEndpoints(
req: ListEndpointsRequest,
options?: CallOptions,
): Promise<ListEndpointsResponse>
Returns a paginated list of compute endpoints in the branch.
Parameters
- req: ListEndpointsRequest
- Optionaloptions: CallOptions
Returns Promise<ListEndpointsResponse>
- Defined in client.ts:1326

listEndpointsIter

listEndpointsIter(
req: ListEndpointsRequest,
options?: CallOptions,
): AsyncGenerator<Endpoint>
Parameters
- req: ListEndpointsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<Endpoint>
- Defined in client.ts:1363

listProjects

listProjects(
req: ListProjectsRequest,
options?: CallOptions,
): Promise<ListProjectsResponse>
Returns a paginated list of database projects in the workspace that the user has permission to access.
Parameters
- req: ListProjectsRequest
- Optionaloptions: CallOptions
Returns Promise<ListProjectsResponse>
- Defined in client.ts:1381

listProjectsIter

listProjectsIter(
req: ListProjectsRequest,
options?: CallOptions,
): AsyncGenerator<Project>
Parameters
- req: ListProjectsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<Project>
- Defined in client.ts:1421

listRoles

listRoles(
req: ListRolesRequest,
options?: CallOptions,
): Promise<ListRolesResponse>
Returns a paginated list of Postgres roles in the branch.
Parameters
- req: ListRolesRequest
- Optionaloptions: CallOptions
Returns Promise<ListRolesResponse>
- Defined in client.ts:1439

listRolesIter

listRolesIter(
req: ListRolesRequest,
options?: CallOptions,
): AsyncGenerator<Role>
Parameters
- req: ListRolesRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<Role>
- Defined in client.ts:1476

undeleteBranch

undeleteBranch(
req: UndeleteBranchRequest,
options?: CallOptions,
): Promise<UndeleteBranchOperation>
Undeletes the specified database branch.
Parameters
- req: UndeleteBranchRequest
- Optionaloptions: CallOptions
Returns Promise<UndeleteBranchOperation>
- Defined in client.ts:1524

undeleteProject

undeleteProject(
req: UndeleteProjectRequest,
options?: CallOptions,
): Promise<UndeleteProjectOperation>
Undeletes a soft-deleted project.
Parameters
- req: UndeleteProjectRequest
- Optionaloptions: CallOptions
Returns Promise<UndeleteProjectOperation>
- Defined in client.ts:1565

updateBranch

updateBranch(
req: UpdateBranchRequest,
options?: CallOptions,
): Promise<UpdateBranchOperation>
Updates the specified database branch. You can set this branch as the project's default branch, or protect/unprotect it.
Parameters
- req: UpdateBranchRequest
- Optionaloptions: CallOptions
Returns Promise<UpdateBranchOperation>
- Defined in client.ts:1618

updateDataApi

updateDataApi(
req: UpdateDataApiRequest,
options?: CallOptions,
): Promise<UpdateDataApiOperation>
Update Data API configuration for a database.
Parameters
- req: UpdateDataApiRequest
- Optionaloptions: CallOptions
Returns Promise<UpdateDataApiOperation>
- Defined in client.ts:1671

updateDatabase

updateDatabase(
req: UpdateDatabaseRequest,
options?: CallOptions,
): Promise<UpdateDatabaseOperation>
Update a Database.
Parameters
- req: UpdateDatabaseRequest
- Optionaloptions: CallOptions
Returns Promise<UpdateDatabaseOperation>
- Defined in client.ts:1724

updateEndpoint

updateEndpoint(
req: UpdateEndpointRequest,
options?: CallOptions,
): Promise<UpdateEndpointOperation>
Updates the specified compute endpoint. You can update autoscaling limits, suspend timeout, or enable/disable the compute endpoint.
Parameters
- req: UpdateEndpointRequest
- Optionaloptions: CallOptions
Returns Promise<UpdateEndpointOperation>
- Defined in client.ts:1777

updateProject

updateProject(
req: UpdateProjectRequest,
options?: CallOptions,
): Promise<UpdateProjectOperation>
Updates the specified database project.
Parameters
- req: UpdateProjectRequest
- Optionaloptions: CallOptions
Returns Promise<UpdateProjectOperation>
- Defined in client.ts:1830

updateRole

updateRole(
req: UpdateRoleRequest,
options?: CallOptions,
): Promise<UpdateRoleOperation>
Update a role for a branch.
Parameters
- req: UpdateRoleRequest
- Optionaloptions: CallOptions
Returns Promise<UpdateRoleOperation>
- Defined in client.ts:1883