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.
ColumnMonthlyMonitoringCheckCategoriesSpec
Container of column level monthly monitoring checks. Contains categories of monthly monitoring checks.
The structure of this object is described below
Property name | Description | Data type | Enum values | Default value | Sample values |
---|---|---|---|---|---|
nulls |
Monthly monitoring checks of nulls in the column | ColumnNullsMonthlyMonitoringChecksSpec | |||
uniqueness |
Monthly monitoring checks of uniqueness in the column | ColumnUniquenessMonthlyMonitoringChecksSpec | |||
accepted_values |
Configuration of accepted values checks on a column level | ColumnAcceptedValuesMonthlyMonitoringChecksSpec | |||
text |
Monthly monitoring checks of text values in the column | ColumnTextMonthlyMonitoringChecksSpec | |||
whitespace |
Configuration of column level checks that detect blank and whitespace values | ColumnWhitespaceMonthlyMonitoringChecksSpec | |||
conversions |
Configuration of conversion testing checks on a column level. | ColumnConversionsMonthlyMonitoringChecksSpec | |||
patterns |
Monthly monitoring checks of pattern matching on a column level | ColumnPatternsMonthlyMonitoringChecksSpec | |||
pii |
Monthly monitoring checks of Personal Identifiable Information (PII) in the column | ColumnPiiMonthlyMonitoringChecksSpec | |||
numeric |
Monthly monitoring checks of numeric values in the column | ColumnNumericMonthlyMonitoringChecksSpec | |||
datetime |
Monthly monitoring checks of datetime in the column | ColumnDatetimeMonthlyMonitoringChecksSpec | |||
bool |
Monthly monitoring checks of booleans in the column | ColumnBoolMonthlyMonitoringChecksSpec | |||
integrity |
Monthly monitoring checks of integrity in the column | ColumnIntegrityMonthlyMonitoringChecksSpec | |||
accuracy |
Monthly monitoring checks of accuracy in the column | ColumnAccuracyMonthlyMonitoringChecksSpec | |||
custom_sql |
Monthly monitoring checks of custom SQL checks in the column | ColumnCustomSqlMonthlyMonitoringChecksSpec | |||
datatype |
Monthly monitoring checks of datatype in the column | ColumnDatatypeMonthlyMonitoringChecksSpec | |||
schema |
Monthly monitoring column schema checks | ColumnSchemaMonthlyMonitoringChecksSpec | |||
comparisons |
Dictionary of configuration of checks for table comparisons at a column level. The key that identifies each comparison must match the name of a data comparison that is configured on the parent table. | ColumnComparisonMonthlyMonitoringChecksSpecMap | |||
custom |
Dictionary of custom checks. The keys are check names within this category. | CustomCheckSpecMap |
ColumnNullsMonthlyMonitoringChecksSpec
Container of nulls data quality monitoring checks on a column level that are checking at a monthly level.
The structure of this object is described below
Property name | Description | Data type | Enum values | Default value | Sample values |
---|---|---|---|---|---|
monthly_nulls_count |
Detects incomplete columns that contain any null values. Counts the number of rows having a null value. Raises a data quality issue when the count of null values is above a max_count threshold.. Stores the most recent count check result for each month when the data quality check was evaluated. | ColumnNullsCountCheckSpec | |||
monthly_nulls_percent |
Detects incomplete columns that contain any null values. Measures the percentage of rows having a null value. Raises a data quality issue when the percentage of null values is above a max_percent threshold. Stores the most recent check result for each month when the data quality check was evaluated. | ColumnNullsPercentCheckSpec | |||
monthly_not_nulls_count |
Verifies that a column contains a minimum number of non-null values. The default value of the min_count parameter is 1 to detect at least one value in a monitored column. Raises a data quality issue when the count of non-null values is below min_count. Stores the most recent check result for each month when the data quality check was evaluated. | ColumnNotNullsCountCheckSpec | |||
monthly_not_nulls_percent |
Detects columns that contain too many non-null values. Measures the percentage of rows that have non-null values. Raises a data quality issue when the percentage of non-null values is above max_percentage. Stores the most recent check result for each month when the data quality check was evaluated. | ColumnNotNullsPercentCheckSpec | |||
monthly_empty_column_found |
Detects empty columns that contain only null values. Counts the number of rows that have non-null values. Raises a data quality issue when the column is empty. Stores the most recent check result for each month when the data quality check was evaluated. | ColumnEmptyColumnFoundCheckSpec | |||
custom_checks |
Dictionary of additional custom checks within this category. The keys are check names defined in the definition section. The sensor parameters and rules should match the type of the configured sensor and rule for the custom check. | CustomCategoryCheckSpecMap |
ColumnUniquenessMonthlyMonitoringChecksSpec
Container of uniqueness data quality monitoring checks on a column level that are checking at a monthly level.
The structure of this object is described below
Property name | Description | Data type | Enum values | Default value | Sample values |
---|---|---|---|---|---|
monthly_distinct_count |
Verifies that the number of distinct values stays within an accepted range. Stores the most recent check result for each month when the data quality check was evaluated. | ColumnDistinctCountCheckSpec | |||
monthly_distinct_percent |
Verifies that the percentage of distinct values in a column does not fall below the minimum accepted percent. Stores the most recent check result for each month when the data quality check was evaluated. | ColumnDistinctPercentCheckSpec | |||
monthly_duplicate_count |
Verifies that the number of duplicate values in a column does not exceed the maximum accepted count. Stores the most recent check result for each month when the data quality check was evaluated. | ColumnDuplicateCountCheckSpec | |||
monthly_duplicate_percent |
Verifies that the percentage of duplicate values in a column does not exceed the maximum accepted percentage. Stores the most recent check result for each month when the data quality check was evaluated. | ColumnDuplicatePercentCheckSpec | |||
monthly_distinct_count_change |
Verifies that the distinct count in a monitored column has changed by a fixed rate since the last readout. | ColumnDistinctCountChangeCheckSpec | |||
monthly_distinct_percent_change |
Verifies that the distinct percent in a monitored column has changed by a fixed rate since the last readout. | ColumnDistinctPercentChangeCheckSpec | |||
custom_checks |
Dictionary of additional custom checks within this category. The keys are check names defined in the definition section. The sensor parameters and rules should match the type of the configured sensor and rule for the custom check. | CustomCategoryCheckSpecMap |
ColumnAcceptedValuesMonthlyMonitoringChecksSpec
Container of accepted values data quality monitoring checks on a column level that are checking at a monthly level.
The structure of this object is described below
Property name | Description | Data type | Enum values | Default value | Sample values |
---|---|---|---|---|---|
monthly_text_found_in_set_percent |
The check measures the percentage of rows whose value in a tested column is one of values from a list of expected values or the column value is null. Verifies that the percentage of rows having a valid column value does not exceed the minimum accepted percentage. Stores the most recent captured value for each month when the data quality check was evaluated. | ColumnTextFoundInSetPercentCheckSpec | |||
monthly_number_found_in_set_percent |
The check measures the percentage of rows whose value in a tested column is one of values from a list of expected values or the column value is null. Verifies that the percentage of rows having a valid column value does not exceed the minimum accepted percentage. Stores the most recent captured value for each month when the data quality check was evaluated. | ColumnNumberFoundInSetPercentCheckSpec | |||
monthly_expected_text_values_in_use_count |
Verifies that the expected string values were found in the column. Raises a data quality issue when too many expected values were not found (were missing). Stores the most recent captured value for each month when the data quality check was evaluated. | ColumnExpectedTextValuesInUseCountCheckSpec | |||
monthly_expected_texts_in_top_values_count |
Verifies that the top X most popular column values contain all values from a list of expected values. Stores the most recent captured value for each month when the data quality check was evaluated. | ColumnExpectedTextsInTopValuesCountCheckSpec | |||
monthly_expected_numbers_in_use_count |
Verifies that the expected numeric values were found in the column. Raises a data quality issue when too many expected values were not found (were missing). Stores the most recent captured value for each month when the data quality check was evaluated. | ColumnExpectedNumbersInUseCountCheckSpec | |||
monthly_text_valid_country_code_percent |
Verifies that the percentage of valid country codes in a text column does not fall below the minimum accepted percentage. Stores the most recent captured value for each month when the data quality check was evaluated. | ColumnTextValidCountryCodePercentCheckSpec | |||
monthly_text_valid_currency_code_percent |
Verifies that the percentage of valid currency codes in a text column does not fall below the minimum accepted percentage. Stores the most recent captured value for each month when the data quality check was evaluated. | ColumnTextValidCurrencyCodePercentCheckSpec | |||
custom_checks |
Dictionary of additional custom checks within this category. The keys are check names defined in the definition section. The sensor parameters and rules should match the type of the configured sensor and rule for the custom check. | CustomCategoryCheckSpecMap |
ColumnTextMonthlyMonitoringChecksSpec
Container of text data quality monitoring checks on a column level that are checking at a monthly level.
The structure of this object is described below
Property name | Description | Data type | Enum values | Default value | Sample values |
---|---|---|---|---|---|
monthly_text_min_length |
This check finds the length of the shortest text in a column. Then, it verifies that the minimum length is within an accepted range. It detects that the shortest text is too short. Stores the most recent captured value for each month when the data quality check was evaluated. | ColumnTextMinLengthCheckSpec | |||
monthly_text_max_length |
This check finds the length of the longest text in a column. Then, it verifies that the maximum length is within an accepted range. It detects that the texts are too long or not long enough. Stores the most recent captured value for each month when the data quality check was evaluated. | ColumnTextMaxLengthCheckSpec | |||
monthly_text_mean_length |
Verifies that the mean (average) length of texts in a column is within an accepted range. Stores the most recent captured value for each month when the data quality check was evaluated. | ColumnTextMeanLengthCheckSpec | |||
monthly_text_length_below_min_length |
The check counts the number of text values in the column that is below the length defined by the user as a parameter. Stores the most recent captured value for each month when the data quality check was evaluated. | ColumnTextLengthBelowMinLengthCheckSpec | |||
monthly_text_length_below_min_length_percent |
The check measures the percentage of text values in the column that is below the length defined by the user as a parameter. Stores the most recent captured value for each month when the data quality check was evaluated. | ColumnTextLengthBelowMinLengthPercentCheckSpec | |||
monthly_text_length_above_max_length |
The check counts the number of text values in the column that is above the length defined by the user as a parameter. Stores the most recent captured value for each month when the data quality check was evaluated. | ColumnTextLengthAboveMaxLengthCheckSpec | |||
monthly_text_length_above_max_length_percent |
The check measures the percentage of text values in the column that is above the length defined by the user as a parameter. Stores the most recent captured value for each month when the data quality check was evaluated. | ColumnTextLengthAboveMaxLengthPercentCheckSpec | |||
monthly_text_length_in_range_percent |
The check measures the percentage of those text values with length in the range provided by the user in the column. Stores the most recent captured value for each month when the data quality check was evaluated. | ColumnTextLengthInRangePercentCheckSpec | |||
monthly_min_word_count |
This check finds the lowest word count of text in a column. Then, it verifies that the minimum length is within an accepted range. It detects that the text contains too less words. | ColumnTextMinWordCountCheckSpec | |||
monthly_max_word_count |
This check finds the highest word count of text in a column. Then, it verifies that the maximum length is within an accepted range. It detects that the text contains too many words. | ColumnTextMaxWordCountCheckSpec | |||
custom_checks |
Dictionary of additional custom checks within this category. The keys are check names defined in the definition section. The sensor parameters and rules should match the type of the configured sensor and rule for the custom check. | CustomCategoryCheckSpecMap |
ColumnWhitespaceMonthlyMonitoringChecksSpec
Container of whitespace value detection data quality monitoring checks on a column level that are checking at a monthly level.
The structure of this object is described below
Property name | Description | Data type | Enum values | Default value | Sample values |
---|---|---|---|---|---|
monthly_empty_text_found |
Detects empty texts (not null, zero-length texts). This check counts empty and raises a data quality issue when their count exceeds a max_count parameter value. Stores the most recent captured value for each day when the data quality check was evaluated. | ColumnWhitespaceEmptyTextFoundCheckSpec | |||
monthly_whitespace_text_found |
Detects texts that contain only spaces and other whitespace characters. It raises a data quality issue when their count exceeds a max_count parameter value. Stores the most recent captured value for each day when the data quality check was evaluated. | ColumnWhitespaceWhitespaceTextFoundCheckSpec | |||
monthly_null_placeholder_text_found |
Detects texts that are well-known placeholders of null values, such as None, null, n/a. It counts null placeholders and raises a data quality issue when their count exceeds a max_count parameter value. Stores the most recent captured value for each day when the data quality check was evaluated. | ColumnWhitespaceNullPlaceholderTextFoundCheckSpec | |||
monthly_empty_text_percent |
Detects empty texts (not null, zero-length texts) and measures their percentage in the column. This check verifies that the rate of empty strings in a column does not exceed the maximum accepted percentage. Stores the most recent captured value for each day when the data quality check was evaluated. | ColumnWhitespaceEmptyTextPercentCheckSpec | |||
monthly_whitespace_text_percent |
Detects texts that contain only spaces and other whitespace characters and measures their percentage in the column. It raises a data quality issue when their rate exceeds a max_percent parameter value. Stores the most recent captured value for each day when the data quality check was evaluated. | ColumnWhitespaceWhitespaceTextPercentCheckSpec | |||
monthly_null_placeholder_text_percent |
Detects texts that are well-known placeholders of null values, such as None, null, n/a, and measures their percentage in the column. It raises a data quality issue when their rate exceeds a max_percent parameter value. Stores the most recent captured value for each day when the data quality check was evaluated. | ColumnWhitespaceNullPlaceholderTextPercentCheckSpec | |||
monthly_text_surrounded_by_whitespace_found |
Detects text values that are surrounded by whitespace characters on any side. This check counts whitespace-surrounded texts and raises a data quality issue when their count exceeds the max_count parameter value. Stores the most recent captured value for each month when the data quality check was evaluated. | ColumnWhitespaceTextSurroundedByWhitespaceFoundCheckSpec | |||
monthly_text_surrounded_by_whitespace_percent |
This check detects text values that are surrounded by whitespace characters on any side and measures their percentage. This check raises a data quality issue when their percentage exceeds the max_percent parameter value. Stores the most recent captured value for each month when the data quality check was evaluated. | ColumnWhitespaceTextSurroundedByWhitespacePercentCheckSpec | |||
custom_checks |
Dictionary of additional custom checks within this category. The keys are check names defined in the definition section. The sensor parameters and rules should match the type of the configured sensor and rule for the custom check. | CustomCategoryCheckSpecMap |
ColumnConversionsMonthlyMonitoringChecksSpec
Container of conversion test checks that are monitoring if text values are convertible to a target data type at a monthly level.
The structure of this object is described below
Property name | Description | Data type | Enum values | Default value | Sample values |
---|---|---|---|---|---|
monthly_text_parsable_to_boolean_percent |
Verifies that the percentage of text values that are parsable to a boolean value does not fall below the minimum accepted percentage, text values identified as boolean placeholders are: 0, 1, true, false, t, f, yes, no, y, n. Stores the most recent captured value for each month when the data quality check was evaluated. | ColumnTextParsableToBooleanPercentCheckSpec | |||
monthly_text_parsable_to_integer_percent |
Verifies that the percentage text values that are parsable to an integer value in a column does not fall below the minimum accepted percentage. Stores the most recent captured value for each month when the data quality check was evaluated. | ColumnTextParsableToIntegerPercentCheckSpec | |||
monthly_text_parsable_to_float_percent |
Verifies that the percentage text values that are parsable to a float value in a column does not fall below the minimum accepted percentage. Stores the most recent captured value for each month when the data quality check was evaluated. | ColumnTextParsableToFloatPercentCheckSpec | |||
monthly_text_parsable_to_date_percent |
Verifies that the percentage text values that are parsable to a date value in a column does not fall below the minimum accepted percentage. DQOps uses a safe_cast when possible, otherwise the text is verified using a regular expression. Stores the most recent captured value for each month when the data quality check was evaluated. | ColumnTextParsableToDatePercentCheckSpec | |||
custom_checks |
Dictionary of additional custom checks within this category. The keys are check names defined in the definition section. The sensor parameters and rules should match the type of the configured sensor and rule for the custom check. | CustomCategoryCheckSpecMap |
ColumnPatternsMonthlyMonitoringChecksSpec
Container of built-in preconfigured monthly monitoring checks on a column level that are checking for values matching patterns (regular expressions) in text columns.
The structure of this object is described below
Property name | Description | Data type | Enum values | Default value | Sample values |
---|---|---|---|---|---|
monthly_text_not_matching_regex_found |
Verifies that the number of text values not matching the custom regular expression pattern does not exceed the maximum accepted count. | ColumnTextNotMatchingRegexFoundCheckSpec | |||
monthly_texts_not_matching_regex_percent |
Verifies that the percentage of strings not matching the custom regular expression pattern does not exceed the maximum accepted percentage. | ColumnTextsNotMatchingRegexPercentCheckSpec | |||
monthly_invalid_email_format_found |
Verifies that the number of invalid emails in a text column does not exceed the maximum accepted count. | ColumnInvalidEmailFormatFoundCheckSpec | |||
monthly_invalid_email_format_percent |
Verifies that the percentage of invalid emails in a text column does not exceed the maximum accepted percentage. | ColumnInvalidEmailFormatPercentCheckSpec | |||
monthly_text_not_matching_date_pattern_found |
Verifies that the number of texts not matching the date format regular expression does not exceed the maximum accepted count. | ColumnTextNotMatchingDatePatternFoundCheckSpec | |||
monthly_text_not_matching_date_pattern_percent |
Verifies that the percentage of texts not matching the date format regular expression in a column does not exceed the maximum accepted percentage. | ColumnTextNotMatchingDatePatternPercentCheckSpec | |||
monthly_text_not_matching_name_pattern_percent |
Verifies that the percentage of texts not matching the name regular expression does not exceed the maximum accepted percentage. | ColumnTextNotMatchingNamePatternPercentCheckSpec | |||
monthly_invalid_uuid_format_found |
Verifies that the number of invalid UUIDs in a text column does not exceed the maximum accepted count. | ColumnInvalidUuidFormatFoundCheckSpec | |||
monthly_invalid_uuid_format_percent |
Verifies that the percentage of invalid UUID in a text column does not exceed the maximum accepted percentage. | ColumnInvalidUuidFormatPercentCheckSpec | |||
monthly_invalid_ip4_address_format_found |
Verifies that the number of invalid IP4 addresses in a text column does not exceed the maximum accepted count. | ColumnInvalidIp4AddressFormatFoundCheckSpec | |||
monthly_invalid_ip6_address_format_found |
Verifies that the number of invalid IP6 addresses in a text column does not exceed the maximum accepted count. | ColumnInvalidIp6AddressFormatFoundCheckSpec | |||
monthly_invalid_usa_phone_format_found |
Verifies that the number of invalid USA phone numbers in a text column does not exceed the maximum accepted count. | ColumnInvalidUsaPhoneFoundCheckSpec | |||
monthly_invalid_usa_zipcode_format_found |
Verifies that the number of invalid zip codes in a text column does not exceed the maximum accepted count. | ColumnInvalidUsaZipcodeFoundCheckSpec | |||
monthly_invalid_usa_phone_format_percent |
Verifies that the percentage of invalid USA phones number in a text column does not exceed the maximum accepted percentage. | ColumnInvalidUsaPhonePercentCheckSpec | |||
monthly_invalid_usa_zipcode_format_percent |
Verifies that the percentage of invalid USA zip code in a text column does not exceed the maximum accepted percentage. | ColumnInvalidUsaZipcodePercentCheckSpec | |||
custom_checks |
Dictionary of additional custom checks within this category. The keys are check names defined in the definition section. The sensor parameters and rules should match the type of the configured sensor and rule for the custom check. | CustomCategoryCheckSpecMap |
ColumnPiiMonthlyMonitoringChecksSpec
Container of PII data quality monitoring checks on a column level that are checking at a monthly level.
The structure of this object is described below
Property name | Description | Data type | Enum values | Default value | Sample values |
---|---|---|---|---|---|
monthly_contains_usa_phone_percent |
Detects USA phone numbers in text columns. Verifies that the percentage of rows that contains a USA phone number in a column does not exceed the maximum accepted percentage. Stores the most recent check result for each month when the data quality check was evaluated. | ColumnPiiContainsUsaPhonePercentCheckSpec | |||
monthly_contains_email_percent |
Detects emails in text columns. Verifies that the percentage of rows that contains emails in a column does not exceed the minimum accepted percentage. Stores the most recent check result for each month when the data quality check was evaluated. | ColumnPiiContainsEmailPercentCheckSpec | |||
monthly_contains_usa_zipcode_percent |
Detects USA zip codes in text columns. Verifies that the percentage of rows that contains a USA zip code in a column does not exceed the maximum accepted percentage. Stores the most recent check result for each month when the data quality check was evaluated. | ColumnPiiContainsUsaZipcodePercentCheckSpec | |||
monthly_contains_ip4_percent |
Detects IP4 addresses in text columns. Verifies that the percentage of rows that contains IP4 address values in a column does not fall below the minimum accepted percentage. Stores the most recent check result for each month when the data quality check was evaluated. | ColumnPiiContainsIp4PercentCheckSpec | |||
monthly_contains_ip6_percent |
Detects IP6 addresses in text columns. Verifies that the percentage of rows that contains valid IP6 address values in a column does not fall below the minimum accepted percentage. Stores the most recent check result for each month when the data quality check was evaluated. | ColumnPiiContainsIp6PercentCheckSpec | |||
custom_checks |
Dictionary of additional custom checks within this category. The keys are check names defined in the definition section. The sensor parameters and rules should match the type of the configured sensor and rule for the custom check. | CustomCategoryCheckSpecMap |
ColumnNumericMonthlyMonitoringChecksSpec
Container of built-in preconfigured data quality monitoring on a column level that are checking numeric values at a monthly level.
The structure of this object is described below
Property name | Description | Data type | Enum values | Default value | Sample values |
---|---|---|---|---|---|
monthly_number_below_min_value |
The check counts the number of values in the column that are below the value defined by the user as a parameter. Stores the most recent value for each month when the data quality check was evaluated. | ColumnNumberBelowMinValueCheckSpec | |||
monthly_number_above_max_value |
The check counts the number of values in the column that are above the value defined by the user as a parameter. Stores the most recent value for each month when the data quality check was evaluated. | ColumnNumberAboveMaxValueCheckSpec | |||
monthly_negative_values |
Verifies that the number of negative values in a column does not exceed the maximum accepted count. Stores the most recent value for each month when the data quality check was evaluated. | ColumnNegativeCountCheckSpec | |||
monthly_negative_values_percent |
Verifies that the percentage of negative values in a column does not exceed the maximum accepted percentage. Stores the most recent value for each month when the data quality check was evaluated. | ColumnNegativePercentCheckSpec | |||
monthly_number_below_min_value_percent |
The check counts the percentage of values in the column that are below the value defined by the user as a parameter. Stores the most recent value for each month when the data quality check was evaluated. | ColumnNumberBelowMinValuePercentCheckSpec | |||
monthly_number_above_max_value_percent |
The check counts the percentage of values in the column that are above the value defined by the user as a parameter. Stores the most recent value for each month when the data quality check was evaluated. | ColumnNumberAboveMaxValuePercentCheckSpec | |||
monthly_number_in_range_percent |
Verifies that the percentage of values from range in a column does not exceed the minimum accepted percentage. Stores the most recent value for each month when the data quality check was evaluated. | ColumnNumberInRangePercentCheckSpec | |||
monthly_integer_in_range_percent |
Verifies that the percentage of values from range in a column does not exceed the minimum accepted percentage. Stores the most recent value for each month when the data quality check was evaluated. | ColumnIntegerInRangePercentCheckSpec | |||
monthly_min_in_range |
Verifies that the minimum value in a column does not exceed the expected range. Stores the most recent value for each month when the data quality check was evaluated. | ColumnMinInRangeCheckSpec | |||
monthly_max_in_range |
Verifies that the maximum value in a column does not exceed the expected range. Stores the most recent value for each month when the data quality check was evaluated. | ColumnMaxInRangeCheckSpec | |||
monthly_sum_in_range |
Verifies that the sum of all values in a column does not exceed the expected range. Stores the most recent value for each month when the data quality check was evaluated. | ColumnSumInRangeCheckSpec | |||
monthly_mean_in_range |
Verifies that the average (mean) of all values in a column does not exceed the expected range. Stores the most recent value for each month when the data quality check was evaluated. | ColumnMeanInRangeCheckSpec | |||
monthly_median_in_range |
Verifies that the median of all values in a column is not outside the expected range. Stores the most recent value for each month when the data quality check was evaluated. | ColumnMedianInRangeCheckSpec | |||
monthly_percentile_in_range |
Verifies that the percentile of all values in a column is not outside the expected range. Stores the most recent value for each month when the data quality check was evaluated. | ColumnPercentileInRangeCheckSpec | |||
monthly_percentile_10_in_range |
Verifies that the percentile 10 of all values in a column is not outside the expected range. Stores the most recent value for each month when the data quality check was evaluated. | ColumnPercentile10InRangeCheckSpec | |||
monthly_percentile_25_in_range |
Verifies that the percentile 25 of all values in a column is not outside the expected range. Stores the most recent value for each month when the data quality check was evaluated. | ColumnPercentile25InRangeCheckSpec | |||
monthly_percentile_75_in_range |
Verifies that the percentile 75 of all values in a column is not outside the expected range. Stores the most recent value for each month when the data quality check was evaluated. | ColumnPercentile75InRangeCheckSpec | |||
monthly_percentile_90_in_range |
Verifies that the percentile 90 of all values in a column is not outside the expected range. Stores the most recent value for each month when the data quality check was evaluated. | ColumnPercentile90InRangeCheckSpec | |||
monthly_sample_stddev_in_range |
Verifies that the sample standard deviation of all values in a column is not outside the expected range. Stores the most recent value for each month when the data quality check was evaluated. | ColumnSampleStddevInRangeCheckSpec | |||
monthly_population_stddev_in_range |
Verifies that the population standard deviation of all values in a column is not outside the expected range. Stores the most recent value for each month when the data quality check was evaluated. | ColumnPopulationStddevInRangeCheckSpec | |||
monthly_sample_variance_in_range |
Verifies that the sample variance of all values in a column is not outside the expected range. Stores the most recent value for each month when the data quality check was evaluated. | ColumnSampleVarianceInRangeCheckSpec | |||
monthly_population_variance_in_range |
Verifies that the population variance of all values in a column is not outside the expected range. Stores the most recent value for each month when the data quality check was evaluated. | ColumnPopulationVarianceInRangeCheckSpec | |||
monthly_invalid_latitude |
Verifies that the number of invalid latitude values in a column does not exceed the maximum accepted count. Stores the most recent value for each month when the data quality check was evaluated. | ColumnInvalidLatitudeCountCheckSpec | |||
monthly_valid_latitude_percent |
Verifies that the percentage of valid latitude values in a column does not fall below the minimum accepted percentage. Stores the most recent value for each month when the data quality check was evaluated. | ColumnValidLatitudePercentCheckSpec | |||
monthly_invalid_longitude |
Verifies that the number of invalid longitude values in a column does not exceed the maximum accepted count. Stores the most recent value for each month when the data quality check was evaluated. | ColumnInvalidLongitudeCountCheckSpec | |||
monthly_valid_longitude_percent |
Verifies that the percentage of valid longitude values in a column does not fall below the minimum accepted percentage. Stores the most recent value for each month when the data quality check was evaluated. | ColumnValidLongitudePercentCheckSpec | |||
monthly_non_negative_values |
Verifies that the number of non-negative values in a column does not exceed the maximum accepted count. Stores the most recent value for each month when the data quality check was evaluated. | ColumnNonNegativeCountCheckSpec | |||
monthly_non_negative_values_percent |
Verifies that the percentage of non-negative values in a column does not exceed the maximum accepted percentage. Stores the most recent value for each month when the data quality check was evaluated. | ColumnNonNegativePercentCheckSpec | |||
custom_checks |
Dictionary of additional custom checks within this category. The keys are check names defined in the definition section. The sensor parameters and rules should match the type of the configured sensor and rule for the custom check. | CustomCategoryCheckSpecMap |
ColumnDatetimeMonthlyMonitoringChecksSpec
Container of date-time data quality monitoring checks on a column level that are checking at a monthly level.
The structure of this object is described below
Property name | Description | Data type | Enum values | Default value | Sample values |
---|---|---|---|---|---|
monthly_date_values_in_future_percent |
Detects dates in the future in date, datetime and timestamp columns. Measures a percentage of dates in the future. Raises a data quality issue when too many future dates are found. Stores the most recent check result for each month when the data quality check was evaluated. | ColumnDateValuesInFuturePercentCheckSpec | |||
monthly_date_in_range_percent |
Verifies that the dates in date, datetime, or timestamp columns are within a reasonable range of dates. The default configuration detects fake dates such as 1900-01-01 and 2099-12-31. Measures the percentage of valid dates and raises a data quality issue when too many dates are found. Stores the most recent check result for each month when the data quality check was evaluated. | ColumnDateInRangePercentCheckSpec | |||
monthly_text_match_date_format_percent |
Verifies that the values in text columns match one of the predefined date formats, such as an ISO 8601 date. Measures the percentage of valid date strings and raises a data quality issue when too many invalid date strings are found. Creates a separate data quality check (and an alert) for each monthly monitoring. | ColumnTextMatchDateFormatPercentCheckSpec | |||
custom_checks |
Dictionary of additional custom checks within this category. The keys are check names defined in the definition section. The sensor parameters and rules should match the type of the configured sensor and rule for the custom check. | CustomCategoryCheckSpecMap |
ColumnBoolMonthlyMonitoringChecksSpec
Container of boolean monitoring data quality checks on a column level that are checking at a monthly level.
The structure of this object is described below
Property name | Description | Data type | Enum values | Default value | Sample values |
---|---|---|---|---|---|
monthly_true_percent |
Measures the percentage of true values in a boolean column and verifies that it is within the accepted range. Stores the most recent check result for each month when the data quality check was evaluated. | ColumnTruePercentCheckSpec | |||
monthly_false_percent |
Measures the percentage of false values in a boolean column and verifies that it is within the accepted range. Stores the most recent check result for each month when the data quality check was evaluated. | ColumnFalsePercentCheckSpec | |||
custom_checks |
Dictionary of additional custom checks within this category. The keys are check names defined in the definition section. The sensor parameters and rules should match the type of the configured sensor and rule for the custom check. | CustomCategoryCheckSpecMap |
ColumnIntegrityMonthlyMonitoringChecksSpec
Container of integrity data quality monitoring checks on a column level that are checking at a monthly level.
The structure of this object is described below
Property name | Description | Data type | Enum values | Default value | Sample values |
---|---|---|---|---|---|
monthly_lookup_key_not_found |
Detects invalid values that are not present in a dictionary table using an outer join query. Counts the number of invalid keys. Stores the most recent check result for each month when the data quality check was evaluated. | ColumnIntegrityLookupKeyNotFoundCountCheckSpec | |||
monthly_lookup_key_found_percent |
Measures the percentage of valid values that are present in a dictionary table. Joins this table to a dictionary table using an outer join. Stores the most recent check result for each month when the data quality check was evaluated. | ColumnIntegrityForeignKeyMatchPercentCheckSpec | |||
custom_checks |
Dictionary of additional custom checks within this category. The keys are check names defined in the definition section. The sensor parameters and rules should match the type of the configured sensor and rule for the custom check. | CustomCategoryCheckSpecMap |
ColumnAccuracyMonthlyMonitoringChecksSpec
Container of accuracy data quality monitoring checks on a column level that are checking at a monthly level.
The structure of this object is described below
Property name | Description | Data type | Enum values | Default value | Sample values |
---|---|---|---|---|---|
monthly_total_sum_match_percent |
Verifies that the percentage of difference in total sum of a column in a table and total sum of a column of another table does not exceed the set number. Stores the most recent check result for each month when the data quality check was evaluated. | ColumnAccuracyTotalSumMatchPercentCheckSpec | |||
monthly_total_min_match_percent |
Verifies that the percentage of difference in total min of a column in a table and total min of a column of another table does not exceed the set number. Stores the most recent check result for each month when the data quality check was evaluated. | ColumnAccuracyTotalMinMatchPercentCheckSpec | |||
monthly_total_max_match_percent |
Verifies that the percentage of difference in total max of a column in a table and total max of a column of another table does not exceed the set number. Stores the most recent check result for each month when the data quality check was evaluated. | ColumnAccuracyTotalMaxMatchPercentCheckSpec | |||
monthly_total_average_match_percent |
Verifies that the percentage of difference in total average of a column in a table and total average of a column of another table does not exceed the set number. Stores the most recent check result for each month when the data quality check was evaluated. | ColumnAccuracyTotalAverageMatchPercentCheckSpec | |||
monthly_total_not_null_count_match_percent |
Verifies that the percentage of difference in total not null count of a column in a table and total not null count of a column of another table does not exceed the set number. Stores the most recent check result for each month when the data quality check was evaluated. | ColumnAccuracyTotalNotNullCountMatchPercentCheckSpec | |||
custom_checks |
Dictionary of additional custom checks within this category. The keys are check names defined in the definition section. The sensor parameters and rules should match the type of the configured sensor and rule for the custom check. | CustomCategoryCheckSpecMap |
ColumnCustomSqlMonthlyMonitoringChecksSpec
Container of built-in preconfigured data quality checks on a column level that are using custom SQL expressions (conditions).
The structure of this object is described below
Property name | Description | Data type | Enum values | Default value | Sample values |
---|---|---|---|---|---|
monthly_sql_condition_failed_on_column |
Verifies that a custom SQL expression is met for each row. Counts the number of rows where the expression is not satisfied, and raises an issue if too many failures were detected. This check is used also to compare values between the current column and another column: `{alias}.{column} > {alias}.col_tax`. Stores the most recent captured count of failed rows for each month when the data quality check was evaluated. | ColumnSqlConditionFailedCheckSpec | |||
monthly_sql_condition_passed_percent_on_column |
Verifies that a minimum percentage of rows passed a custom SQL condition (expression). Reference the current column by using tokens, for example: `{alias}.{column} > {alias}.col_tax`. Stores the most recent check result for each month when the data quality check was evaluated. | ColumnSqlConditionPassedPercentCheckSpec | |||
monthly_sql_aggregate_expression_on_column |
Verifies that a custom aggregated SQL expression (MIN, MAX, etc.) is not outside the expected range. Stores the most recent check result for each month when the data quality check was evaluated. | ColumnSqlAggregateExpressionCheckSpec | |||
monthly_sql_invalid_value_count_on_column |
Runs a custom query that retrieves invalid values found in a column and returns the number of them, and raises an issue if too many failures were detected. This check is used for setting testing queries or ready queries used by users in their own systems (legacy SQL queries). For example, when this check is applied on a column. The condition can find invalid values in the column which have values lower than 18 using an SQL query: `SELECT {column} FROM {table} WHERE {column} < 18`. | ColumnSqlInvalidValueCountCheckSpec | |||
monthly_import_custom_result_on_column |
Runs a custom query that retrieves a result of a data quality check performed in the data engineering, whose result (the severity level) is pulled from a separate table. | ColumnSqlImportCustomResultCheckSpec | |||
custom_checks |
Dictionary of additional custom checks within this category. The keys are check names defined in the definition section. The sensor parameters and rules should match the type of the configured sensor and rule for the custom check. | CustomCategoryCheckSpecMap |
ColumnDatatypeMonthlyMonitoringChecksSpec
Container of datatype data quality monitoring checks on a column level that are checking at a monthly level.
The structure of this object is described below
Property name | Description | Data type | Enum values | Default value | Sample values |
---|---|---|---|---|---|
monthly_detected_datatype_in_text |
Detects the data type of text values stored in the column. The sensor returns the code of the detected type of column data: 1 - integers, 2 - floats, 3 - dates, 4 - datetimes, 5 - timestamps, 6 - booleans, 7 - strings, 8 - mixed data types. Raises a data quality issue when the detected data type does not match the expected data type. Stores the most recent check result for each month when the data quality check was evaluated. | ColumnDetectedDatatypeInTextCheckSpec | |||
monthly_detected_datatype_in_text_changed |
Detects that the data type of texts stored in a text column has changed since the last verification. The sensor returns the detected type of column data: 1 - integers, 2 - floats, 3 - dates, 4 - datetimes, 5 - timestamps, 6 - booleans, 7 - strings, 8 - mixed data types. Stores the most recent captured value for each day when the data quality check was evaluated. | ColumnDatatypeDetectedDatatypeInTextChangedCheckSpec | |||
custom_checks |
Dictionary of additional custom checks within this category. The keys are check names defined in the definition section. The sensor parameters and rules should match the type of the configured sensor and rule for the custom check. | CustomCategoryCheckSpecMap |
ColumnSchemaMonthlyMonitoringChecksSpec
Container of built-in preconfigured data quality checks on a column level that are checking the column schema at a monthly level.
The structure of this object is described below
Property name | Description | Data type | Enum values | Default value | Sample values |
---|---|---|---|---|---|
monthly_column_exists |
Checks the metadata of the monitored table and verifies if the column exists. Stores the most recent value for each month when the data quality check was evaluated. | ColumnSchemaColumnExistsCheckSpec | |||
monthly_column_type_changed |
Checks the metadata of the monitored column and detects if the data type (including the length, precision, scale, nullability) has changed since the last month. Stores the most recent hash for each month when the data quality check was evaluated. | ColumnSchemaTypeChangedCheckSpec | |||
custom_checks |
Dictionary of additional custom checks within this category. The keys are check names defined in the definition section. The sensor parameters and rules should match the type of the configured sensor and rule for the custom check. | CustomCategoryCheckSpecMap |
ColumnComparisonMonthlyMonitoringChecksSpecMap
Container of comparison checks for each defined data comparison. The name of the key in this dictionary must match a name of a table comparison that is defined on the parent table. Contains configuration of column level comparison checks. Each column level check container also defines the name of the reference column name to which we are comparing.
The structure of this object is described below
Property name | Description | Data type | Enum values | Default value | Sample values |
---|---|---|---|---|---|
self |
Dict[string, ColumnComparisonMonthlyMonitoringChecksSpec] |
ColumnComparisonMonthlyMonitoringChecksSpec
Container of built-in preconfigured column level comparison checks that compare min/max/sum/mean/nulls measures between the column in the tested (parent) table and a matching reference column in the reference table (the source of truth). This is the configuration for monthly monitoring checks that are counted in KPIs.
The structure of this object is described below
Property name | Description | Data type | Enum values | Default value | Sample values |
---|---|---|---|---|---|
monthly_sum_match |
Verifies that percentage of the difference between the sum of values in a tested column in a parent table and the sum of a values in a column in the reference table. The difference must be below defined percentage thresholds. Stores the most recent captured value for each month when the data quality check was evaluated. | ColumnComparisonSumMatchCheckSpec | |||
monthly_min_match |
Verifies that percentage of the difference between the minimum value in a tested column in a parent table and the minimum value in a column in the reference table. The difference must be below defined percentage thresholds. Stores the most recent captured value for each month when the data quality check was evaluated. | ColumnComparisonMinMatchCheckSpec | |||
monthly_max_match |
Verifies that percentage of the difference between the maximum value in a tested column in a parent table and the maximum value in a column in the reference table. The difference must be below defined percentage thresholds. Stores the most recent captured value for each month when the data quality check was evaluated. | ColumnComparisonMaxMatchCheckSpec | |||
monthly_mean_match |
Verifies that percentage of the difference between the mean (average) value in a tested column in a parent table and the mean (average) value in a column in the reference table. The difference must be below defined percentage thresholds. Stores the most recent captured value for each month when the data quality check was evaluated. | ColumnComparisonMeanMatchCheckSpec | |||
monthly_not_null_count_match |
Verifies that percentage of the difference between the count of not null values in a tested column in a parent table and the count of not null values in a column in the reference table. The difference must be below defined percentage thresholds. Stores the most recent captured value for each month when the data quality check was evaluated. | ColumnComparisonNotNullCountMatchCheckSpec | |||
monthly_null_count_match |
Verifies that percentage of the difference between the count of null values in a tested column in a parent table and the count of null values in a column in the reference table. The difference must be below defined percentage thresholds. Stores the most recent captured value for each month when the data quality check was evaluated. | ColumnComparisonNullCountMatchCheckSpec | |||
monthly_distinct_count_match |
Verifies that percentage of the difference between the count of distinct values in a tested column in a parent table and the count of distinct values in a column in the reference table. The difference must be below defined percentage thresholds. Stores the most recent captured value for each month when the data quality check was evaluated. | ColumnComparisonDistinctCountMatchCheckSpec | |||
reference_column |
The name of the reference column name in the reference table. It is the column to which the current column is compared to. | string | |||
custom_checks |
Dictionary of additional custom checks within this category. The keys are check names defined in the definition section. The sensor parameters and rules should match the type of the configured sensor and rule for the custom check. | CustomCategoryCheckSpecMap |