Skip to main content

postgres_recovery_branch_previews

Creates, updates, deletes, gets or lists a postgres_recovery_branch_previews resource.

Overview

Namepostgres_recovery_branch_previews
TypeResource
Iddatabricks_workspace.postgres.postgres_recovery_branch_previews

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
namestringThe resource name of the recovery branch. Format: projects/{project_id}/preview/recovery-branches/{recovery_branch_id}
create_timestring (date-time)
parentstringThe project containing this recovery branch. Format: projects/{project_id}
statusobject
uidstring
update_timestring (date-time)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectparent, deployment_namepage_size, page_tokenReturns a paginated list of recovery branches for the project.
inspectexecname, deployment_name, branch_idMaterializes a temporary inspection branch from the specified recovery branch for data examination.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
deployment_namestringThe Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)
namestringThe recovery branch from which to create the inspection branch.
parentstring
page_sizeinteger
page_tokenstring

SELECT examples

Returns a paginated list of recovery branches for the project.

SELECT
name,
create_time,
parent,
status,
uid,
update_time
FROM databricks_workspace.postgres.postgres_recovery_branch_previews
WHERE parent = '{{ parent }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

Lifecycle Methods

Materializes a temporary inspection branch from the specified recovery branch for data examination.

EXEC databricks_workspace.postgres.postgres_recovery_branch_previews.inspect
@name='{{ name }}' --required,
@deployment_name='{{ deployment_name }}' --required
@@json=
'{
"branch_id": "{{ branch_id }}",
"request_id": "{{ request_id }}"
}'
;