Skip to content

SettingsYaml

SettingsYaml

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

The structure of this object is described below

 Property name   Description                       Data type   Enum values   Default value   Sample values 
api_version string
kind enum table
dashboards
source
sensor
check
rule
file_index
settings
provider_sensor
spec SettingsSpec

DefaultProfilingColumnObservabilityCheckSettingsSpec

The default configuration of checks that are enabled as data observability advanced profiling checks that will be detecting anomalies for all columns that are imported. This configuration of checks is copied to the list of enabled column level checks on all columns that are imported, for profiling checks only.

The structure of this object is described below

 Property name   Description                       Data type   Enum values   Default value   Sample values 
nulls The default configuration of column level checks that verify nulls and blanks. ColumnNullsProfilingChecksSpec
numeric The default configuration of column level checks that verify negative values. ColumnNumericProfilingChecksSpec
strings The default configuration of strings checks on a column level. ColumnStringsProfilingChecksSpec
uniqueness The default configuration of uniqueness checks on a column level. ColumnUniquenessProfilingChecksSpec
datetime The default configuration of datetime checks on a column level. ColumnDatetimeProfilingChecksSpec
pii The default configuration of Personal Identifiable Information (PII) checks on a column level. ColumnPiiProfilingChecksSpec
bool The default configuration of booleans checks on a column level. ColumnBoolProfilingChecksSpec
datatype The default configuration of datatype checks on a column level. ColumnDatatypeProfilingChecksSpec
anomaly The default configuration of anomaly checks on a column level. ColumnAnomalyProfilingChecksSpec
schema The default configuration of schema checks on a column level. ColumnSchemaProfilingChecksSpec
custom Dictionary of custom checks. The keys are check names. CustomCheckSpecMap

DefaultDailyRecurringObservabilityCheckSettingsSpec

The default configuration of checks that are enabled as data observability daily recurring checks that will be detecting anomalies for all columns and tables that are imported. This configuration of checks is copied to the list of enabled checks on all tables and columns that are imported, for daily recurring checks only.

The structure of this object is described below

 Property name   Description                       Data type   Enum values   Default value   Sample values 
table The default configuration of daily recurring checks on a table level. DefaultDailyRecurringTableObservabilityCheckSettingsSpec
column The default configuration of daily recurring checks on a column level. DefaultDailyRecurringColumnObservabilityCheckSettingsSpec

DefaultDailyRecurringColumnObservabilityCheckSettingsSpec

The default configuration of checks that are enabled as data observability daily recurring checks that will be detecting anomalies for all columns that are imported. This configuration of checks is copied to the list of enabled column level checks on all columns that are imported, for daily recurring checks only.

The structure of this object is described below

 Property name   Description                       Data type   Enum values   Default value   Sample values 
nulls The default configuration of column level checks that verify nulls and blanks. ColumnNullsDailyRecurringChecksSpec
numeric The default configuration of column level checks that verify negative values. ColumnNumericDailyRecurringChecksSpec
strings The default configuration of strings checks on a column level. ColumnStringsDailyRecurringChecksSpec
uniqueness The default configuration of uniqueness checks on a column level. ColumnUniquenessDailyRecurringChecksSpec
datetime The default configuration of datetime checks on a column level. ColumnDatetimeDailyRecurringChecksSpec
pii The default configuration of Personal Identifiable Information (PII) checks on a column level. ColumnPiiDailyRecurringChecksSpec
bool The default configuration of booleans checks on a column level. ColumnBoolDailyRecurringChecksSpec
datatype The default configuration of datatype checks on a column level. ColumnDatatypeDailyRecurringChecksSpec
anomaly The default configuration of anomaly checks on a column level. ColumnAnomalyDailyRecurringChecksSpec
schema The default configuration of schema checks on a column level. ColumnSchemaDailyRecurringChecksSpec
custom Dictionary of custom checks. The keys are check names. CustomCheckSpecMap

DefaultProfilingTableObservabilityCheckSettingsSpec

The default configuration of checks that are enabled as data observability advanced profiling checks that will be detecting anomalies for all tables that are imported. This configuration of checks is copied to the list of enabled table level checks on all tables that are imported, for profiling checks only.

The structure of this object is described below

 Property name   Description                       Data type   Enum values   Default value   Sample values 
volume The default configuration of volume data quality checks on a table level. TableVolumeProfilingChecksSpec
availability The default configuration of the table availability data quality checks on a table level. TableAvailabilityProfilingChecksSpec
schema The default configuration of schema (column count and schema) data quality checks on a table level. TableSchemaProfilingChecksSpec
custom Dictionary of custom checks. The keys are check names. CustomCheckSpecMap

DefaultDailyRecurringTableObservabilityCheckSettingsSpec

The default configuration of checks that are enabled as data observability daily recurring checks that will be detecting anomalies for all tables that are imported. This configuration of checks is copied to the list of enabled table level checks on all tables that are imported, for daily recurring checks only.

The structure of this object is described below

 Property name   Description                       Data type   Enum values   Default value   Sample values 
volume The default configuration of volume data quality checks on a table level. TableVolumeDailyRecurringChecksSpec
availability The default configuration of the table availability data quality checks on a table level. TableAvailabilityDailyRecurringChecksSpec
schema The default configuration of schema (column count and schema) data quality checks on a table level. TableSchemaDailyRecurringChecksSpec
custom Dictionary of custom checks. The keys are check names. CustomCheckSpecMap

