Class PostgresClient

Index

Constructors

Methods

acknowledgeAssessmentWarnings assessMigration createBranch createCatalog createCdfConfig createDataApi createDatabase createEndpoint createMigration createProject createRole createSnapshot createSyncedTable deleteBranch deleteCatalog deleteCdfConfig deleteDataApi deleteDatabase deleteEndpoint deleteMigration deleteProject deleteRole deleteSnapshot deleteSyncedTable generateDatabaseCredential getAssessment getBranch getCatalog getCdfConfig getCdfStatus getDataApi getDatabase getEndpoint getMigration getProject getRole getSnapshot getSnapshotSchedule getSyncedTable listAssessments listAssessmentsIter listBranches listBranchesIter listCdfConfigs listCdfConfigsIter listCdfStatuses listCdfStatusesIter listDatabases listDatabasesIter listEndpoints listEndpointsIter listMigrations listMigrationsIter listProjects listProjectsIter listRoles listRolesIter listSnapshots listSnapshotsIter revealRolePassword startMigration undeleteBranch undeleteMigration undeleteProject updateBranch updateDataApi updateDatabase updateEndpoint updateMigration updateProject updateRole updateSnapshotSchedule

Constructors

constructor

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

Methods

acknowledgeAssessmentWarnings

acknowledgeAssessmentWarnings(
req: AcknowledgeAssessmentWarningsRequest,
options?: CallOptions,
): Promise<AcknowledgeAssessmentWarningsOperation>
Acknowledges non-blocking warnings on a specific assessment.
Parameters
- req: AcknowledgeAssessmentWarningsRequest
- Optionaloptions: CallOptions
Returns Promise<AcknowledgeAssessmentWarningsOperation>
- Defined in client.ts:264

assessMigration

assessMigration(
req: AssessMigrationRequest,
options?: CallOptions,
): Promise<AssessMigrationOperation>
Creates an immutable assessment run for the migration's current source configuration.
Parameters
- req: AssessMigrationRequest
- Optionaloptions: CallOptions
Returns Promise<AssessMigrationOperation>
- Defined in client.ts:305

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

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

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

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

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

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

createMigration

createMigration(
req: CreateMigrationRequest,
options?: CallOptions,
): Promise<CreateMigrationOperation>
Creates a migration.
Parameters
- req: CreateMigrationRequest
- Optionaloptions: CallOptions
Returns Promise<CreateMigrationOperation>
- Defined in client.ts:691

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

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

createSnapshot

createSnapshot(
req: CreateSnapshotRequest,
options?: CallOptions,
): Promise<CreateSnapshotOperation>
Creates a snapshot, an immutable point-in-time copy of a branch's data, within the project.
Parameters
- req: CreateSnapshotRequest
- Optionaloptions: CallOptions
Returns Promise<CreateSnapshotOperation>
- Defined in client.ts:853

createSyncedTable

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

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

deleteCatalog

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

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

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

deleteDatabase

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

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

deleteMigration

deleteMigration(
req: DeleteMigrationRequest,
options?: CallOptions,
): Promise<DeleteMigrationOperation>
Soft-deletes a migration.
Parameters
- req: DeleteMigrationRequest
- Optionaloptions: CallOptions
Returns Promise<DeleteMigrationOperation>
- Defined in client.ts:1206

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

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

deleteSnapshot

deleteSnapshot(
req: DeleteSnapshotRequest,
options?: CallOptions,
): Promise<DeleteSnapshotOperation>
Deletes the specified snapshot.
Parameters
- req: DeleteSnapshotRequest
- Optionaloptions: CallOptions
Returns Promise<DeleteSnapshotOperation>
- Defined in client.ts:1338

deleteSyncedTable

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

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

getAssessment

getAssessment(
req: GetAssessmentRequest,
options?: CallOptions,
): Promise<Assessment>
Gets a migration assessment run.
Parameters
- req: GetAssessmentRequest
- Optionaloptions: CallOptions
Returns Promise<Assessment>
- Defined in client.ts:1422

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

getCatalog

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

getCdfConfig

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

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

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

getDatabase

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

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

getMigration

getMigration(
req: GetMigrationRequest,
options?: CallOptions,
): Promise<Migration>
Gets a migration.
Parameters
- req: GetMigrationRequest
- Optionaloptions: CallOptions
Returns Promise<Migration>
- Defined in client.ts:1660

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

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

getSnapshot

getSnapshot(req: GetSnapshotRequest, options?: CallOptions): Promise<Snapshot>
Retrieves information about the specified snapshot.
Parameters
- req: GetSnapshotRequest
- Optionaloptions: CallOptions
Returns Promise<Snapshot>
- Defined in client.ts:1773

getSnapshotSchedule

getSnapshotSchedule(
req: GetSnapshotScheduleRequest,
options?: CallOptions,
): Promise<SnapshotSchedule>
Retrieves the snapshot schedule for a branch. A branch with no configured schedule returns an empty schedule (not NOT_FOUND).
Parameters
- req: GetSnapshotScheduleRequest
- Optionaloptions: CallOptions
Returns Promise<SnapshotSchedule>
- Defined in client.ts:1805

getSyncedTable

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

listAssessments

listAssessments(
req: ListAssessmentsRequest,
options?: CallOptions,
): Promise<ListAssessmentsResponse>
Lists assessment runs for a migration.
Parameters
- req: ListAssessmentsRequest
- Optionaloptions: CallOptions
Returns Promise<ListAssessmentsResponse>
- Defined in client.ts:1863

