quality_monitor_refreshes
Creates, updates, deletes, gets or lists a quality_monitor_refreshes resource.
Overview
| Name | quality_monitor_refreshes |
| Type | Resource |
| Id | databricks_workspace.unitycatalog.quality_monitor_refreshes |
Fields
The following fields are returned by SELECT queries:
- listrefreshes
- getrefresh
The list of refresh info was successfully retrieved.
| Name | Datatype | Description |
|---|---|---|
refresh_id | integer | |
end_time_ms | integer | |
message | string | |
start_time_ms | integer | |
state | string | |
trigger | string |
The refresh info was successfully retrieved.
| Name | Datatype | Description |
|---|---|---|
refresh_id | integer | |
end_time_ms | integer | |
message | string | |
start_time_ms | integer | |
state | string | |
trigger | string |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
listrefreshes | select | deployment_name | Gets an array containing the history of the most recent refreshes (up to 25) for this table. | |
getrefresh | select | deployment_name | Gets info about a specific monitor refresh using the given refresh ID. | |
runrefresh | exec | deployment_name | Queues a metric refresh on the monitor for the specified table. The refresh will execute in the background. |
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) |
SELECT examples
- listrefreshes
- getrefresh
Gets an array containing the history of the most recent refreshes (up to 25) for this table.
SELECT
refresh_id,
end_time_ms,
message,
start_time_ms,
state,
trigger
FROM databricks_workspace.unitycatalog.quality_monitor_refreshes
WHERE deployment_name = '{{ deployment_name }}' -- required;
Gets info about a specific monitor refresh using the given refresh ID.
SELECT
refresh_id,
end_time_ms,
message,
start_time_ms,
state,
trigger
FROM databricks_workspace.unitycatalog.quality_monitor_refreshes
WHERE deployment_name = '{{ deployment_name }}' -- required;
Lifecycle Methods
- runrefresh
Queues a metric refresh on the monitor for the specified table. The refresh will execute in the background.
EXEC databricks_workspace.unitycatalog.quality_monitor_refreshes.runrefresh
@deployment_name='{{ deployment_name }}' --required;