quality_monitors

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

Overview

Name	quality_monitors
Type	Resource
Id	databricks_workspace.unitycatalog.quality_monitors

Fields

The following fields are returned by SELECT queries:

get

The monitor was successfully retrieved.

Name	Datatype	Description
dashboard_id	string
baseline_table_name	string
drift_metrics_table_name	string
output_schema_name	string
profile_metrics_table_name	string
table_name	string
assets_dir	string
custom_metrics	array
inference_log	object
latest_monitor_failure_msg	string
monitor_version	string
notifications	object
schedule	object
slicing_exprs	array
snapshot	object
status	string
time_series	object

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	deployment_name		Gets a monitor for the specified table.
create	insert	deployment_name		Creates a new monitor for the specified table.
update	update	deployment_name		Updates a monitor for the specified table.
delete	delete	deployment_name		Deletes a monitor for the specified table.

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

get

Gets a monitor for the specified table.

SELECT
dashboard_id,
baseline_table_name,
drift_metrics_table_name,
output_schema_name,
profile_metrics_table_name,
table_name,
assets_dir,
custom_metrics,
inference_log,
latest_monitor_failure_msg,
monitor_version,
notifications,
schedule,
slicing_exprs,
snapshot,
status,
time_series
FROM databricks_workspace.unitycatalog.quality_monitors
WHERE deployment_name = '{{ deployment_name }}' -- required;

INSERT examples

create

Creates a new monitor for the specified table.

INSERT INTO databricks_workspace.unitycatalog.quality_monitors (
data__skip_builtin_dashboard,
data__warehouse_id,
data__assets_dir,
data__output_schema_name,
data__snapshot,
data__slicing_exprs,
data__baseline_table_name,
data__inference_log,
data__time_series,
data__custom_metrics,
data__schedule,
data__notifications,
deployment_name
)
SELECT 
{{ skip_builtin_dashboard }},
'{{ warehouse_id }}',
'{{ assets_dir }}',
'{{ output_schema_name }}',
'{{ snapshot }}',
'{{ slicing_exprs }}',
'{{ baseline_table_name }}',
'{{ inference_log }}',
'{{ time_series }}',
'{{ custom_metrics }}',
'{{ schedule }}',
'{{ notifications }}',
'{{ deployment_name }}'
RETURNING
dashboard_id,
baseline_table_name,
drift_metrics_table_name,
output_schema_name,
profile_metrics_table_name,
table_name,
assets_dir,
custom_metrics,
inference_log,
latest_monitor_failure_msg,
monitor_version,
notifications,
schedule,
slicing_exprs,
snapshot,
status,
time_series
;

Manifest

# Description fields are for documentation purposes
- name: quality_monitors
  props:
    - name: deployment_name
      value: string
      description: Required parameter for the quality_monitors resource.
    - name: skip_builtin_dashboard
      value: boolean
    - name: warehouse_id
      value: string
    - name: assets_dir
      value: required
    - name: output_schema_name
      value: string
    - name: snapshot
      value: required
    - name: slicing_exprs
      value: string
    - name: baseline_table_name
      value: object
    - name: inference_log
      value: object
    - name: time_series
      value: object
    - name: custom_metrics
      value: Array of object
    - name: schedule
      value: object
    - name: notifications
      value: object

UPDATE examples

update

Updates a monitor for the specified table.

UPDATE databricks_workspace.unitycatalog.quality_monitors
SET 
data__output_schema_name = '{{ output_schema_name }}',
data__snapshot = '{{ snapshot }}',
data__slicing_exprs = '{{ slicing_exprs }}',
data__baseline_table_name = '{{ baseline_table_name }}',
data__dashboard_id = '{{ dashboard_id }}',
data__inference_log = '{{ inference_log }}',
data__time_series = '{{ time_series }}',
data__custom_metrics = '{{ custom_metrics }}',
data__schedule = '{{ schedule }}',
data__notifications = '{{ notifications }}'
WHERE 
deployment_name = '{{ deployment_name }}' --required
RETURNING
dashboard_id,
baseline_table_name,
drift_metrics_table_name,
output_schema_name,
profile_metrics_table_name,
table_name,
assets_dir,
custom_metrics,
inference_log,
latest_monitor_failure_msg,
monitor_version,
notifications,
schedule,
slicing_exprs,
snapshot,
status,
time_series;

DELETE examples

delete

Deletes a monitor for the specified table.

DELETE FROM databricks_workspace.unitycatalog.quality_monitors
WHERE deployment_name = '{{ deployment_name }}' --required;