Configuration
Validation Configuration
Example section for showcasing API endpoints
Metric Configuration
Datachecks will read metrics configuration under the key metrics
in the configuration file. User can define multiple metrics in the configuration file under metrics
key.
For example:
Configuration Details
Parameter | Mandatory | Description |
---|---|---|
key filed | The name of the validation. The name should be unique. | |
on | The type of the validation function. Possible values are freshness , row_count etc. Type of validation mentioned in every metric documentation | |
where | The where filter to be applied on the filed. In where field we can pass SQL Query (In ase of SQl DB) or Search Query (In ase of search engine). For example: where: city = 'bangalore' AND age >= 30 | |
threshold | The validation will be applied on the validation value. A validation error will be invoked if the metric value violate threshold value. Possible values for threshold are > , >= , = , < , <= . We can combine multiple operators For example: threshold: ">= 10 & <= 100" |