table_comparisons

Manages the configuration of table comparisons between tables on the same or different data sources

create_table_comparison_configuration

Creates a new table comparison configuration added to the compared table
Source code

POST

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/tablecomparisonconfigurations

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Request body

Description	Data type	Required
Table comparison configuration model	TableComparisonConfigurationModel

Usage examples

curl

curl -X POST http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/tablecomparisonconfigurations^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"table_comparison_configuration_name\":\"sample_schema.sample_table\",\"reference_connection\":\"sample_connection\",\"reference_table\":{\"schema_name\":\"sample_schema\",\"table_name\":\"sample_table\"},\"check_type\":\"profiling\",\"grouping_columns\":[],\"can_edit\":true,\"can_run_compare_checks\":true,\"can_delete_data\":true}"

create_table_comparison_monitoring_daily

Creates a table comparison configuration using daily monitoring checks
Source code

POST

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/tablecomparisons/monitoring/daily

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Request body

Description	Data type	Required
Table comparison configuration model with the selected checks to use for comparison	TableComparisonModel

Usage examples

curl

curl -X POST http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/tablecomparisons/monitoring/daily^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"table_comparison_configuration_name\":\"sample_table_comparison\",\"compared_connection\":\"unknown\",\"compared_table\":{\"schema_name\":\"sample_schema\",\"table_name\":\"sample_table\"},\"reference_connection\":\"sample_connection\",\"reference_table\":{\"schema_name\":\"sample_schema\",\"table_name\":\"sample_table\"},\"grouping_columns\":[],\"default_compare_thresholds\":{\"warning_difference_percent\":0.0,\"error_difference_percent\":1.0,\"fatal_difference_percent\":5.0},\"supports_compare_column_count\":true,\"columns\":[],\"compare_table_run_checks_job_template\":{\"connection\":\"unknown\",\"fullTableName\":\"sample_schema.sample_table\",\"enabled\":true,\"checkType\":\"monitoring\",\"timeScale\":\"daily\",\"checkCategory\":\"comparisons\",\"tableComparisonName\":\"sample_table_comparison\"},\"compare_table_clean_data_job_template\":{\"connection\":\"unknown\",\"fullTableName\":\"sample_schema.sample_table\",\"deleteErrors\":true,\"deleteStatistics\":true,\"deleteCheckResults\":true,\"deleteSensorReadouts\":true,\"checkCategory\":\"comparisons\",\"tableComparisonName\":\"sample_table_comparison\",\"checkType\":\"monitoring\",\"timeGradient\":\"day\"},\"can_edit\":true,\"can_run_compare_checks\":true,\"can_delete_data\":true}"

create_table_comparison_monitoring_monthly

Creates a table comparison configuration using monthly monitoring checks
Source code

POST

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/tablecomparisons/monitoring/monthly

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Request body

Description	Data type	Required
Table comparison configuration model with the selected checks to use for comparison	TableComparisonModel

Usage examples

curl

curl -X POST http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/tablecomparisons/monitoring/monthly^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"table_comparison_configuration_name\":\"sample_table_comparison\",\"compared_connection\":\"unknown\",\"compared_table\":{\"schema_name\":\"sample_schema\",\"table_name\":\"sample_table\"},\"reference_connection\":\"sample_connection\",\"reference_table\":{\"schema_name\":\"sample_schema\",\"table_name\":\"sample_table\"},\"grouping_columns\":[],\"default_compare_thresholds\":{\"warning_difference_percent\":0.0,\"error_difference_percent\":1.0,\"fatal_difference_percent\":5.0},\"supports_compare_column_count\":true,\"columns\":[],\"compare_table_run_checks_job_template\":{\"connection\":\"unknown\",\"fullTableName\":\"sample_schema.sample_table\",\"enabled\":true,\"checkType\":\"monitoring\",\"timeScale\":\"daily\",\"checkCategory\":\"comparisons\",\"tableComparisonName\":\"sample_table_comparison\"},\"compare_table_clean_data_job_template\":{\"connection\":\"unknown\",\"fullTableName\":\"sample_schema.sample_table\",\"deleteErrors\":true,\"deleteStatistics\":true,\"deleteCheckResults\":true,\"deleteSensorReadouts\":true,\"checkCategory\":\"comparisons\",\"tableComparisonName\":\"sample_table_comparison\",\"checkType\":\"monitoring\",\"timeGradient\":\"day\"},\"can_edit\":true,\"can_run_compare_checks\":true,\"can_delete_data\":true}"

