task_runs

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

Overview

Name	task_runs
Type	Resource
Id	databricks_workspace.cleanrooms.task_runs

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
notebook_name	string	Asset name of the notebook executed in this task run.
output_schema_name	string	Name of the output schema associated with the clean rooms notebook task run.
▶collaborator_job_run_info	object	Job run info of the task in the runner's local workspace. This field is only included in the LIST API. if the task was run within the same workspace the API is being called. If the task run was in a different workspace under the same metastore, only the workspace_id is included.
notebook_etag	string	Etag of the notebook executed in this task run, used to identify the notebook version.
notebook_job_run_state	string	State of the task run.
notebook_updated_at	integer	The timestamp of when the notebook was last updated.
output_schema_expiration_time	integer	Expiration time of the output schema of the task run (if any), in epoch milliseconds.
run_duration	integer	Duration of the task run, in milliseconds.
start_time	integer	When the task run started, in epoch milliseconds.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	clean_room_name, deployment_name	notebook_name, page_size, page_token	List all the historical notebook task runs in a clean room.

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
clean_room_name	string	Name of the clean room.
deployment_name	string	The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)
notebook_name	string	Notebook name
page_size	integer	The maximum number of task runs to return. Currently ignored - all runs will be returned.
page_token	string	Opaque pagination token to go to next page based on previous query.

SELECT examples

list

List all the historical notebook task runs in a clean room.

SELECT
notebook_name,
output_schema_name,
collaborator_job_run_info,
notebook_etag,
notebook_job_run_state,
notebook_updated_at,
output_schema_expiration_time,
run_duration,
start_time
FROM databricks_workspace.cleanrooms.task_runs
WHERE clean_room_name = '{{ clean_room_name }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND notebook_name = '{{ notebook_name }}'
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;