pipeline_updates

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

Overview

Name	pipeline_updates
Type	Resource
Id	databricks_workspace.pipelines.pipeline_updates

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
▶update	object

list

Name	Datatype	Description
next_page_token	string
prev_page_token	string	If present, then this token can be used in a subsequent request to fetch the previous page.
▶updates	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	pipeline_id, update_id, deployment_name		Gets an update from an active pipeline.
list	select	pipeline_id, deployment_name	max_results, page_token, until_update_id	List updates for an active pipeline.
start	exec	pipeline_id, deployment_name		Starts a new update for the pipeline. If there is already an active update for the pipeline, the

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.

Name	Datatype	Description
deployment_name	string	The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)
pipeline_id	string	:param cause: :class:StartUpdateCause (optional)
update_id	string	The ID of the update.
max_results	integer	Max number of entries to return in a single page.
page_token	string	Page token returned by previous call
until_update_id	string	If present, returns updates until and including this update_id.

SELECT examples

get

Gets an update from an active pipeline.

SELECT
update
FROM databricks_workspace.pipelines.pipeline_updates
WHERE pipeline_id = '{{ pipeline_id }}' -- required
AND update_id = '{{ update_id }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
;

list

List updates for an active pipeline.

SELECT
next_page_token,
prev_page_token,
updates
FROM databricks_workspace.pipelines.pipeline_updates
WHERE pipeline_id = '{{ pipeline_id }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND max_results = '{{ max_results }}'
AND page_token = '{{ page_token }}'
AND until_update_id = '{{ until_update_id }}'
;

Lifecycle Methods

start

Starts a new update for the pipeline. If there is already an active update for the pipeline, the

EXEC databricks_workspace.pipelines.pipeline_updates.start 
@pipeline_id='{{ pipeline_id }}' --required, 
@deployment_name='{{ deployment_name }}' --required 
@@json=
'{
"cause": "{{ cause }}", 
"full_refresh": {{ full_refresh }}, 
"full_refresh_selection": "{{ full_refresh_selection }}", 
"refresh_selection": "{{ refresh_selection }}", 
"rewind_spec": "{{ rewind_spec }}", 
"validate_only": {{ validate_only }}
}'
;