Working with the YAML files
In DQO, the configuration of data quality checks is defined in the YAML files. YAML is a human-readable data serialization language that is often used for writing configuration files.
Defining data quality checks in the YAML files allows checks definitions to be stored in a source code repository and versioned along with any other pipeline code or machine learning code.
Below is an example of the YAML file showing sample configuration of an advanced profiling column data quality check nulls_percent.
# yaml-language-server: $schema=https://cloud.dqo.ai/dqo-yaml-schema/TableYaml-schema.json apiVersion: dqo/v1 kind: table spec: target: schema_name: target_schema table_name: target_table timestamp_columns: event_timestamp_column: col_event_timestamp ingestion_timestamp_column: col_inserted_at partitioned_checks_timestamp_source: event_timestamp incremental_time_window: daily_partitioning_recent_days: 7 monthly_partitioning_recent_months: 1 columns: target_column: profiling_checks: nulls: nulls_percent: warning: max_percent: 1.0 error: max_percent: 5.0 fatal: max_percent: 30.0 labels: - This is the column that is analyzed for data quality issues col_event_timestamp: labels: - optional column that stores the timestamp when the event/transaction happened col_inserted_at: labels: - optional column that stores the timestamp when row was ingested
specsection contains the details of the table, including the target schema and table name.
timestamp_columns section specifies the column names for various timestamps in the data.
columns section lists the columns in the table which has configured checks. In this example the column named
target_column has a configured check
nulls_percent. This means that the sensor reads the percentage of null
target_column. If the percentage exceeds a certain threshold, an error, warning, or fatal message will
Editing the YAML files
YAMl configuration files are located in the
./sources folder. The complete DQO YAML schema can e found
The YAML files in DQO support code completion in code editors such as Visual Studio Code. Remember to install the YAML extension by RedHat and Better Jinja by Samuel Colvin.