Skip to content

Commit e71a703

Browse files
doc(concepts-auditing): clarify the intro
Signed-off-by: Sergiy Kolesnikov <6048022+SergiyKolesnikov@users.noreply.github.com>
1 parent 547ac6a commit e71a703

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

‎docs/concepts/audits.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
# Auditing
2-
Audits are one of the tools SQLMesh provides to validate your models. Along with [tests](tests.md), they are a great way to ensure the quality of your data and to build trust in it across your organization.
32

4-
Unlike tests, audits are used to validate the output of a model after every run. When you apply a [plan](./plans.md), SQLMesh will automatically run each model's audits.
3+
Audits validate model outputs against predefined data quality expectations. Along with [tests](tests.md), they help ensure data quality and build trust in your data across your organization.
54

6-
By default, SQLMesh will halt plan application when an audit fails so potentially invalid data does not propagate further downstream. This behavior can be changed for individual audits - refer to [Non-blocking audits](#non-blocking-audits).
5+
Unlike tests, which verify a model's transformation logic using predefined inputs and expected outputs, audits check that the model's actual output data meets the specified quality criteria.
76

8-
A comprehensive suite of audits can identify data issues upstream, whether they are from your vendors or other teams. Audits also empower your data engineers and analysts to work with confidence by catching problems early as they work on new features or make updates to your models.
7+
When you apply a [plan](./plans.md), SQLMesh automatically runs each model's audits. By default, SQLMesh halts plan application when an audit fails so potentially invalid data does not propagate further downstream. This behavior can be changed for individual audits; refer to [Non-blocking audits](#non-blocking-audits).
8+
9+
A comprehensive suite of audits can identify data issues upstream, whether they originate with vendors or other teams. Audits also empower your data practitioners to work with confidence by catching data quality issues early as they work on new features or make updates to your models.
910

1011
**NOTE**: For incremental by time range models, audits are only applied to intervals being processed - not for the entire underlying table.
1112

0 commit comments

Comments
 (0)