create_table_comparison_partitioned_daily

Creates a table comparison configuration using daily partitioned checks
Source code

POST

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/tablecomparisons/partitioned/daily

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Request body

Description	Data type	Required
Table comparison configuration model with the selected checks to use for comparison	TableComparisonModel

Usage examples

curl

curl -X POST http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/tablecomparisons/partitioned/daily^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"table_comparison_configuration_name\":\"sample_table_comparison\",\"compared_connection\":\"unknown\",\"compared_table\":{\"schema_name\":\"sample_schema\",\"table_name\":\"sample_table\"},\"reference_connection\":\"sample_connection\",\"reference_table\":{\"schema_name\":\"sample_schema\",\"table_name\":\"sample_table\"},\"grouping_columns\":[],\"default_compare_thresholds\":{\"warning_difference_percent\":0.0,\"error_difference_percent\":1.0,\"fatal_difference_percent\":5.0},\"supports_compare_column_count\":true,\"columns\":[],\"compare_table_run_checks_job_template\":{\"connection\":\"unknown\",\"fullTableName\":\"sample_schema.sample_table\",\"enabled\":true,\"checkType\":\"monitoring\",\"timeScale\":\"daily\",\"checkCategory\":\"comparisons\",\"tableComparisonName\":\"sample_table_comparison\"},\"compare_table_clean_data_job_template\":{\"connection\":\"unknown\",\"fullTableName\":\"sample_schema.sample_table\",\"deleteErrors\":true,\"deleteStatistics\":true,\"deleteCheckResults\":true,\"deleteSensorReadouts\":true,\"checkCategory\":\"comparisons\",\"tableComparisonName\":\"sample_table_comparison\",\"checkType\":\"monitoring\",\"timeGradient\":\"day\"},\"can_edit\":true,\"can_run_compare_checks\":true,\"can_delete_data\":true}"

create_table_comparison_partitioned_monthly

Creates a table comparison configuration using monthly partitioned checks
Source code

POST

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/tablecomparisons/partitioned/monthly

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Request body

Description	Data type	Required
Table comparison configuration model with the selected checks to use for comparison	TableComparisonModel

Usage examples

curl

curl -X POST http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/tablecomparisons/partitioned/monthly^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"table_comparison_configuration_name\":\"sample_table_comparison\",\"compared_connection\":\"unknown\",\"compared_table\":{\"schema_name\":\"sample_schema\",\"table_name\":\"sample_table\"},\"reference_connection\":\"sample_connection\",\"reference_table\":{\"schema_name\":\"sample_schema\",\"table_name\":\"sample_table\"},\"grouping_columns\":[],\"default_compare_thresholds\":{\"warning_difference_percent\":0.0,\"error_difference_percent\":1.0,\"fatal_difference_percent\":5.0},\"supports_compare_column_count\":true,\"columns\":[],\"compare_table_run_checks_job_template\":{\"connection\":\"unknown\",\"fullTableName\":\"sample_schema.sample_table\",\"enabled\":true,\"checkType\":\"monitoring\",\"timeScale\":\"daily\",\"checkCategory\":\"comparisons\",\"tableComparisonName\":\"sample_table_comparison\"},\"compare_table_clean_data_job_template\":{\"connection\":\"unknown\",\"fullTableName\":\"sample_schema.sample_table\",\"deleteErrors\":true,\"deleteStatistics\":true,\"deleteCheckResults\":true,\"deleteSensorReadouts\":true,\"checkCategory\":\"comparisons\",\"tableComparisonName\":\"sample_table_comparison\",\"checkType\":\"monitoring\",\"timeGradient\":\"day\"},\"can_edit\":true,\"can_run_compare_checks\":true,\"can_delete_data\":true}"

