clean_room_task_runs

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

Overview

Name	clean_room_task_runs
Type	Resource
Id	databricks_workspace.cleanrooms.clean_room_task_runs

Fields

The following fields are returned by SELECT queries:

clean_room_task_runs_list_clean_room_task_runs_handler

Name	Datatype	Description
name	string	Name of the executable.
▶analysis_details	object	Information about the analysis run (etag, updated at)
▶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.
▶output_info	object	Information about run output
run_duration	integer	Duration of the task run, in milliseconds.
▶shared_output_info	object	Information about shared output accessible by all collaborators. This field is only populated when enable_shared_output is true.
start_time	integer	When the task run started, in epoch milliseconds.
task_run_state	string	State of the task run.
task_type	string	Create a collection of name/value pairs.<br /><br />Example enumeration:<br /><br />&gt;&gt;&gt; class Color(Enum):<br />... RED = 1<br />... BLUE = 2<br />... GREEN = 3<br /><br />Access them by:<br /><br />- attribute access:<br /><br /> &gt;&gt;&gt; Color.RED<br /> &lt;Color.RED: 1&gt;<br /><br />- value lookup:<br /><br /> &gt;&gt;&gt; Color(1)<br /> &lt;Color.RED: 1&gt;<br /><br />- name lookup:<br /><br /> &gt;&gt;&gt; Color['RED']<br /> &lt;Color.RED: 1&gt;<br /><br />Enumerations can be iterated over, and know how many members they have:<br /><br />&gt;&gt;&gt; len(Color)<br />3<br /><br />&gt;&gt;&gt; list(Color)<br />[&lt;Color.RED: 1&gt;, &lt;Color.BLUE: 2&gt;, &lt;Color.GREEN: 3&gt;]<br /><br />Methods can be added to enumerations, and members can have their own<br />attributes -- see the documentation for details. (JAR, NOTEBOOK)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
clean_room_task_runs_list_clean_room_task_runs_handler	select	clean_room_name, deployment_name, workspace_domain	name, page_size, page_token, task_type	List all the historical 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: the host prefix of the workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to default it for the session. (default: dbc-abcd0123-a1bc, x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME)
workspace_domain	string	The Databricks workspace domain suffix for the cloud. Selected by DATABRICKS_CLOUD (aws, azure or gcp; default aws). (default: cloud.databricks.com, x-stackQL-envVarSelector: {"envVar":"DATABRICKS_CLOUD","default":"aws","values":{"aws":"cloud.databricks.com","azure":"azuredatabricks.net","gcp":"gcp.databricks.com"}})
name	string	Executable name.
page_size	integer	The maximum number of task runs to return. Maximum value of 100.
page_token	string	Opaque pagination token to go to next page based on previous query.
task_type	string	Filter by the type of Clean Room task.

SELECT examples

clean_room_task_runs_list_clean_room_task_runs_handler

List all the historical task runs in a clean room.

SELECT
name,
analysis_details,
collaborator_job_run_info,
output_info,
run_duration,
shared_output_info,
start_time,
task_run_state,
task_type
FROM databricks_workspace.cleanrooms.clean_room_task_runs
WHERE clean_room_name = '{{ clean_room_name }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND workspace_domain = '{{ workspace_domain }}' -- required
AND name = '{{ name }}'
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
AND task_type = '{{ task_type }}'
;