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.

SensorDefinitionYaml

Data quality sensor definition YAML schema for a data quality sensor specification.

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	sensor
`spec`	Custom data quality sensor specification object with definition of a custom sensor	SensorDefinitionSpec

Data Quality sensor definition specification. Provides the configuration for a data quality sensor definition, sensor's parameters, etc.

The structure of this object is described below

Property name	Description	Data type
`fields`	List of fields that are parameters of a custom sensor. Those fields are used by the DQOps UI to display the data quality check editing screens with proper UI controls for all required fields.	ParameterDefinitionsListSpec
`requires_event_timestamp`	The data quality sensor depends on the configuration of the event timestamp column name on the analyzed table. When true, the name of the column that stores the event (transaction, etc.) timestamp must be specified in the timestamp_columns.event_timestamp_column field on the table.	boolean
`requires_ingestion_timestamp`	The data quality sensor depends on the configuration of the ingestion timestamp column name on the analyzed table. When true, the name of the column that stores the ingestion (created_at, loaded_at, etc.) timestamp must be specified in the timestamp_columns.ingestion_timestamp_column field on the table.	boolean
`default_value`	Default value that is used when the sensor returns no rows. A row count sensor may return no rows when a GROUP BY condition is added to capture the database server's local time zone. In order to always return a value, a sensor may have a default value configured.	double
`parameters`	Additional sensor definition parameters	Dict[string, string]

List of parameter definitions - the parameters for custom sensors or custom rules.

The structure of this object is described below

Property name	Description	Data type	Enum values	Default value	Sample values
`self`		List[ParameterDefinitionSpec]

Defines a single field that is a sensor parameter or a rule parameter.

The structure of this object is described below

Property name	Description	Data type	Enum values
`field_name`	Field name that matches the field name (snake_case) used in the YAML specification.	string
`display_name`	Field display name that should be shown as a label for the control.	string
`help_text`	Help text (full description) that will be shown to the user as a hint when the cursor is moved over the control.	string
`data_type`	Parameter data type.	enum	string boolean integer long double date datetime column_name enum string_list integer_list object
`display_hint`	UI control display hint.	enum	textarea column_names requires_paid_version
`required`	True when the value for the parameter must be provided.	boolean
`allowed_values`	List of allowed values for a field that is of an enum type.	List[string]
`default_value`	The default value for a parameter in a custom check or a custom rule.	string