quality_monitor_refreshes

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

Overview

Name	quality_monitor_refreshes
Type	Resource
Id	databricks_workspace.catalog.quality_monitor_refreshes

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
refresh_id	integer
end_time_ms	integer	Time at which refresh operation completed (milliseconds since 1/1/1970 UTC).
message	string	An optional message to give insight into the current state of the job (e.g. FAILURE messages).
start_time_ms	integer	Time at which refresh operation was initiated (milliseconds since 1/1/1970 UTC).
state	string	The current state of the refresh. (CANCELED, FAILED, PENDING, RUNNING, SUCCESS, UNKNOWN)
trigger	string	The method by which the refresh was triggered. (MANUAL, SCHEDULE, UNKNOWN_TRIGGER)

list

Name	Datatype	Description
▶refreshes	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	table_name, refresh_id, deployment_name		[DEPRECATED] Gets info about a specific monitor refresh using the given refresh ID. Use Data Quality
list	select	table_name, deployment_name		[DEPRECATED] Gets an array containing the history of the most recent refreshes (up to 25) for this
run	exec	table_name, deployment_name		[DEPRECATED] Queues a metric refresh on the monitor for the specified table. Use Data Quality Monitors

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)
refresh_id	integer	ID of the refresh.
table_name	string	UC table name in format catalog.schema.table_name. table_name is case insensitive and spaces are disallowed.

SELECT examples

get

[DEPRECATED] Gets info about a specific monitor refresh using the given refresh ID. Use Data Quality

SELECT
refresh_id,
end_time_ms,
message,
start_time_ms,
state,
trigger
FROM databricks_workspace.catalog.quality_monitor_refreshes
WHERE table_name = '{{ table_name }}' -- required
AND refresh_id = '{{ refresh_id }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
;

list

[DEPRECATED] Gets an array containing the history of the most recent refreshes (up to 25) for this

SELECT
refreshes
FROM databricks_workspace.catalog.quality_monitor_refreshes
WHERE table_name = '{{ table_name }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
;

Lifecycle Methods

run

[DEPRECATED] Queues a metric refresh on the monitor for the specified table. Use Data Quality Monitors

EXEC databricks_workspace.catalog.quality_monitor_refreshes.run 
@table_name='{{ table_name }}' --required, 
@deployment_name='{{ deployment_name }}' --required
;