create_table_comparison_profiling

Creates a table comparison configuration using profiling checks
Source code

POST

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/tablecomparisons/profiling

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Request body

Description	Data type	Required
Table comparison configuration model with the selected checks to use for comparison	TableComparisonModel

Usage examples

curl

curl -X POST http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/tablecomparisons/profiling^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"table_comparison_configuration_name\":\"sample_table_comparison\",\"compared_connection\":\"unknown\",\"compared_table\":{\"schema_name\":\"sample_schema\",\"table_name\":\"sample_table\"},\"reference_connection\":\"sample_connection\",\"reference_table\":{\"schema_name\":\"sample_schema\",\"table_name\":\"sample_table\"},\"grouping_columns\":[],\"default_compare_thresholds\":{\"warning_difference_percent\":0.0,\"error_difference_percent\":1.0,\"fatal_difference_percent\":5.0},\"supports_compare_column_count\":true,\"columns\":[],\"compare_table_run_checks_job_template\":{\"connection\":\"unknown\",\"fullTableName\":\"sample_schema.sample_table\",\"enabled\":true,\"checkType\":\"monitoring\",\"timeScale\":\"daily\",\"checkCategory\":\"comparisons\",\"tableComparisonName\":\"sample_table_comparison\"},\"compare_table_clean_data_job_template\":{\"connection\":\"unknown\",\"fullTableName\":\"sample_schema.sample_table\",\"deleteErrors\":true,\"deleteStatistics\":true,\"deleteCheckResults\":true,\"deleteSensorReadouts\":true,\"checkCategory\":\"comparisons\",\"tableComparisonName\":\"sample_table_comparison\",\"checkType\":\"monitoring\",\"timeGradient\":\"day\"},\"can_edit\":true,\"can_run_compare_checks\":true,\"can_delete_data\":true}"

delete_table_comparison_configuration

Deletes a table comparison configuration from a compared table
Source code

DELETE

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/tablecomparisonconfigurations/{tableComparisonConfigurationName}

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
table_comparison_configuration_name	Reference table configuration name	string

Usage examples

curl

curl -X DELETE http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/tablecomparisonconfigurations/sample_table_comparison^
    -H "Accept: application/json"

get_table_comparison_configuration

Returns a model of the table comparison configuration
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/tablecomparisonconfigurations/{tableComparisonConfigurationName}

Return value

Property name	Description	Data type
table_comparison_configuration_model		TableComparisonConfigurationModel

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
table_comparison_configuration_name	Reference table configuration name	string

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/tablecomparisonconfigurations/sample_table_comparison^
    -H "Accept: application/json"

get_table_comparison_configurations

Returns the list of table comparison configurations on a compared table
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/tablecomparisonconfigurations

Return value

Property name	Description	Data type
table_comparison_configuration_model		List[TableComparisonConfigurationModel]

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
check_type	Optional check type filter (profiling, monitoring, partitioned).	CheckType
check_time_scale	Optional time scale filter for table comparisons specific to the monitoring and partitioned checks (values: daily or monthly).	CheckTimeScale

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/tablecomparisonconfigurations^
    -H "Accept: application/json"

get_table_comparison_monitoring_daily

Returns a model of the table comparison using daily monitoring checks (comparison once a day)
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/tablecomparisons/{tableComparisonConfigurationName}/monitoring/daily

Return value

Property name	Description	Data type
table_comparison_model		TableComparisonModel

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
table_comparison_configuration_name	Table comparison configuration name	string

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/tablecomparisons/sample_table_comparison/monitoring/daily^
    -H "Accept: application/json"

get_table_comparison_monitoring_monthly

Returns a model of the table comparison using monthly monitoring checks (comparison once a month)
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/tablecomparisons/{tableComparisonConfigurationName}/monitoring/monthly

Return value

Property name	Description	Data type
table_comparison_model		TableComparisonModel

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
table_comparison_configuration_name	Table comparison configuration name	string

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/tablecomparisons/sample_table_comparison/monitoring/monthly^
    -H "Accept: application/json"

