quality_monitor_v2

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

Overview

Name	quality_monitor_v2
Type	Resource
Id	databricks_workspace.qualitymonitorv2.quality_monitor_v2

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
object_id	string	The uuid of the request object. For example, schema id.
▶anomaly_detection_config	object
object_type	string
▶validity_check_configurations	array	Validity check configurations for anomaly detection.

list

Name	Datatype	Description
object_id	string	The uuid of the request object. For example, schema id.
▶anomaly_detection_config	object
object_type	string
▶validity_check_configurations	array	Validity check configurations for anomaly detection.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	object_type, object_id, deployment_name		[DEPRECATED] Read a quality monitor on UC object. Use Data Quality Monitoring API instead.
list	select	deployment_name	page_size, page_token	[DEPRECATED] (Unimplemented) List quality monitors. Use Data Quality Monitoring API instead.
create	insert	deployment_name, quality_monitor		[DEPRECATED] Create a quality monitor on UC object. Use Data Quality Monitoring API instead.
update	replace	object_type, object_id, deployment_name, quality_monitor		[DEPRECATED] (Unimplemented) Update a quality monitor on UC object. Use Data Quality Monitoring API
delete	delete	object_type, object_id, deployment_name		[DEPRECATED] Delete a quality monitor on UC object. Use Data Quality Monitoring API instead.

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)
object_id	string	The uuid of the request object. For example, schema id.
object_type	string	The type of the monitored object. Can be one of the following: schema.
page_size	integer	:param page_token: str (optional)
page_token	string

SELECT examples

get

[DEPRECATED] Read a quality monitor on UC object. Use Data Quality Monitoring API instead.

SELECT
object_id,
anomaly_detection_config,
object_type,
validity_check_configurations
FROM databricks_workspace.qualitymonitorv2.quality_monitor_v2
WHERE object_type = '{{ object_type }}' -- required
AND object_id = '{{ object_id }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
;

list

[DEPRECATED] (Unimplemented) List quality monitors. Use Data Quality Monitoring API instead.

SELECT
object_id,
anomaly_detection_config,
object_type,
validity_check_configurations
FROM databricks_workspace.qualitymonitorv2.quality_monitor_v2
WHERE deployment_name = '{{ deployment_name }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create

[DEPRECATED] Create a quality monitor on UC object. Use Data Quality Monitoring API instead.

INSERT INTO databricks_workspace.qualitymonitorv2.quality_monitor_v2 (
quality_monitor,
deployment_name
)
SELECT 
'{{ quality_monitor }}' /* required */,
'{{ deployment_name }}'
RETURNING
object_id,
anomaly_detection_config,
object_type,
validity_check_configurations
;

Manifest

# Description fields are for documentation purposes
- name: quality_monitor_v2
props:
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the quality_monitor_v2 resource.
  - name: quality_monitor
    description: |
      :returns: :class:`QualityMonitor`
    value:
      object_type: "{{ object_type }}"
      object_id: "{{ object_id }}"
      anomaly_detection_config:
        excluded_table_full_names:
          - "{{ excluded_table_full_names }}"
        last_run_id: "{{ last_run_id }}"
        latest_run_status: "{{ latest_run_status }}"
      validity_check_configurations:
        - name: "{{ name }}"
          percent_null_validity_check:
            column_names:
              - "{{ column_names }}"
            upper_bound: {{ upper_bound }}
          range_validity_check:
            column_names:
              - "{{ column_names }}"
            lower_bound: {{ lower_bound }}
            upper_bound: {{ upper_bound }}
          uniqueness_validity_check:
            column_names:
              - "{{ column_names }}"

REPLACE examples

update

[DEPRECATED] (Unimplemented) Update a quality monitor on UC object. Use Data Quality Monitoring API

REPLACE databricks_workspace.qualitymonitorv2.quality_monitor_v2
SET 
quality_monitor = '{{ quality_monitor }}'
WHERE 
object_type = '{{ object_type }}' --required
AND object_id = '{{ object_id }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND quality_monitor = '{{ quality_monitor }}' --required
RETURNING
object_id,
anomaly_detection_config,
object_type,
validity_check_configurations;

DELETE examples

delete

[DEPRECATED] Delete a quality monitor on UC object. Use Data Quality Monitoring API instead.

DELETE FROM databricks_workspace.qualitymonitorv2.quality_monitor_v2
WHERE object_type = '{{ object_type }}' --required
AND object_id = '{{ object_id }}' --required
AND deployment_name = '{{ deployment_name }}' --required
;