listAssessmentsIter

listAssessmentsIter(
req: ListAssessmentsRequest,
options?: CallOptions,
): AsyncGenerator<Assessment>
Parameters
- req: ListAssessmentsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<Assessment>
- Defined in client.ts:1900

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

listBranchesIter

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

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

listCdfConfigsIter

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

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

listCdfStatusesIter

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

listDatabases

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

listDatabasesIter

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

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

listEndpointsIter

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

listMigrations

listMigrations(
req: ListMigrationsRequest,
options?: CallOptions,
): Promise<ListMigrationsResponse>
Lists migrations in the workspace.
Parameters
- req: ListMigrationsRequest
- Optionaloptions: CallOptions
Returns Promise<ListMigrationsResponse>
- Defined in client.ts:2204

listMigrationsIter

listMigrationsIter(
req: ListMigrationsRequest,
options?: CallOptions,
): AsyncGenerator<Migration>
Parameters
- req: ListMigrationsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<Migration>
- Defined in client.ts:2244

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

listProjectsIter

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

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

listRolesIter

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

listSnapshots

listSnapshots(
req: ListSnapshotsRequest,
options?: CallOptions,
): Promise<ListSnapshotsResponse>
Returns a paginated list of snapshots in the project.
Parameters
- req: ListSnapshotsRequest
- Optionaloptions: CallOptions
Returns Promise<ListSnapshotsResponse>
- Defined in client.ts:2375

listSnapshotsIter

listSnapshotsIter(
req: ListSnapshotsRequest,
options?: CallOptions,
): AsyncGenerator<Snapshot>
Parameters
- req: ListSnapshotsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<Snapshot>
- Defined in client.ts:2412

revealRolePassword

revealRolePassword(
req: RevealRolePasswordRequest,
options?: CallOptions,
): Promise<RevealRolePasswordResponse>
Reveals the current password for a password-authenticated Postgres role.
Parameters
- req: RevealRolePasswordRequest
- Optionaloptions: CallOptions
Returns Promise<RevealRolePasswordResponse>
- Defined in client.ts:2430

startMigration

startMigration(
req: StartMigrationRequest,
options?: CallOptions,
): Promise<StartMigrationOperation>
Starts the assessed migration named in the request, moving it from READY_TO_START into execution. Its first phase, SCHEMA_LOAD, creates the target databases, roles, and schema on the migration's target Lakebase branch without copying any table data, ahead of INITIAL_DATA_LOAD.
Parameters
- req: StartMigrationRequest
- Optionaloptions: CallOptions
Returns Promise<StartMigrationOperation>
- Defined in client.ts:2498

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

undeleteMigration

undeleteMigration(
req: UndeleteMigrationRequest,
options?: CallOptions,
): Promise<UndeleteMigrationOperation>
Restores a soft-deleted migration before it is permanently purged.
Parameters
- req: UndeleteMigrationRequest
- Optionaloptions: CallOptions
Returns Promise<UndeleteMigrationOperation>
- Defined in client.ts:2580

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

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

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

updateDatabase

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

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

updateMigration

updateMigration(
req: UpdateMigrationRequest,
options?: CallOptions,
): Promise<UpdateMigrationOperation>
Updates user-owned migration configuration.
Parameters
- req: UpdateMigrationRequest
- Optionaloptions: CallOptions
Returns Promise<UpdateMigrationOperation>
- Defined in client.ts:2886

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

updateRole

updateRole(
req: UpdateRoleRequest,
options?: CallOptions,
): Promise<UpdateRoleOperation>
Updates the mutable fields of a Postgres role for a branch.

The fields spec.identity_type, spec.auth_method, and spec.postgres_role are fixed when the role is created. UpdateRole ignores values supplied for these fields in the request body and retains their existing values. Explicitly naming one of these fields in update_mask returns an INVALID_PARAMETER_VALUE error.
Parameters
- req: UpdateRoleRequest
- Optionaloptions: CallOptions
Returns Promise<UpdateRoleOperation>
- Defined in client.ts:3008

updateSnapshotSchedule

updateSnapshotSchedule(
req: UpdateSnapshotScheduleRequest,
options?: CallOptions,
): Promise<UpdateSnapshotScheduleOperation>
Sets the snapshot schedule for a branch. The schedule field is replaced wholesale; an empty schedule disables automatic snapshots.
Parameters
- req: UpdateSnapshotScheduleRequest
- Optionaloptions: CallOptions
Returns Promise<UpdateSnapshotScheduleOperation>
- Defined in client.ts:3070

Class PostgresClient

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns PostgresClient

Methods

acknowledgeAssessmentWarnings

Parameters

Returns Promise<AcknowledgeAssessmentWarningsOperation>

assessMigration

Parameters

Returns Promise<AssessMigrationOperation>

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>

createMigration

Parameters

Returns Promise<CreateMigrationOperation>

createProject

Parameters

Returns Promise<CreateProjectOperation>

createRole

Parameters

Returns Promise<CreateRoleOperation>

createSnapshot

Parameters

Returns Promise<CreateSnapshotOperation>

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>

deleteMigration

Parameters

Returns Promise<DeleteMigrationOperation>

deleteProject

Parameters

Returns Promise<DeleteProjectOperation>

deleteRole

Parameters

Returns Promise<DeleteRoleOperation>

deleteSnapshot

Parameters

Returns Promise<DeleteSnapshotOperation>

deleteSyncedTable

Parameters