get_table_comparison_partitioned_daily

Returns a model of the table comparison using daily partition checks (comparing day to day)
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/tablecomparisons/{tableComparisonConfigurationName}/partitioned/daily

Return value

Property name	Description	Data type
table_comparison_model		TableComparisonModel

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
table_comparison_configuration_name	Table comparison configuration name	string

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/tablecomparisons/sample_table_comparison/partitioned/daily^
    -H "Accept: application/json"

get_table_comparison_partitioned_monthly

Returns a model of the table comparison using monthly partition checks (comparing month to month)
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/tablecomparisons/{tableComparisonConfigurationName}/partitioned/monthly

Return value

Property name	Description	Data type
table_comparison_model		TableComparisonModel

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
table_comparison_configuration_name	Table comparison configuration name	string

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/tablecomparisons/sample_table_comparison/partitioned/monthly^
    -H "Accept: application/json"

get_table_comparison_profiling

Returns a model of the table comparison using profiling checks (comparison at any time)
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/tablecomparisons/{tableComparisonConfigurationName}/profiling

Return value

Property name	Description	Data type
table_comparison_model		TableComparisonModel

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
table_comparison_configuration_name	Table comparison configuration name	string

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/tablecomparisons/sample_table_comparison/profiling^
    -H "Accept: application/json"

update_table_comparison_configuration

Updates a table configuration configuration
Source code

PUT

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/tablecomparisonconfigurations/{tableComparisonConfigurationName}

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
table_comparison_configuration_name	Table comparison configuration name	string

Request body

Description	Data type	Required
Table comparison model with the configuration of the tables to compare	TableComparisonConfigurationModel

Usage examples

curl

curl -X PUT http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/tablecomparisonconfigurations/sample_table_comparison^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"table_comparison_configuration_name\":\"sample_schema.sample_table\",\"reference_connection\":\"sample_connection\",\"reference_table\":{\"schema_name\":\"sample_schema\",\"table_name\":\"sample_table\"},\"check_type\":\"profiling\",\"grouping_columns\":[],\"can_edit\":true,\"can_run_compare_checks\":true,\"can_delete_data\":true}"

update_table_comparison_monitoring_daily

Updates a table comparison checks monitoring daily
Source code

PUT

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/tablecomparisons/monitoring/daily/{tableComparisonConfigurationName}

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
table_comparison_configuration_name	Table comparison configuration name	string

Request body

Description	Data type	Required
Table comparison configuration model with the selected checks to use for comparison	TableComparisonModel

Usage examples

curl

curl -X PUT http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/tablecomparisons/monitoring/daily/sample_table_comparison^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"table_comparison_configuration_name\":\"sample_table_comparison\",\"compared_connection\":\"unknown\",\"compared_table\":{\"schema_name\":\"sample_schema\",\"table_name\":\"sample_table\"},\"reference_connection\":\"sample_connection\",\"reference_table\":{\"schema_name\":\"sample_schema\",\"table_name\":\"sample_table\"},\"grouping_columns\":[],\"default_compare_thresholds\":{\"warning_difference_percent\":0.0,\"error_difference_percent\":1.0,\"fatal_difference_percent\":5.0},\"supports_compare_column_count\":true,\"columns\":[],\"compare_table_run_checks_job_template\":{\"connection\":\"unknown\",\"fullTableName\":\"sample_schema.sample_table\",\"enabled\":true,\"checkType\":\"monitoring\",\"timeScale\":\"daily\",\"checkCategory\":\"comparisons\",\"tableComparisonName\":\"sample_table_comparison\"},\"compare_table_clean_data_job_template\":{\"connection\":\"unknown\",\"fullTableName\":\"sample_schema.sample_table\",\"deleteErrors\":true,\"deleteStatistics\":true,\"deleteCheckResults\":true,\"deleteSensorReadouts\":true,\"checkCategory\":\"comparisons\",\"tableComparisonName\":\"sample_table_comparison\",\"checkType\":\"monitoring\",\"timeGradient\":\"day\"},\"can_edit\":true,\"can_run_compare_checks\":true,\"can_delete_data\":true}"

