Class PostgresClient

Constructors

constructor

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

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:220

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:273

createCdfConfig

createCdfConfig(
req: CreateCdfConfigRequest,
options?: CallOptions,
): Promise<CreateCdfConfigOperation>
Create a CDF configuration that materializes the change data feed for all tables in a Postgres schema as open-format Delta tables in Unity Catalog. Once created, each table's change history is continuously written to its corresponding Lakehouse table.
Parameters
- req: CreateCdfConfigRequest
- Optionaloptions: CallOptions
Returns Promise<CreateCdfConfigOperation>
- Defined in client.ts:336

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:377

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:441

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:497

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:550

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:606

createSyncedTable

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

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:705

deleteCatalog

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

deleteCdfConfig

deleteCdfConfig(
req: DeleteCdfConfigRequest,
options?: CallOptions,
): Promise<DeleteCdfConfigOperation>
Delete a CDF configuration and stop materializing the change data feed. When force=true, also drops the Delta tables in Unity Catalog. When force=false (default), the existing tables are preserved at their last state.
Parameters
- req: DeleteCdfConfigRequest
- Optionaloptions: CallOptions
Returns Promise<DeleteCdfConfigOperation>
- Defined in client.ts:799

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:839

deleteDatabase

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

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:919

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:965

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:1011

deleteSyncedTable

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

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:1062

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:1095

getCatalog

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

getCdfConfig

getCdfConfig(
req: GetCdfConfigRequest,
options?: CallOptions,
): Promise<CdfConfig>
Get a single Lakebase CDF configuration, including the source Postgres schema, target Unity Catalog schema, and the identity under which writes are authorized.
Parameters
- req: GetCdfConfigRequest
- Optionaloptions: CallOptions
Returns Promise<CdfConfig>
- Defined in client.ts:1157

getCdfStatus

getCdfStatus(
req: GetCdfStatusRequest,
options?: CallOptions,
): Promise<CdfStatus>
Get the CDF status of a single table within a Lakebase CDF configuration, including its current state and the last committed position in the feed.
Parameters
- req: GetCdfStatusRequest
- Optionaloptions: CallOptions
Returns Promise<CdfStatus>
- Defined in client.ts:1189

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:1218

getDatabase

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

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:1276

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:1334

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:1363

getSyncedTable

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

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:1418

listBranchesIter

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

listCdfConfigs

listCdfConfigs(
req: ListCdfConfigsRequest,
options?: CallOptions,
): Promise<ListCdfConfigsResponse>
List all CDF configurations for a Lakebase database. Each configuration maps a Postgres schema to a Unity Catalog schema where the change data feed is materialized.
Parameters
- req: ListCdfConfigsRequest
- Optionaloptions: CallOptions
Returns Promise<ListCdfConfigsResponse>
- Defined in client.ts:1480

listCdfConfigsIter

listCdfConfigsIter(
req: ListCdfConfigsRequest,
options?: CallOptions,
): AsyncGenerator<CdfConfig>
Parameters
- req: ListCdfConfigsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<CdfConfig>
- Defined in client.ts:1517

listCdfStatuses

listCdfStatuses(
req: ListCdfStatusesRequest,
options?: CallOptions,
): Promise<ListCdfStatusesResponse>
List the per-table CDF statuses within a Lakebase CDF configuration. Each status shows whether a table's change data feed is snapshotting, streaming, or skipped.
Parameters
- req: ListCdfStatusesRequest
- Optionaloptions: CallOptions
Returns Promise<ListCdfStatusesResponse>
- Defined in client.ts:1539

listCdfStatusesIter

listCdfStatusesIter(
req: ListCdfStatusesRequest,
options?: CallOptions,
): AsyncGenerator<CdfStatus>
Parameters
- req: ListCdfStatusesRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<CdfStatus>
- Defined in client.ts:1576

listDatabases

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

listDatabasesIter

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

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:1649

listEndpointsIter

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

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:1704

listProjectsIter

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

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:1762

listRolesIter

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

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:1847

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:1888

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:1941

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:1994

updateDatabase

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

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:2100

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:2153

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:2206

Class PostgresClient

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns PostgresClient

Methods

createBranch

Parameters

Returns Promise<CreateBranchOperation>

createCatalog

Parameters

Returns Promise<CreateCatalogOperation>

createCdfConfig

Parameters

Returns Promise<CreateCdfConfigOperation>

createDataApi

Parameters

Returns Promise<CreateDataApiOperation>

createDatabase

Parameters

Returns Promise<CreateDatabaseOperation>

createEndpoint

Parameters

Returns Promise<CreateEndpointOperation>

createProject

Parameters

Returns Promise<CreateProjectOperation>

createRole

Parameters

Returns Promise<CreateRoleOperation>

createSyncedTable

Parameters

Returns Promise<CreateSyncedTableOperation>

deleteBranch

Parameters

Returns Promise<DeleteBranchOperation>

deleteCatalog

Parameters

Returns Promise<DeleteCatalogOperation>

deleteCdfConfig

Parameters

Returns Promise<DeleteCdfConfigOperation>

deleteDataApi

Parameters

Returns Promise<DeleteDataApiOperation>

deleteDatabase

Parameters

Returns Promise<DeleteDatabaseOperation>

deleteEndpoint

Parameters

Returns Promise<DeleteEndpointOperation>

deleteProject

Parameters

Returns Promise<DeleteProjectOperation>

deleteRole

Parameters

Returns Promise<DeleteRoleOperation>

deleteSyncedTable

Parameters

Returns Promise<DeleteSyncedTableOperation>

generateDatabaseCredential

Parameters

Returns Promise<DatabaseCredential>

getBranch

Parameters

Returns Promise<Branch>

getCatalog

Parameters

Returns Promise<Catalog>

getCdfConfig

Parameters

Returns Promise<CdfConfig>

getCdfStatus

Parameters

Returns Promise<CdfStatus>

getDataApi

Parameters