Skip to content

schemas

Schema management


get_schema_monitoring_checks_model

Return a UI friendly model of configurations for data quality monitoring checks on a schema
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/monitoring/{timeScale}/model  

Return value

 Property name   Description                       Data type 
check_configuration_model List[CheckConfigurationModel]

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string
schema_name Schema name string
time_scale Check time-scale CheckTimeScale
table_name_pattern Table name pattern string
column_name_pattern Column name pattern string
column_data_type Column data-type string
check_target Check target CheckTarget
check_category Check category string
check_name Check name string
check_enabled Check enabled boolean
check_configured Check configured boolean

Usage examples

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

get_schema_monitoring_checks_templates

Return available data quality checks on a requested schema.
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/bulkenable/monitoring/{timeScale}  

Return value

 Property name   Description                       Data type 
check_template List[CheckTemplate]

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string
schema_name Schema name string
time_scale Time scale CheckTimeScale
check_target Check target CheckTarget
check_category Check category string
check_name Check name string

Usage examples

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

get_schema_partitioned_checks_model

Return a UI friendly model of configurations for data quality partitioned checks on a schema
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/partitioned/{timeScale}/model  

Return value

 Property name   Description                       Data type 
check_configuration_model List[CheckConfigurationModel]

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string
schema_name Schema name string
time_scale Check time-scale CheckTimeScale
table_name_pattern Table name pattern string
column_name_pattern Column name pattern string
column_data_type Column data-type string
check_target Check target CheckTarget
check_category Check category string
check_name Check name string
check_enabled Check enabled boolean
check_configured Check configured boolean

Usage examples

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

get_schema_partitioned_checks_templates

Return available data quality checks on a requested schema.
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/bulkenable/partitioned/{timeScale}  

Return value

 Property name   Description                       Data type 
check_template List[CheckTemplate]

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string
schema_name Schema name string
time_scale Time scale CheckTimeScale
check_target Check target CheckTarget
check_category Check category string
check_name Check name string

Usage examples

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

get_schema_profiling_checks_model

Return a flat list of configurations for profiling checks on a schema
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/profiling/model  

Return value

 Property name   Description                       Data type 
check_configuration_model List[CheckConfigurationModel]

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_pattern Table name pattern string
column_name_pattern Column name pattern string
column_data_type Column data-type string
check_target Check target CheckTarget
check_category Check category string
check_name Check name string
check_enabled Check enabled boolean
check_configured Check configured boolean

Usage examples

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/profiling/model^
    -H "Accept: application/json"

get_schema_profiling_checks_templates

Return available data quality checks on a requested schema.
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/bulkenable/profiling  

Return value

 Property name   Description                       Data type 
check_template List[CheckTemplate]

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string
schema_name Schema name string
check_target Check target CheckTarget
check_category Check category string
check_name Check name string

Usage examples

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/bulkenable/profiling^
    -H "Accept: application/json"

get_schemas

Returns a list of schemas inside a connection
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas  

Return value

 Property name   Description                       Data type 
schema_model List[SchemaModel]

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string

Usage examples

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