update_table_comparison_monitoring_monthly

Updates a table comparison checks monitoring monthly
Source code

PUT

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/tablecomparisons/monitoring/monthly/{tableComparisonConfigurationName}

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
table_comparison_configuration_name	Table comparison configuration name	string

Request body

Description	Data type	Required
Table comparison configuration model with the selected checks to use for comparison	TableComparisonModel

Usage examples

curl

curl -X PUT http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/tablecomparisons/monitoring/monthly/sample_table_comparison^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"table_comparison_configuration_name\":\"sample_table_comparison\",\"compared_connection\":\"unknown\",\"compared_table\":{\"schema_name\":\"sample_schema\",\"table_name\":\"sample_table\"},\"reference_connection\":\"sample_connection\",\"reference_table\":{\"schema_name\":\"sample_schema\",\"table_name\":\"sample_table\"},\"grouping_columns\":[],\"default_compare_thresholds\":{\"warning_difference_percent\":0.0,\"error_difference_percent\":1.0,\"fatal_difference_percent\":5.0},\"supports_compare_column_count\":true,\"columns\":[],\"compare_table_run_checks_job_template\":{\"connection\":\"unknown\",\"fullTableName\":\"sample_schema.sample_table\",\"enabled\":true,\"checkType\":\"monitoring\",\"timeScale\":\"daily\",\"checkCategory\":\"comparisons\",\"tableComparisonName\":\"sample_table_comparison\"},\"compare_table_clean_data_job_template\":{\"connection\":\"unknown\",\"fullTableName\":\"sample_schema.sample_table\",\"deleteErrors\":true,\"deleteStatistics\":true,\"deleteCheckResults\":true,\"deleteSensorReadouts\":true,\"checkCategory\":\"comparisons\",\"tableComparisonName\":\"sample_table_comparison\",\"checkType\":\"monitoring\",\"timeGradient\":\"day\"},\"can_edit\":true,\"can_run_compare_checks\":true,\"can_delete_data\":true}"

update_table_comparison_partitioned_daily

Updates a table comparison checks partitioned daily (comparing day to day)
Source code

PUT

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/tablecomparisons/partitioned/daily/{tableComparisonConfigurationName}

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
table_comparison_configuration_name	Table comparison configuration name	string

Request body

Description	Data type	Required
Table comparison configuration model with the selected checks to use for comparison	TableComparisonModel

Usage examples

curl

curl -X PUT http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/tablecomparisons/partitioned/daily/sample_table_comparison^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"table_comparison_configuration_name\":\"sample_table_comparison\",\"compared_connection\":\"unknown\",\"compared_table\":{\"schema_name\":\"sample_schema\",\"table_name\":\"sample_table\"},\"reference_connection\":\"sample_connection\",\"reference_table\":{\"schema_name\":\"sample_schema\",\"table_name\":\"sample_table\"},\"grouping_columns\":[],\"default_compare_thresholds\":{\"warning_difference_percent\":0.0,\"error_difference_percent\":1.0,\"fatal_difference_percent\":5.0},\"supports_compare_column_count\":true,\"columns\":[],\"compare_table_run_checks_job_template\":{\"connection\":\"unknown\",\"fullTableName\":\"sample_schema.sample_table\",\"enabled\":true,\"checkType\":\"monitoring\",\"timeScale\":\"daily\",\"checkCategory\":\"comparisons\",\"tableComparisonName\":\"sample_table_comparison\"},\"compare_table_clean_data_job_template\":{\"connection\":\"unknown\",\"fullTableName\":\"sample_schema.sample_table\",\"deleteErrors\":true,\"deleteStatistics\":true,\"deleteCheckResults\":true,\"deleteSensorReadouts\":true,\"checkCategory\":\"comparisons\",\"tableComparisonName\":\"sample_table_comparison\",\"checkType\":\"monitoring\",\"timeGradient\":\"day\"},\"can_edit\":true,\"can_run_compare_checks\":true,\"can_delete_data\":true}"

