Last updated: July 22, 2025

DQOps YAML file definitions

The definition of YAML files used by DQOps to configure the data sources, monitored tables, and the configuration of activated data quality checks.

CheckDefinitionYaml

Custom data quality check file that describes a pair of a sensor name and rule name.

The structure of this object is described below

Property name	Description	Data type	Enum values	Default value
`api_version`	DQOps YAML schema version	string		dqo/v1
`kind`	File type	enum	source table sensor provider_sensor rule check settings file_index connection_similarity_index dashboards default_schedules default_checks default_table_checks default_column_checks default_notifications	check
`spec`	Custom data quality check specification object with definition of a custom check	CheckDefinitionSpec

Custom data quality check specification. Provides the custom check configuration which is a pair of a sensor name and a rule name.

The structure of this object is described below

Property name	Description	Data type	Enum values
`sensor_name`	Sensor name. It is a folder name inside the user's home 'sensors' folder or the DQOps Home (DQOps distribution) home/sensors folder. Sample sensor name: table/volume/row_count.	string
`rule_name`	Rule name used for the check. It is a path to a custom rule python module that starts at the user's home 'rules' folder. The path should not end with the .py file extension. Sample rule: myrules/my_custom_rule.	string
`help_text`	Help text that describes the data quality check.	string
`friendly_name`	An alternative check's name that is shown on the check editor.	string
`standard`	This is a standard data quality check that is always shown on the data quality checks editor screen. Non-standard data quality checks (when the value is false) are advanced checks that are shown when the user decides to expand the list of checks.	boolean
`default_severity`	The severity level (warning, error, fatal) for the default rule that is activated in the data quality check editor when the check is enabled.	enum	none warning error fatal