docs: Add model validation documentation (for PR #7344) #8220
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Create comprehensive model validation documentation page - Document both 'assert' and 'sql' test syntaxes - Include examples for common validation patterns (null checks, ranges, duplicates, etc.) - Add complete example with various validation types - Document test execution behavior and best practices - Include guidance on test naming, organization, and performance - Add sections on working with incremental and partitioned models - Update models index to reference new validation page Related to PR #7344 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
royendo
commented
Oct 31, 2025
|
|
||
| ## Viewing Test Results | ||
|
|
||
| Test results are stored in the model state and visible in: |
There was a problem hiding this comment.
@grahamplata to my knowledge, we dont surface this in the UI today right? How does a user see when a model validation fails?
There was a problem hiding this comment.
There isn't anything available in cloud at the moment
| - Number of rows that failed the test | ||
| - Sample of the failing rows (if applicable) | ||
|
|
||
| ## Best Practices |
There was a problem hiding this comment.
What do you think about this section?
| assert: order_date >= '2020-01-01' | ||
| ``` | ||
|
|
||
| ### Choosing Between Assert and SQL |
|
@grahamplata can you look at the remaining two questions? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds comprehensive documentation for model validation, a feature added in PR #7344.
What's Included
New Documentation Page (
model-validation.md)assertandsqltest typesUpdated Models Index - Added reference to validation page in the Fundamentals section
Documentation Highlights
The documentation covers:
assert(condition-based) andsql(query-based) test syntaxesRelated
🤖 Generated with Claude Code