DefaultMonthlyRecurringColumnObservabilityCheckSettingsSpec

The default configuration of checks that are enabled as data observability monthly recurring checks that will be detecting anomalies for all columns that are imported. This configuration of checks is copied to the list of enabled column level checks on all columns that are imported, for monthly recurring checks only.

The structure of this object is described below

 Property name   Description                       Data type   Enum values   Default value   Sample values 
nulls The default configuration of column level checks that verify nulls and blanks. ColumnNullsMonthlyRecurringChecksSpec
numeric The default configuration of column level checks that verify negative values. ColumnNumericMonthlyRecurringChecksSpec
strings The default configuration of strings checks on a column level. ColumnStringsMonthlyRecurringChecksSpec
uniqueness The default configuration of uniqueness checks on a column level. ColumnUniquenessMonthlyRecurringChecksSpec
datetime The default configuration of datetime checks on a column level. ColumnDatetimeMonthlyRecurringChecksSpec
pii The default configuration of Personal Identifiable Information (PII) checks on a column level. ColumnPiiMonthlyRecurringChecksSpec
bool The default configuration of booleans checks on a column level. ColumnBoolMonthlyRecurringChecksSpec
datatype The default configuration of datatype checks on a column level. ColumnDatatypeMonthlyRecurringChecksSpec
anomaly The default configuration of anomaly checks on a column level. ColumnAnomalyMonthlyRecurringChecksSpec
schema The default configuration of schema checks on a column level. ColumnSchemaMonthlyRecurringChecksSpec
custom Dictionary of custom checks. The keys are check names. CustomCheckSpecMap

DefaultMonthlyRecurringTableObservabilityCheckSettingsSpec

The default configuration of checks that are enabled as data observability monthly recurring checks that will be detecting anomalies for all tables that are imported. This configuration of checks is copied to the list of enabled table level checks on all tables that are imported, for monthly recurring checks only.

The structure of this object is described below

 Property name   Description                       Data type   Enum values   Default value   Sample values 
volume The default configuration of volume data quality checks on a table level. TableVolumeMonthlyRecurringChecksSpec
availability The default configuration of the table availability data quality checks on a table level. TableAvailabilityMonthlyRecurringChecksSpec
schema The default configuration of schema (column count and schema) data quality checks on a table level. TableSchemaMonthlyRecurringChecksSpec
custom Dictionary of custom checks. The keys are check names. CustomCheckSpecMap

DefaultMonthlyRecurringObservabilityCheckSettingsSpec

The default configuration of checks that are enabled as data observability monthly recurring checks that will be detecting anomalies for all columns and tables that are imported. This configuration of checks is copied to the list of enabled checks on all tables and columns that are imported, for monthly profiling checks only.

The structure of this object is described below

 Property name   Description                       Data type   Enum values   Default value   Sample values 
table The default configuration of monthly recurring checks on a table level. DefaultMonthlyRecurringTableObservabilityCheckSettingsSpec
column The default configuration of monthly recurring checks on a column level. DefaultMonthlyRecurringColumnObservabilityCheckSettingsSpec

DefaultObservabilityCheckSettingsSpec

The default configuration of checks that are enabled as data observability checks that will be detecting anomalies for all columns and tables that are imported. This configuration of checks is copied to the list of enabled checks on all tables and columns that are imported.

The structure of this object is described below

 Property name   Description                       Data type   Enum values   Default value   Sample values 
profiling Default configuration of advanced profiling checks that are enabled on tables and columns that are imported into DQO. DefaultProfilingObservabilityCheckSettingsSpec
recurring_daily Default configuration of daily recurring checks (executed once a day, storing or overriding one result per day) that are enabled on tables and columns that are imported into DQO. DefaultDailyRecurringObservabilityCheckSettingsSpec
recurring_monthly Default configuration of daily recurring checks (executed once a day, storing or overriding one result per month) that are enabled on tables and columns that are imported into DQO. DefaultMonthlyRecurringObservabilityCheckSettingsSpec

SettingsSpec

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, Intellj) string
editor_path Editor path on user's computer string
api_key Api key string
instance_signature_key DQO 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 DQO server instance. string
default_schedules Configuration of the default schedules that are assigned to new connections to data sources that are imported. The settings that are configured take precedence over configuration from the DQO command line parameters and environment variables. RecurringSchedulesSpec
default_data_observability_checks The default configuration of Data Observability checks that are tracking volume, detecting schema drifts and basic anomalies on data. DefaultObservabilityCheckSettingsSpec

DefaultProfilingObservabilityCheckSettingsSpec

The default configuration of checks that are enabled as data observability advanced profiling checks that will be detecting anomalies for all columns and tables that are imported. This configuration of checks is copied to the list of enabled checks on all tables and columns that are imported, for profiling checks only.

The structure of this object is described below

 Property name   Description                       Data type   Enum values   Default value   Sample values 
table The default configuration of profiling checks on a table level. DefaultProfilingTableObservabilityCheckSettingsSpec
column The default configuration of profiling checks on a column level. DefaultProfilingColumnObservabilityCheckSettingsSpec