Skip to content

schemas

SchemaModel

Schema model that is returned by the REST API. Describes a single unique schema name.

The structure of this object is described below

 Property name   Description                       Data type 
connection_name Connection name. string
schema_name Schema name. string
run_checks_job_template Configured parameters for the "check run" job that should be pushed to the job queue in order to run all checks within this schema. CheckSearchFilters
run_profiling_checks_job_template Configured parameters for the "check run" job that should be pushed to the job queue in order to run profiling checks within this schema. CheckSearchFilters
run_monitoring_checks_job_template Configured parameters for the "check run" job that should be pushed to the job queue in order to run monitoring checks within this schema. CheckSearchFilters
run_partition_checks_job_template Configured parameters for the "check run" job that should be pushed to the job queue in order to run partition partitioned checks within this schema. CheckSearchFilters
collect_statistics_job_template Configured parameters for the "collect statistics" job that should be pushed to the job queue in order to run all statistics collectors within this schema. StatisticsCollectorSearchFilters
import_table_job_parameters Job parameters for the import tables job that will import all tables from this schema. ImportTablesQueueJobParameters
data_clean_job_template Configured parameters for the "data clean" job that after being supplied with a time range should be pushed to the job queue in order to remove stored results connected with this schema. DeleteStoredDataQueueJobParameters
can_edit Boolean flag that decides if the current user can update or delete the schema. boolean
can_collect_statistics Boolean flag that decides if the current user can collect statistics. boolean
can_run_checks Boolean flag that decides if the current user can run checks. boolean
can_delete_data Boolean flag that decides if the current user can delete data (results). boolean