Skip to content

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.

LocalSettingsYaml

DQOps local settings that are stored in the $DQO_USER_HOME/.localsettings.dqosettings.yaml file in the user's DQOps home folder. The local settings contain the current DQOps Cloud API Key and other settings. The local settings take precedence over parameters passed when starting DQOps.

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
 settings
spec The object that stores the configuration settings of a local DQOps instance LocalSettingsSpec

LocalSettingsSpec

Local settings specification.

The structure of this object is described below

 Property name   Description                       Data type   Enum values   Default value   Sample values 
editor_name Editor name spec (VSC, Eclipse, Intellij) string
editor_path Editor path on user's computer string
api_key DQOps Cloud API Key string
disable_cloud_sync Disable synchronization with DQOps Cloud boolean
instance_signature_key DQOps instance signature key used to sign keys. This should be a Base64 encoded binary key at a 32 bytes length. string
time_zone Default IANA time zone name of the server. This time zone is used to convert the time of UTC timestamps values returned from databases to a uniform local date and time. The default value is the local time zone of the DQOps server instance. string
instance_name DQOps instance name assigned to this server instance. DQOps supports scheduling data quality checks only on selected instances. If this parameter is not set, DQOps will use a name passed as a parameter or environment variable. The fallback value is the host name. string
smtp_server_configuration SMTP server configuration for incident notifications. SmtpServerConfigurationSpec
data_domains A dictionary containing the configuration of local data domains managed by this instance. LocalDataDomainSpecMap
data_catalog_urls A list of urls of special REST API services that will transform DQOps data quality health models to a format supported by a target data catalog platform. These services are called to push the health status of tables. DataCatalogUrlsSetSpec

SmtpServerConfigurationSpec

SMTP server configuration specification.

The structure of this object is described below

 Property name   Description                       Data type   Enum values   Default value   Sample values 
host SMTP server host string
port SMTP server port string
use_ssl SMTP server use SSL option boolean
username SMTP server username string
password SMTP server password string

LocalDataDomainSpecMap

Dictionary of local data domains.

The structure of this object is described below

 Property name   Description                       Data type   Enum values   Default value   Sample values 
self Dict[string, LocalDataDomainSpec]

LocalDataDomainSpec

Specification of the local data domain.

The structure of this object is described below

 Property name   Description                       Data type   Enum values   Default value   Sample values 
display_name Data domain display name, which is a user-friendly name to be shown in the UI string
enable_scheduler Enables the job scheduler for this domain. boolean

DataCatalogUrlsSetSpec

A collection of unique urls of data catalog synchronization endpoints where DQOps sends updated data quality health statuses of tables.