Last updated: July 22, 2025
DQOps REST API table_comparisons operations
Operations for managing the configurations 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
Follow the link to see the source code on GitHub.
POST
http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/tablecomparisonconfigurations
Parameters of this method are described below
| Property name | Description | Data type | Required |
|---|---|---|---|
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
Execution
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}"
Execution
from dqops import client
from dqops.client.api.table_comparisons import create_table_comparison_configuration
from dqops.client.models import CheckType, \
PhysicalTableName, \
TableComparisonConfigurationModel, \
TableComparisonGroupingColumnPairModel
dqops_client = client.Client(
'http://localhost:8888/'
)
request_body = TableComparisonConfigurationModel(
table_comparison_configuration_name='sample_schema.sample_table',
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
check_type=CheckType.PROFILING,
grouping_columns=[
],
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = create_table_comparison_configuration.sync(
'sample_connection',
'sample_schema',
'sample_table',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import create_table_comparison_configuration
from dqops.client.models import CheckType, \
PhysicalTableName, \
TableComparisonConfigurationModel, \
TableComparisonGroupingColumnPairModel
dqops_client = client.Client(
'http://localhost:8888/'
)
request_body = TableComparisonConfigurationModel(
table_comparison_configuration_name='sample_schema.sample_table',
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
check_type=CheckType.PROFILING,
grouping_columns=[
],
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = await create_table_comparison_configuration.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import create_table_comparison_configuration
from dqops.client.models import CheckType, \
PhysicalTableName, \
TableComparisonConfigurationModel, \
TableComparisonGroupingColumnPairModel
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token
)
request_body = TableComparisonConfigurationModel(
table_comparison_configuration_name='sample_schema.sample_table',
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
check_type=CheckType.PROFILING,
grouping_columns=[
],
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = create_table_comparison_configuration.sync(
'sample_connection',
'sample_schema',
'sample_table',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import create_table_comparison_configuration
from dqops.client.models import CheckType, \
PhysicalTableName, \
TableComparisonConfigurationModel, \
TableComparisonGroupingColumnPairModel
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token
)
request_body = TableComparisonConfigurationModel(
table_comparison_configuration_name='sample_schema.sample_table',
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
check_type=CheckType.PROFILING,
grouping_columns=[
],
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = await create_table_comparison_configuration.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
client=dqops_client,
json_body=request_body
)
create_table_comparison_monitoring_daily
Creates a table comparison configuration using daily monitoring checks
Follow the link to see the source code on GitHub.
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 | Required |
|---|---|---|---|
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
Execution
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\":{\"error_difference_percent\":1.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\":false,\"deleteCheckResults\":true,\"deleteSensorReadouts\":true,\"deleteErrorSamples\":true,\"deleteIncidents\":false,\"deleteChecksConfiguration\":false,\"checkCategory\":\"comparisons\",\"tableComparisonName\":\"sample_table_comparison\",\"checkType\":\"monitoring\",\"timeGradient\":\"day\"},\"can_edit\":true,\"can_run_compare_checks\":true,\"can_delete_data\":true}"
Execution
from dqops import client
from dqops.client.api.table_comparisons import create_table_comparison_monitoring_daily
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
dqops_client = client.Client(
'http://localhost:8888/'
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = create_table_comparison_monitoring_daily.sync(
'sample_connection',
'sample_schema',
'sample_table',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import create_table_comparison_monitoring_daily
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
dqops_client = client.Client(
'http://localhost:8888/'
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = await create_table_comparison_monitoring_daily.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import create_table_comparison_monitoring_daily
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = create_table_comparison_monitoring_daily.sync(
'sample_connection',
'sample_schema',
'sample_table',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import create_table_comparison_monitoring_daily
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = await create_table_comparison_monitoring_daily.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
client=dqops_client,
json_body=request_body
)
create_table_comparison_monitoring_monthly
Creates a table comparison configuration using monthly monitoring checks
Follow the link to see the source code on GitHub.
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 | Required |
|---|---|---|---|
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
Execution
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\":{\"error_difference_percent\":1.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\":false,\"deleteCheckResults\":true,\"deleteSensorReadouts\":true,\"deleteErrorSamples\":true,\"deleteIncidents\":false,\"deleteChecksConfiguration\":false,\"checkCategory\":\"comparisons\",\"tableComparisonName\":\"sample_table_comparison\",\"checkType\":\"monitoring\",\"timeGradient\":\"day\"},\"can_edit\":true,\"can_run_compare_checks\":true,\"can_delete_data\":true}"
Execution
from dqops import client
from dqops.client.api.table_comparisons import create_table_comparison_monitoring_monthly
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
dqops_client = client.Client(
'http://localhost:8888/'
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = create_table_comparison_monitoring_monthly.sync(
'sample_connection',
'sample_schema',
'sample_table',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import create_table_comparison_monitoring_monthly
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
dqops_client = client.Client(
'http://localhost:8888/'
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = await create_table_comparison_monitoring_monthly.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import create_table_comparison_monitoring_monthly
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = create_table_comparison_monitoring_monthly.sync(
'sample_connection',
'sample_schema',
'sample_table',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import create_table_comparison_monitoring_monthly
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = await create_table_comparison_monitoring_monthly.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
client=dqops_client,
json_body=request_body
)
create_table_comparison_partitioned_daily
Creates a table comparison configuration using daily partitioned checks
Follow the link to see the source code on GitHub.
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 | Required |
|---|---|---|---|
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
Execution
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\":{\"error_difference_percent\":1.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\":false,\"deleteCheckResults\":true,\"deleteSensorReadouts\":true,\"deleteErrorSamples\":true,\"deleteIncidents\":false,\"deleteChecksConfiguration\":false,\"checkCategory\":\"comparisons\",\"tableComparisonName\":\"sample_table_comparison\",\"checkType\":\"monitoring\",\"timeGradient\":\"day\"},\"can_edit\":true,\"can_run_compare_checks\":true,\"can_delete_data\":true}"
Execution
from dqops import client
from dqops.client.api.table_comparisons import create_table_comparison_partitioned_daily
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
dqops_client = client.Client(
'http://localhost:8888/'
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = create_table_comparison_partitioned_daily.sync(
'sample_connection',
'sample_schema',
'sample_table',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import create_table_comparison_partitioned_daily
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
dqops_client = client.Client(
'http://localhost:8888/'
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = await create_table_comparison_partitioned_daily.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import create_table_comparison_partitioned_daily
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = create_table_comparison_partitioned_daily.sync(
'sample_connection',
'sample_schema',
'sample_table',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import create_table_comparison_partitioned_daily
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = await create_table_comparison_partitioned_daily.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
client=dqops_client,
json_body=request_body
)
create_table_comparison_partitioned_monthly
Creates a table comparison configuration using monthly partitioned checks
Follow the link to see the source code on GitHub.
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 | Required |
|---|---|---|---|
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
Execution
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\":{\"error_difference_percent\":1.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\":false,\"deleteCheckResults\":true,\"deleteSensorReadouts\":true,\"deleteErrorSamples\":true,\"deleteIncidents\":false,\"deleteChecksConfiguration\":false,\"checkCategory\":\"comparisons\",\"tableComparisonName\":\"sample_table_comparison\",\"checkType\":\"monitoring\",\"timeGradient\":\"day\"},\"can_edit\":true,\"can_run_compare_checks\":true,\"can_delete_data\":true}"
Execution
from dqops import client
from dqops.client.api.table_comparisons import create_table_comparison_partitioned_monthly
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
dqops_client = client.Client(
'http://localhost:8888/'
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = create_table_comparison_partitioned_monthly.sync(
'sample_connection',
'sample_schema',
'sample_table',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import create_table_comparison_partitioned_monthly
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
dqops_client = client.Client(
'http://localhost:8888/'
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = await create_table_comparison_partitioned_monthly.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import create_table_comparison_partitioned_monthly
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = create_table_comparison_partitioned_monthly.sync(
'sample_connection',
'sample_schema',
'sample_table',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import create_table_comparison_partitioned_monthly
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = await create_table_comparison_partitioned_monthly.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
client=dqops_client,
json_body=request_body
)
create_table_comparison_profiling
Creates a table comparison configuration using profiling checks
Follow the link to see the source code on GitHub.
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 | Required |
|---|---|---|---|
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
Execution
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\":{\"error_difference_percent\":1.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\":false,\"deleteCheckResults\":true,\"deleteSensorReadouts\":true,\"deleteErrorSamples\":true,\"deleteIncidents\":false,\"deleteChecksConfiguration\":false,\"checkCategory\":\"comparisons\",\"tableComparisonName\":\"sample_table_comparison\",\"checkType\":\"monitoring\",\"timeGradient\":\"day\"},\"can_edit\":true,\"can_run_compare_checks\":true,\"can_delete_data\":true}"
Execution
from dqops import client
from dqops.client.api.table_comparisons import create_table_comparison_profiling
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
dqops_client = client.Client(
'http://localhost:8888/'
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = create_table_comparison_profiling.sync(
'sample_connection',
'sample_schema',
'sample_table',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import create_table_comparison_profiling
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
dqops_client = client.Client(
'http://localhost:8888/'
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = await create_table_comparison_profiling.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import create_table_comparison_profiling
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = create_table_comparison_profiling.sync(
'sample_connection',
'sample_schema',
'sample_table',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import create_table_comparison_profiling
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = await create_table_comparison_profiling.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
client=dqops_client,
json_body=request_body
)
delete_table_comparison_configuration
Deletes a table comparison configuration from a compared table
Follow the link to see the source code on GitHub.
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 | Required |
|---|---|---|---|
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
Execution
Execution
from dqops import client
from dqops.client.api.table_comparisons import delete_table_comparison_configuration
dqops_client = client.Client(
'http://localhost:8888/'
)
call_result = delete_table_comparison_configuration.sync(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import delete_table_comparison_configuration
dqops_client = client.Client(
'http://localhost:8888/'
)
call_result = await delete_table_comparison_configuration.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import delete_table_comparison_configuration
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token
)
call_result = delete_table_comparison_configuration.sync(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import delete_table_comparison_configuration
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token
)
call_result = await delete_table_comparison_configuration.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client
)
get_table_comparison_configuration
Returns a model of the table comparison configuration
Follow the link to see the source code on GitHub.
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 | Required |
|---|---|---|---|
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
Execution
curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/tablecomparisonconfigurations/sample_table_comparison^
-H "Accept: application/json"
Expand to see the returned result
{
"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
}
Execution
from dqops import client
from dqops.client.api.table_comparisons import get_table_comparison_configuration
dqops_client = client.Client(
'http://localhost:8888/',
raise_on_unexpected_status=True
)
call_result = get_table_comparison_configuration.sync(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client
)
Expand to see the returned result
TableComparisonConfigurationModel(
table_comparison_configuration_name='sample_schema.sample_table',
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
check_type=CheckType.PROFILING,
grouping_columns=[
],
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import get_table_comparison_configuration
dqops_client = client.Client(
'http://localhost:8888/',
raise_on_unexpected_status=True
)
call_result = await get_table_comparison_configuration.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client
)
Expand to see the returned result
TableComparisonConfigurationModel(
table_comparison_configuration_name='sample_schema.sample_table',
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
check_type=CheckType.PROFILING,
grouping_columns=[
],
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import get_table_comparison_configuration
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token,
raise_on_unexpected_status=True
)
call_result = get_table_comparison_configuration.sync(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client
)
Expand to see the returned result
TableComparisonConfigurationModel(
table_comparison_configuration_name='sample_schema.sample_table',
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
check_type=CheckType.PROFILING,
grouping_columns=[
],
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import get_table_comparison_configuration
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token,
raise_on_unexpected_status=True
)
call_result = await get_table_comparison_configuration.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client
)
Expand to see the returned result
TableComparisonConfigurationModel(
table_comparison_configuration_name='sample_schema.sample_table',
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
check_type=CheckType.PROFILING,
grouping_columns=[
],
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
get_table_comparison_configurations
Returns the list of table comparison configurations on a compared table
Follow the link to see the source code on GitHub.
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 | Required |
|---|---|---|---|
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
Execution
curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/tablecomparisonconfigurations^
-H "Accept: application/json"
Expand to see the returned result
[ {
"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
}, {
"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
}, {
"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
} ]
Execution
from dqops import client
from dqops.client.api.table_comparisons import get_table_comparison_configurations
from dqops.client.models import CheckTimeScale, \
CheckType
dqops_client = client.Client(
'http://localhost:8888/',
raise_on_unexpected_status=True
)
call_result = get_table_comparison_configurations.sync(
'sample_connection',
'sample_schema',
'sample_table',
client=dqops_client
)
Expand to see the returned result
[
TableComparisonConfigurationModel(
table_comparison_configuration_name='sample_schema.sample_table',
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
check_type=CheckType.PROFILING,
grouping_columns=[
],
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
),
TableComparisonConfigurationModel(
table_comparison_configuration_name='sample_schema.sample_table',
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
check_type=CheckType.PROFILING,
grouping_columns=[
],
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
),
TableComparisonConfigurationModel(
table_comparison_configuration_name='sample_schema.sample_table',
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
check_type=CheckType.PROFILING,
grouping_columns=[
],
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
]
Execution
from dqops import client
from dqops.client.api.table_comparisons import get_table_comparison_configurations
from dqops.client.models import CheckTimeScale, \
CheckType
dqops_client = client.Client(
'http://localhost:8888/',
raise_on_unexpected_status=True
)
call_result = await get_table_comparison_configurations.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
client=dqops_client
)
Expand to see the returned result
[
TableComparisonConfigurationModel(
table_comparison_configuration_name='sample_schema.sample_table',
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
check_type=CheckType.PROFILING,
grouping_columns=[
],
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
),
TableComparisonConfigurationModel(
table_comparison_configuration_name='sample_schema.sample_table',
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
check_type=CheckType.PROFILING,
grouping_columns=[
],
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
),
TableComparisonConfigurationModel(
table_comparison_configuration_name='sample_schema.sample_table',
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
check_type=CheckType.PROFILING,
grouping_columns=[
],
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
]
Execution
from dqops import client
from dqops.client.api.table_comparisons import get_table_comparison_configurations
from dqops.client.models import CheckTimeScale, \
CheckType
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token,
raise_on_unexpected_status=True
)
call_result = get_table_comparison_configurations.sync(
'sample_connection',
'sample_schema',
'sample_table',
client=dqops_client
)
Expand to see the returned result
[
TableComparisonConfigurationModel(
table_comparison_configuration_name='sample_schema.sample_table',
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
check_type=CheckType.PROFILING,
grouping_columns=[
],
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
),
TableComparisonConfigurationModel(
table_comparison_configuration_name='sample_schema.sample_table',
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
check_type=CheckType.PROFILING,
grouping_columns=[
],
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
),
TableComparisonConfigurationModel(
table_comparison_configuration_name='sample_schema.sample_table',
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
check_type=CheckType.PROFILING,
grouping_columns=[
],
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
]
Execution
from dqops import client
from dqops.client.api.table_comparisons import get_table_comparison_configurations
from dqops.client.models import CheckTimeScale, \
CheckType
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token,
raise_on_unexpected_status=True
)
call_result = await get_table_comparison_configurations.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
client=dqops_client
)
Expand to see the returned result
[
TableComparisonConfigurationModel(
table_comparison_configuration_name='sample_schema.sample_table',
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
check_type=CheckType.PROFILING,
grouping_columns=[
],
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
),
TableComparisonConfigurationModel(
table_comparison_configuration_name='sample_schema.sample_table',
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
check_type=CheckType.PROFILING,
grouping_columns=[
],
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
),
TableComparisonConfigurationModel(
table_comparison_configuration_name='sample_schema.sample_table',
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
check_type=CheckType.PROFILING,
grouping_columns=[
],
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
]
get_table_comparison_monitoring_daily
Returns a model of the table comparison using daily monitoring checks (comparison once a day)
Follow the link to see the source code on GitHub.
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 | Required |
|---|---|---|---|
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
Execution
curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/tablecomparisons/sample_table_comparison/monitoring/daily^
-H "Accept: application/json"
Expand to see the returned result
{
"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" : {
"error_difference_percent" : 1.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" : false,
"deleteCheckResults" : true,
"deleteSensorReadouts" : true,
"deleteErrorSamples" : true,
"deleteIncidents" : false,
"deleteChecksConfiguration" : false,
"checkCategory" : "comparisons",
"tableComparisonName" : "sample_table_comparison",
"checkType" : "monitoring",
"timeGradient" : "day"
},
"can_edit" : true,
"can_run_compare_checks" : true,
"can_delete_data" : true
}
Execution
from dqops import client
from dqops.client.api.table_comparisons import get_table_comparison_monitoring_daily
dqops_client = client.Client(
'http://localhost:8888/',
raise_on_unexpected_status=True
)
call_result = get_table_comparison_monitoring_daily.sync(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client
)
Expand to see the returned result
TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import get_table_comparison_monitoring_daily
dqops_client = client.Client(
'http://localhost:8888/',
raise_on_unexpected_status=True
)
call_result = await get_table_comparison_monitoring_daily.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client
)
Expand to see the returned result
TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import get_table_comparison_monitoring_daily
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token,
raise_on_unexpected_status=True
)
call_result = get_table_comparison_monitoring_daily.sync(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client
)
Expand to see the returned result
TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import get_table_comparison_monitoring_daily
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token,
raise_on_unexpected_status=True
)
call_result = await get_table_comparison_monitoring_daily.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client
)
Expand to see the returned result
TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
get_table_comparison_monitoring_monthly
Returns a model of the table comparison using monthly monitoring checks (comparison once a month)
Follow the link to see the source code on GitHub.
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 | Required |
|---|---|---|---|
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
Execution
curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/tablecomparisons/sample_table_comparison/monitoring/monthly^
-H "Accept: application/json"
Expand to see the returned result
{
"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" : {
"error_difference_percent" : 1.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" : false,
"deleteCheckResults" : true,
"deleteSensorReadouts" : true,
"deleteErrorSamples" : true,
"deleteIncidents" : false,
"deleteChecksConfiguration" : false,
"checkCategory" : "comparisons",
"tableComparisonName" : "sample_table_comparison",
"checkType" : "monitoring",
"timeGradient" : "day"
},
"can_edit" : true,
"can_run_compare_checks" : true,
"can_delete_data" : true
}
Execution
from dqops import client
from dqops.client.api.table_comparisons import get_table_comparison_monitoring_monthly
dqops_client = client.Client(
'http://localhost:8888/',
raise_on_unexpected_status=True
)
call_result = get_table_comparison_monitoring_monthly.sync(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client
)
Expand to see the returned result
TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import get_table_comparison_monitoring_monthly
dqops_client = client.Client(
'http://localhost:8888/',
raise_on_unexpected_status=True
)
call_result = await get_table_comparison_monitoring_monthly.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client
)
Expand to see the returned result
TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import get_table_comparison_monitoring_monthly
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token,
raise_on_unexpected_status=True
)
call_result = get_table_comparison_monitoring_monthly.sync(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client
)
Expand to see the returned result
TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import get_table_comparison_monitoring_monthly
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token,
raise_on_unexpected_status=True
)
call_result = await get_table_comparison_monitoring_monthly.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client
)
Expand to see the returned result
TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
get_table_comparison_partitioned_daily
Returns a model of the table comparison using daily partition checks (comparing day to day)
Follow the link to see the source code on GitHub.
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 | Required |
|---|---|---|---|
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
Execution
curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/tablecomparisons/sample_table_comparison/partitioned/daily^
-H "Accept: application/json"
Expand to see the returned result
{
"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" : {
"error_difference_percent" : 1.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" : false,
"deleteCheckResults" : true,
"deleteSensorReadouts" : true,
"deleteErrorSamples" : true,
"deleteIncidents" : false,
"deleteChecksConfiguration" : false,
"checkCategory" : "comparisons",
"tableComparisonName" : "sample_table_comparison",
"checkType" : "monitoring",
"timeGradient" : "day"
},
"can_edit" : true,
"can_run_compare_checks" : true,
"can_delete_data" : true
}
Execution
from dqops import client
from dqops.client.api.table_comparisons import get_table_comparison_partitioned_daily
dqops_client = client.Client(
'http://localhost:8888/',
raise_on_unexpected_status=True
)
call_result = get_table_comparison_partitioned_daily.sync(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client
)
Expand to see the returned result
TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import get_table_comparison_partitioned_daily
dqops_client = client.Client(
'http://localhost:8888/',
raise_on_unexpected_status=True
)
call_result = await get_table_comparison_partitioned_daily.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client
)
Expand to see the returned result
TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import get_table_comparison_partitioned_daily
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token,
raise_on_unexpected_status=True
)
call_result = get_table_comparison_partitioned_daily.sync(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client
)
Expand to see the returned result
TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import get_table_comparison_partitioned_daily
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token,
raise_on_unexpected_status=True
)
call_result = await get_table_comparison_partitioned_daily.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client
)
Expand to see the returned result
TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
get_table_comparison_partitioned_monthly
Returns a model of the table comparison using monthly partition checks (comparing month to month)
Follow the link to see the source code on GitHub.
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 | Required |
|---|---|---|---|
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
Execution
curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/tablecomparisons/sample_table_comparison/partitioned/monthly^
-H "Accept: application/json"
Expand to see the returned result
{
"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" : {
"error_difference_percent" : 1.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" : false,
"deleteCheckResults" : true,
"deleteSensorReadouts" : true,
"deleteErrorSamples" : true,
"deleteIncidents" : false,
"deleteChecksConfiguration" : false,
"checkCategory" : "comparisons",
"tableComparisonName" : "sample_table_comparison",
"checkType" : "monitoring",
"timeGradient" : "day"
},
"can_edit" : true,
"can_run_compare_checks" : true,
"can_delete_data" : true
}
Execution
from dqops import client
from dqops.client.api.table_comparisons import get_table_comparison_partitioned_monthly
dqops_client = client.Client(
'http://localhost:8888/',
raise_on_unexpected_status=True
)
call_result = get_table_comparison_partitioned_monthly.sync(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client
)
Expand to see the returned result
TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import get_table_comparison_partitioned_monthly
dqops_client = client.Client(
'http://localhost:8888/',
raise_on_unexpected_status=True
)
call_result = await get_table_comparison_partitioned_monthly.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client
)
Expand to see the returned result
TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import get_table_comparison_partitioned_monthly
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token,
raise_on_unexpected_status=True
)
call_result = get_table_comparison_partitioned_monthly.sync(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client
)
Expand to see the returned result
TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import get_table_comparison_partitioned_monthly
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token,
raise_on_unexpected_status=True
)
call_result = await get_table_comparison_partitioned_monthly.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client
)
Expand to see the returned result
TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
get_table_comparison_profiling
Returns a model of the table comparison using profiling checks (comparison at any time)
Follow the link to see the source code on GitHub.
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 | Required |
|---|---|---|---|
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
Execution
curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/tablecomparisons/sample_table_comparison/profiling^
-H "Accept: application/json"
Expand to see the returned result
{
"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" : {
"error_difference_percent" : 1.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" : false,
"deleteCheckResults" : true,
"deleteSensorReadouts" : true,
"deleteErrorSamples" : true,
"deleteIncidents" : false,
"deleteChecksConfiguration" : false,
"checkCategory" : "comparisons",
"tableComparisonName" : "sample_table_comparison",
"checkType" : "monitoring",
"timeGradient" : "day"
},
"can_edit" : true,
"can_run_compare_checks" : true,
"can_delete_data" : true
}
Execution
from dqops import client
from dqops.client.api.table_comparisons import get_table_comparison_profiling
dqops_client = client.Client(
'http://localhost:8888/',
raise_on_unexpected_status=True
)
call_result = get_table_comparison_profiling.sync(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client
)
Expand to see the returned result
TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import get_table_comparison_profiling
dqops_client = client.Client(
'http://localhost:8888/',
raise_on_unexpected_status=True
)
call_result = await get_table_comparison_profiling.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client
)
Expand to see the returned result
TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import get_table_comparison_profiling
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token,
raise_on_unexpected_status=True
)
call_result = get_table_comparison_profiling.sync(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client
)
Expand to see the returned result
TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import get_table_comparison_profiling
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token,
raise_on_unexpected_status=True
)
call_result = await get_table_comparison_profiling.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client
)
Expand to see the returned result
TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
update_table_comparison_configuration
Updates a table configuration configuration
Follow the link to see the source code on GitHub.
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 | Required |
|---|---|---|---|
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
Execution
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}"
Execution
from dqops import client
from dqops.client.api.table_comparisons import update_table_comparison_configuration
from dqops.client.models import CheckType, \
PhysicalTableName, \
TableComparisonConfigurationModel, \
TableComparisonGroupingColumnPairModel
dqops_client = client.Client(
'http://localhost:8888/'
)
request_body = TableComparisonConfigurationModel(
table_comparison_configuration_name='sample_schema.sample_table',
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
check_type=CheckType.PROFILING,
grouping_columns=[
],
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = update_table_comparison_configuration.sync(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import update_table_comparison_configuration
from dqops.client.models import CheckType, \
PhysicalTableName, \
TableComparisonConfigurationModel, \
TableComparisonGroupingColumnPairModel
dqops_client = client.Client(
'http://localhost:8888/'
)
request_body = TableComparisonConfigurationModel(
table_comparison_configuration_name='sample_schema.sample_table',
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
check_type=CheckType.PROFILING,
grouping_columns=[
],
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = await update_table_comparison_configuration.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import update_table_comparison_configuration
from dqops.client.models import CheckType, \
PhysicalTableName, \
TableComparisonConfigurationModel, \
TableComparisonGroupingColumnPairModel
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token
)
request_body = TableComparisonConfigurationModel(
table_comparison_configuration_name='sample_schema.sample_table',
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
check_type=CheckType.PROFILING,
grouping_columns=[
],
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = update_table_comparison_configuration.sync(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import update_table_comparison_configuration
from dqops.client.models import CheckType, \
PhysicalTableName, \
TableComparisonConfigurationModel, \
TableComparisonGroupingColumnPairModel
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token
)
request_body = TableComparisonConfigurationModel(
table_comparison_configuration_name='sample_schema.sample_table',
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
check_type=CheckType.PROFILING,
grouping_columns=[
],
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = await update_table_comparison_configuration.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client,
json_body=request_body
)
update_table_comparison_monitoring_daily
Updates a table comparison checks monitoring daily
Follow the link to see the source code on GitHub.
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 | Required |
|---|---|---|---|
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
Execution
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\":{\"error_difference_percent\":1.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\":false,\"deleteCheckResults\":true,\"deleteSensorReadouts\":true,\"deleteErrorSamples\":true,\"deleteIncidents\":false,\"deleteChecksConfiguration\":false,\"checkCategory\":\"comparisons\",\"tableComparisonName\":\"sample_table_comparison\",\"checkType\":\"monitoring\",\"timeGradient\":\"day\"},\"can_edit\":true,\"can_run_compare_checks\":true,\"can_delete_data\":true}"
Execution
from dqops import client
from dqops.client.api.table_comparisons import update_table_comparison_monitoring_daily
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
dqops_client = client.Client(
'http://localhost:8888/'
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = update_table_comparison_monitoring_daily.sync(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import update_table_comparison_monitoring_daily
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
dqops_client = client.Client(
'http://localhost:8888/'
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = await update_table_comparison_monitoring_daily.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import update_table_comparison_monitoring_daily
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = update_table_comparison_monitoring_daily.sync(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import update_table_comparison_monitoring_daily
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = await update_table_comparison_monitoring_daily.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client,
json_body=request_body
)
update_table_comparison_monitoring_monthly
Updates a table comparison checks monitoring monthly
Follow the link to see the source code on GitHub.
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 | Required |
|---|---|---|---|
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
Execution
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\":{\"error_difference_percent\":1.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\":false,\"deleteCheckResults\":true,\"deleteSensorReadouts\":true,\"deleteErrorSamples\":true,\"deleteIncidents\":false,\"deleteChecksConfiguration\":false,\"checkCategory\":\"comparisons\",\"tableComparisonName\":\"sample_table_comparison\",\"checkType\":\"monitoring\",\"timeGradient\":\"day\"},\"can_edit\":true,\"can_run_compare_checks\":true,\"can_delete_data\":true}"
Execution
from dqops import client
from dqops.client.api.table_comparisons import update_table_comparison_monitoring_monthly
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
dqops_client = client.Client(
'http://localhost:8888/'
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = update_table_comparison_monitoring_monthly.sync(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import update_table_comparison_monitoring_monthly
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
dqops_client = client.Client(
'http://localhost:8888/'
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = await update_table_comparison_monitoring_monthly.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import update_table_comparison_monitoring_monthly
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = update_table_comparison_monitoring_monthly.sync(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import update_table_comparison_monitoring_monthly
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = await update_table_comparison_monitoring_monthly.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client,
json_body=request_body
)
update_table_comparison_partitioned_daily
Updates a table comparison checks partitioned daily (comparing day to day)
Follow the link to see the source code on GitHub.
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 | Required |
|---|---|---|---|
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
Execution
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\":{\"error_difference_percent\":1.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\":false,\"deleteCheckResults\":true,\"deleteSensorReadouts\":true,\"deleteErrorSamples\":true,\"deleteIncidents\":false,\"deleteChecksConfiguration\":false,\"checkCategory\":\"comparisons\",\"tableComparisonName\":\"sample_table_comparison\",\"checkType\":\"monitoring\",\"timeGradient\":\"day\"},\"can_edit\":true,\"can_run_compare_checks\":true,\"can_delete_data\":true}"
Execution
from dqops import client
from dqops.client.api.table_comparisons import update_table_comparison_partitioned_daily
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
dqops_client = client.Client(
'http://localhost:8888/'
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = update_table_comparison_partitioned_daily.sync(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import update_table_comparison_partitioned_daily
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
dqops_client = client.Client(
'http://localhost:8888/'
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = await update_table_comparison_partitioned_daily.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import update_table_comparison_partitioned_daily
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = update_table_comparison_partitioned_daily.sync(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import update_table_comparison_partitioned_daily
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = await update_table_comparison_partitioned_daily.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client,
json_body=request_body
)
update_table_comparison_partitioned_monthly
Updates a table comparison checks partitioned monthly (comparing month to month)
Follow the link to see the source code on GitHub.
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 | Required |
|---|---|---|---|
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
Execution
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\":{\"error_difference_percent\":1.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\":false,\"deleteCheckResults\":true,\"deleteSensorReadouts\":true,\"deleteErrorSamples\":true,\"deleteIncidents\":false,\"deleteChecksConfiguration\":false,\"checkCategory\":\"comparisons\",\"tableComparisonName\":\"sample_table_comparison\",\"checkType\":\"monitoring\",\"timeGradient\":\"day\"},\"can_edit\":true,\"can_run_compare_checks\":true,\"can_delete_data\":true}"
Execution
from dqops import client
from dqops.client.api.table_comparisons import update_table_comparison_partitioned_monthly
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
dqops_client = client.Client(
'http://localhost:8888/'
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = update_table_comparison_partitioned_monthly.sync(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import update_table_comparison_partitioned_monthly
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
dqops_client = client.Client(
'http://localhost:8888/'
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = await update_table_comparison_partitioned_monthly.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import update_table_comparison_partitioned_monthly
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = update_table_comparison_partitioned_monthly.sync(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import update_table_comparison_partitioned_monthly
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = await update_table_comparison_partitioned_monthly.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client,
json_body=request_body
)
update_table_comparison_profiling
Updates a table comparison profiling checks
Follow the link to see the source code on GitHub.
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 | Required |
|---|---|---|---|
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
Execution
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\":{\"error_difference_percent\":1.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\":false,\"deleteCheckResults\":true,\"deleteSensorReadouts\":true,\"deleteErrorSamples\":true,\"deleteIncidents\":false,\"deleteChecksConfiguration\":false,\"checkCategory\":\"comparisons\",\"tableComparisonName\":\"sample_table_comparison\",\"checkType\":\"monitoring\",\"timeGradient\":\"day\"},\"can_edit\":true,\"can_run_compare_checks\":true,\"can_delete_data\":true}"
Execution
from dqops import client
from dqops.client.api.table_comparisons import update_table_comparison_profiling
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
dqops_client = client.Client(
'http://localhost:8888/'
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = update_table_comparison_profiling.sync(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import update_table_comparison_profiling
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
dqops_client = client.Client(
'http://localhost:8888/'
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = await update_table_comparison_profiling.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import update_table_comparison_profiling
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = update_table_comparison_profiling.sync(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client,
json_body=request_body
)
Execution
from dqops import client
from dqops.client.api.table_comparisons import update_table_comparison_profiling
from dqops.client.models import CheckSearchFilters, \
ColumnComparisonModel, \
CompareThresholdsModel, \
DeleteStoredDataQueueJobParameters, \
PhysicalTableName, \
TableComparisonGroupingColumnPairModel, \
TableComparisonModel
token = 's4mp13_4u7h_70k3n'
dqops_client = client.AuthenticatedClient(
'http://localhost:8888/',
token=token
)
request_body = TableComparisonModel(
table_comparison_configuration_name='sample_table_comparison',
compared_connection='unknown',
compared_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
reference_connection='sample_connection',
reference_table=PhysicalTableName(
schema_name='sample_schema',
table_name='sample_table'
),
grouping_columns=[
],
default_compare_thresholds=CompareThresholdsModel(error_difference_percent=1.0),
supports_compare_column_count=True,
columns=[
],
compare_table_run_checks_job_template=CheckSearchFilters(
check_type=CheckType.MONITORING,
time_scale=CheckTimeScale.DAILY,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
connection='unknown',
full_table_name='sample_schema.sample_table',
enabled=True
),
compare_table_clean_data_job_template=DeleteStoredDataQueueJobParameters(
connection='unknown',
full_table_name='sample_schema.sample_table',
delete_errors=True,
delete_statistics=False,
delete_check_results=True,
delete_sensor_readouts=True,
delete_error_samples=True,
delete_incidents=False,
delete_checks_configuration=False,
check_category='comparisons',
table_comparison_name='sample_table_comparison',
check_type='monitoring',
time_gradient='day'
),
can_edit=True,
can_run_compare_checks=True,
can_delete_data=True
)
call_result = await update_table_comparison_profiling.asyncio(
'sample_connection',
'sample_schema',
'sample_table',
'sample_table_comparison',
client=dqops_client,
json_body=request_body
)