update_table_comparison_partitioned_monthly

Updates a table comparison checks partitioned monthly (comparing month to month)
Source code

PUT

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/tablecomparisons/partitioned/monthly/{tableComparisonConfigurationName}

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
table_comparison_configuration_name	Table comparison configuration name	string

Request body

Description	Data type	Required
Table comparison configuration model with the selected checks to use for comparison	TableComparisonModel

Usage examples

curl

curl -X PUT http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/tablecomparisons/partitioned/monthly/sample_table_comparison^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"table_comparison_configuration_name\":\"sample_table_comparison\",\"compared_connection\":\"unknown\",\"compared_table\":{\"schema_name\":\"sample_schema\",\"table_name\":\"sample_table\"},\"reference_connection\":\"sample_connection\",\"reference_table\":{\"schema_name\":\"sample_schema\",\"table_name\":\"sample_table\"},\"grouping_columns\":[],\"default_compare_thresholds\":{\"warning_difference_percent\":0.0,\"error_difference_percent\":1.0,\"fatal_difference_percent\":5.0},\"supports_compare_column_count\":true,\"columns\":[],\"compare_table_run_checks_job_template\":{\"connection\":\"unknown\",\"fullTableName\":\"sample_schema.sample_table\",\"enabled\":true,\"checkType\":\"monitoring\",\"timeScale\":\"daily\",\"checkCategory\":\"comparisons\",\"tableComparisonName\":\"sample_table_comparison\"},\"compare_table_clean_data_job_template\":{\"connection\":\"unknown\",\"fullTableName\":\"sample_schema.sample_table\",\"deleteErrors\":true,\"deleteStatistics\":true,\"deleteCheckResults\":true,\"deleteSensorReadouts\":true,\"checkCategory\":\"comparisons\",\"tableComparisonName\":\"sample_table_comparison\",\"checkType\":\"monitoring\",\"timeGradient\":\"day\"},\"can_edit\":true,\"can_run_compare_checks\":true,\"can_delete_data\":true}"

update_table_comparison_profiling

Updates a table comparison profiling checks
Source code

PUT

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/tablecomparisons/profiling/{tableComparisonConfigurationName}

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
table_comparison_configuration_name	Table comparison configuration name	string

Request body

Description	Data type	Required
Table comparison configuration model with the selected checks to use for comparison	TableComparisonModel

Usage examples

curl

curl -X PUT http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/tablecomparisons/profiling/sample_table_comparison^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"table_comparison_configuration_name\":\"sample_table_comparison\",\"compared_connection\":\"unknown\",\"compared_table\":{\"schema_name\":\"sample_schema\",\"table_name\":\"sample_table\"},\"reference_connection\":\"sample_connection\",\"reference_table\":{\"schema_name\":\"sample_schema\",\"table_name\":\"sample_table\"},\"grouping_columns\":[],\"default_compare_thresholds\":{\"warning_difference_percent\":0.0,\"error_difference_percent\":1.0,\"fatal_difference_percent\":5.0},\"supports_compare_column_count\":true,\"columns\":[],\"compare_table_run_checks_job_template\":{\"connection\":\"unknown\",\"fullTableName\":\"sample_schema.sample_table\",\"enabled\":true,\"checkType\":\"monitoring\",\"timeScale\":\"daily\",\"checkCategory\":\"comparisons\",\"tableComparisonName\":\"sample_table_comparison\"},\"compare_table_clean_data_job_template\":{\"connection\":\"unknown\",\"fullTableName\":\"sample_schema.sample_table\",\"deleteErrors\":true,\"deleteStatistics\":true,\"deleteCheckResults\":true,\"deleteSensorReadouts\":true,\"checkCategory\":\"comparisons\",\"tableComparisonName\":\"sample_table_comparison\",\"checkType\":\"monitoring\",\"timeGradient\":\"day\"},\"can_edit\":true,\"can_run_compare_checks\":true,\"can_delete_data\":true}"