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.
ProviderSensorYaml
Provider specific data quality sensor definition YAML schema for a data quality sensor configuration specification.
The structure of this object is described below
Property name | Description | Data type | Enum values | Default value | Sample values |
---|---|---|---|---|---|
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 |
provider_sensor | |
spec |
Custom data quality data source specific sensor specification object with definition of a custom sensor for that type of the data source | ProviderSensorDefinitionSpec |
ProviderSensorDefinitionSpec
Specification (configuration) for a provider specific implementation of a data quality sensor or an SQL template.
The structure of this object is described below
Property name | Description | Data type | Enum values | Default value | Sample values |
---|---|---|---|---|---|
type |
Sensor implementation type | enum | sql_template java_class |
||
java_class_name |
Java class name for a sensor runner that will execute the sensor. The "type" must be "java_class". | string | |||
supports_grouping |
The sensor supports grouping, using the GROUP BY clause in SQL. Sensors that support a GROUP BY condition can capture separate data quality scores for each data group. The default value is true, because most of the data quality sensor support grouping. | boolean | |||
supports_partitioned_checks |
The sensor supports grouping by a partition date, using the GROUP BY clause in SQL. Sensors that support grouping by a partition_by_column can be used for partition checks, calculating separate data quality metrics for each daily/monthly partition. The default value is true, because most of the data quality sensor support partitioned checks. | boolean | |||
parameters |
Additional provider specific sensor parameters | Dict[string, string] | |||
disable_merging_queries |
Disables merging this sensor's SQL with other sensors. When this parameter is 'true', the sensor's SQL will be executed as an independent query. | boolean |