Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update model-contracts.md for supported models #4336

Merged
merged 12 commits into from
Jan 8, 2024
Merged

Update model-contracts.md for supported models #4336

Changes from 2 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
cc0c83b
Update model-contracts.md for supported models
nathangriffiths-cdx Oct 26, 2023
59107cc
Merge branch 'current' into patch-1
mirnawong1 Oct 26, 2023
7e72828
Apply suggestions from code review
matthewshaver Oct 26, 2023
9d494cb
Update website/docs/docs/collaborate/govern/model-contracts.md
matthewshaver Oct 26, 2023
fb35798
Merge branch 'current' into patch-1
matthewshaver Oct 26, 2023
98e21bd
Apply suggestions from code review
matthewshaver Oct 26, 2023
8ea4c59
Update website/docs/docs/collaborate/govern/model-contracts.md
matthewshaver Oct 26, 2023
a199d43
Merge branch 'current' into patch-1
matthewshaver Nov 2, 2023
3306cc7
Merge branch 'current' into patch-1
mirnawong1 Dec 22, 2023
a715f79
Merge branch 'current' into patch-1
mirnawong1 Jan 8, 2024
3341e91
Merge branch 'current' into patch-1
mirnawong1 Jan 8, 2024
3807a54
Merge branch 'current' into patch-1
mirnawong1 Jan 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions website/docs/docs/collaborate/govern/model-contracts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,18 @@ While this is ideal for quick and iterative development, for some models, consta
## Where are contracts supported?

At present, model contracts are supported for:
- SQL models. Contracts are not yet supported for Python models.
- Models materialized as `table`, `view`, and `incremental` (with `on_schema_change: append_new_columns`). Views offer limited support for column names and data types, but not `constraints`. Contracts are not supported for `ephemeral`-materialized models.
- SQL models.
- Models materialized as one of the following
matthewshaver marked this conversation as resolved.
Show resolved Hide resolved
- `table`
- `view`. Views offer limited support for column names and data types, but not `constraints`.
matthewshaver marked this conversation as resolved.
Show resolved Hide resolved
- `incremental` (with `on_schema_change: append_new_columns` or `on_schema_change: fail`).
matthewshaver marked this conversation as resolved.
Show resolved Hide resolved
- Certain data platforms, but the supported and enforced `constraints` vary by platform.

Model contracts are **not** supported for:
matthewshaver marked this conversation as resolved.
Show resolved Hide resolved
- Python models.
- `ephemeral`-materialized SQL models.
matthewshaver marked this conversation as resolved.
Show resolved Hide resolved


## How to define a contract

Let's say you have a model with a query like:
Expand Down