table monthly monitoring checks

TableSqlMonthlyMonitoringChecksSpec

Container of built-in preconfigured data quality checks on a table level that are using custom SQL expressions (conditions).

The structure of this object is described below

Property name	Description	Data type
monthly_sql_condition_passed_percent_on_table	Verifies that a set percentage of rows passed a custom SQL condition (expression). Stores the most recent row count for each month when the data quality check was evaluated.	TableSqlConditionPassedPercentCheckSpec
monthly_sql_condition_failed_count_on_table	Verifies that a set number of rows failed a custom SQL condition (expression). Stores the most recent row count for each month when the data quality check was evaluated.	TableSqlConditionFailedCountCheckSpec
monthly_sql_aggregate_expr_table	Verifies that a custom aggregated SQL expression (MIN, MAX, etc.) is not outside the set range. Stores the most recent row count for each month when the data quality check was evaluated.	TableSqlAggregateExprCheckSpec
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

TableComparisonMonthlyMonitoringChecksSpec

Container of built-in comparison (accuracy) checks on a table level that are using a defined comparison to identify the reference table and the data grouping configuration. Contains the monthly monitoring comparison checks.

The structure of this object is described below

Property name	Description	Data type
monthly_row_count_match	Verifies that the row count of the tested (parent) table matches the row count of the reference table. Compares each group of data with a GROUP BY clause. Stores the most recent captured value for each month when the data quality check was evaluated.	TableComparisonRowCountMatchCheckSpec
monthly_column_count_match	Verifies that the column count of the tested (parent) table matches the column count of the reference table. Only one comparison result is returned, without data grouping. Stores the most recent captured value for each month when the data quality check was evaluated.	TableComparisonColumnCountMatchCheckSpec
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

TableSchemaMonthlyMonitoringChecksSpec

Container of built-in preconfigured volume data quality checks on a table level that are executed as a monthly monitoring (checkpoint) checks.

The structure of this object is described below

Property name	Description	Data type
monthly_column_count	Detects if the number of column matches an expected number. Retrieves the metadata of the monitored table, counts the number of columns and compares it to an expected value (an expected number of columns). Stores the most recent column count for each month when the data quality check was evaluated.	TableSchemaColumnCountCheckSpec
monthly_column_count_changed	Detects if the count of columns has changed since the last month. Retrieves the metadata of the monitored table, counts the number of columns and compares it the last known column count that was captured when this data quality check was executed the last time. Stores the most recent column count for each month when the data quality check was evaluated.	TableSchemaColumnCountChangedCheckSpec
monthly_column_list_changed	Detects if new columns were added or existing columns were removed since the last month. Retrieves the metadata of the monitored table and calculates an unordered hash of the column names. Compares the current hash to the previously known hash to detect any changes to the list of columns.	TableSchemaColumnListChangedCheckSpec
monthly_column_list_or_order_changed	Detects if new columns were added, existing columns were removed or the columns were reordered since the last month. Retrieves the metadata of the monitored table and calculates an ordered hash of the column names. Compares the current hash to the previously known hash to detect any changes to the list of columns or their order.	TableSchemaColumnListOrOrderChangedCheckSpec
monthly_column_types_changed	Detects if new columns were added, removed or their data types have changed since the last month. Retrieves the metadata of the monitored table and calculates an unordered hash of the column names and the data types (including the length, scale, precision, nullability). Compares the current hash to the previously known hash to detect any changes to the list of columns or their types.	TableSchemaColumnTypesChangedCheckSpec
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

TableAvailabilityMonthlyMonitoringChecksSpec

Container of built-in preconfigured data quality checks on a table level that are detecting the table availability.

The structure of this object is described below

Property name	Description	Data type	Enum values	Default value	Sample values
monthly_table_availability	Verifies availability on table in database using simple row count. Stores the most recent table availability status for each month when the data quality check was evaluated.	TableAvailabilityCheckSpec
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

TableComparisonMonthlyMonitoringChecksSpecMap

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 the monthly monitoring comparison checks for each configured reference table.

The structure of this object is described below

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

TableVolumeMonthlyMonitoringChecksSpec

Container of table level monthly monitoring for volume data quality checks

The structure of this object is described below

Property name	Description	Data type
monthly_row_count	Verifies that the tested table has at least a minimum accepted number of rows. The default configuration of the warning, error and fatal severity rules verifies a minimum row count of one row, which checks if the table is not empty. When the data grouping is configured, this check will count rows using a GROUP BY clause and verify that each data grouping has an expected minimum number of rows.Stores the most recent captured row count value for each month when the row count was evaluated.	TableRowCountCheckSpec
monthly_row_count_change	Verifies that the total row count of the tested table has changed by a fixed rate since the last month.	TableChangeRowCountCheckSpec
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

TableTimelinessMonthlyMonitoringChecksSpec

Container of table level monthly monitoring for timeliness data quality checks

The structure of this object is described below

Property name	Description	Data type
monthly_data_freshness	Monthly monitoring calculating the number of days since the most recent event timestamp (freshness)	TableDataFreshnessCheckSpec
monthly_data_staleness	Monthly monitoring calculating the time difference in days between the current date and the most recent data ingestion timestamp (staleness)	TableDataStalenessCheckSpec
monthly_data_ingestion_delay	Monthly monitoring calculating the time difference in days between the most recent event timestamp and the most recent ingestion timestamp	TableDataIngestionDelayCheckSpec
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

TableAccuracyMonthlyMonitoringChecksSpec

Container of built-in preconfigured data quality checks on a table level that are verifying the accuracy of the table, comparing it with another reference table, on a monthly basis.

The structure of this object is described below

Property name	Description	Data type	Enum values	Default value	Sample values
monthly_total_row_count_match_percent	Verifies the total row count of a tested table and compares it to a row count of a reference table. Stores the most recent row count for each month when the data quality check was evaluated.	TableAccuracyTotalRowCountMatchPercentCheckSpec
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

TableMonthlyMonitoringCheckCategoriesSpec

Container of table level monthly monitoring checks. Contains categories of monthly monitoring checks.

The structure of this object is described below

Property name	Description	Data type
volume	Monthly monitoring of volume data quality checks	TableVolumeMonthlyMonitoringChecksSpec
timeliness	Monthly monitoring of timeliness checks	TableTimelinessMonthlyMonitoringChecksSpec
accuracy	Monthly monitoring accuracy checks	TableAccuracyMonthlyMonitoringChecksSpec
sql	Monthly monitoring of custom SQL checks	TableSqlMonthlyMonitoringChecksSpec
availability	Daily partitioned availability checks	TableAvailabilityMonthlyMonitoringChecksSpec
schema	Monthly monitoring table schema checks	TableSchemaMonthlyMonitoringChecksSpec
comparisons	Dictionary of configuration of checks for table comparisons. The key that identifies each comparison must match the name of a data comparison that is configured on the parent table.	TableComparisonMonthlyMonitoringChecksSpecMap
custom	Dictionary of custom checks. The keys are check names within this category.	CustomCheckSpecMap