quality-monitor-v2 command group
Databricks CLI use is subject to the Databricks License and Databricks Privacy Notice, including any Usage Data provisions.
These commands are deprecated. Use the data-quality commands instead. See data-quality command group.
The quality-monitor-v2 command group within the Databricks CLI allows you to manage data quality monitors on Unity Catalog objects.
databricks quality-monitor-v2 create-quality-monitor
Deprecated. Use the data-quality commands instead. See data-quality command group.
Create a quality monitor on a Unity Catalog object.
databricks quality-monitor-v2 create-quality-monitor OBJECT_TYPE OBJECT_ID [flags]
Arguments
OBJECT_TYPE
The type of the monitored object. Supported values: schema.
OBJECT_ID
The UUID of the request object. For example, the schema ID.
Options
--json JSON
The inline JSON string or the @path to the JSON file with the request body.
Examples
The following example creates a quality monitor:
databricks quality-monitor-v2 create-quality-monitor schema 12345678-1234-1234-1234-123456789012 --json @monitor.json
databricks quality-monitor-v2 delete-quality-monitor
Deprecated. Use the data-quality commands instead. See data-quality command group.
Delete a quality monitor on a Unity Catalog object.
databricks quality-monitor-v2 delete-quality-monitor OBJECT_TYPE OBJECT_ID [flags]
Arguments
OBJECT_TYPE
The type of the monitored object. Supported values: schema.
OBJECT_ID
The UUID of the request object. For example, the schema ID.
Options
Examples
The following example deletes a quality monitor:
databricks quality-monitor-v2 delete-quality-monitor schema 12345678-1234-1234-1234-123456789012
databricks quality-monitor-v2 get-quality-monitor
Deprecated. Use the data-quality commands instead. See data-quality command group.
Read a quality monitor on a Unity Catalog object.
databricks quality-monitor-v2 get-quality-monitor OBJECT_TYPE OBJECT_ID [flags]
Arguments
OBJECT_TYPE
The type of the monitored object. Supported values: schema.
OBJECT_ID
The UUID of the request object. For example, the schema ID.
Options
Examples
The following example gets a quality monitor:
databricks quality-monitor-v2 get-quality-monitor schema 12345678-1234-1234-1234-123456789012
databricks quality-monitor-v2 list-quality-monitor
Deprecated. Use the data-quality commands instead. See data-quality command group.
List quality monitors.
databricks quality-monitor-v2 list-quality-monitor [flags]
Arguments
None
Options
--page-size int
The maximum number of monitors to return.
--page-token string
A page token from a previous list call.
Examples
The following example lists quality monitors:
databricks quality-monitor-v2 list-quality-monitor
databricks quality-monitor-v2 update-quality-monitor
Deprecated. Use the data-quality commands instead. See data-quality command group.
Update a quality monitor on a Unity Catalog object.
databricks quality-monitor-v2 update-quality-monitor OBJECT_TYPE OBJECT_ID OBJECT_TYPE OBJECT_ID [flags]
Arguments
OBJECT_TYPE
The type of the monitored object. Supported values: schema.
OBJECT_ID
The UUID of the request object. For example, the schema ID.
Options
--json JSON
The inline JSON string or the @path to the JSON file with the request body.
Examples
The following example updates a quality monitor:
databricks quality-monitor-v2 update-quality-monitor schema 12345678-1234-1234-1234-123456789012 schema 12345678-1234-1234-1234-123456789012 --json @monitor.json
Global flags
--debug
Whether to enable debug logging.
-h or --help
Display help for the Databricks CLI or the related command group or the related command.
--log-file string
A string representing the file to write output logs to. If this flag is not specified then the default is to write output logs to stderr.
--log-format format
The log format type, text or json. The default value is text.
--log-level string
A string representing the log format level. If not specified then the log format level is disabled.
-o, --output type
The command output type, text or json. The default value is text.
-p, --profile string
The name of the profile in the ~/.databrickscfg file to use to run the command. If this flag is not specified then if it exists, the profile named DEFAULT is used.
--progress-format format
The format to display progress logs: default, append, inplace, or json
-t, --target string
If applicable, the bundle target to use