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.

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

Updated constraints doc following slack #5995

Merged
merged 80 commits into from
Oct 4, 2024

Conversation

nataliefiann
Copy link
Contributor

What are you changing in this pull request and why?

Checklist

Adding or removing pages (delete if not applicable):

  • Add/remove page in website/sidebars.js
  • Provide a unique filename for new pages
  • Add an entry for deleted pages in website/vercel.json
  • Run link testing locally with npm run build to update the links that point to deleted pages

I'm creating this PR following Slack convo: https://dbt-labs.slack.com/archives/C02NCQ9483C/p1724830886150839 which Benoit advised there's no example in the docs of custom constraints.

@nataliefiann nataliefiann requested a review from a team as a code owner August 30, 2024 10:43
Copy link

vercel bot commented Aug 30, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
docs-getdbt-com ✅ Ready (Inspect) Visit Preview Oct 4, 2024 8:49am

@github-actions github-actions bot added content Improvements or additions to content size: medium This change will take up to a week to address labels Aug 30, 2024
@b-per
Copy link
Contributor

b-per commented Aug 30, 2024

Thanks @nataliefiann

With the current update, the explanation and example only show when we select "Snowflake" under "Platform-specific support". Would it be possible to have the header "Custom constraints on models for advanced configuration of tables" not being specific to Snowflake?

While the examples we have are Snowflake only here, the overall mechanism of custom constraints would work across all data warehouses.

With the current update, non Snowflake users would likely never see the doc on custom constraints.

website/docs/reference/resource-properties/constraints.md Outdated Show resolved Hide resolved
website/docs/reference/resource-properties/constraints.md Outdated Show resolved Hide resolved
website/docs/reference/resource-properties/constraints.md Outdated Show resolved Hide resolved

:::info

Each data warehouse has its own set of parameters that can be set for columns in their CTAS statements. For example for [DBX](https://docs.databricks.com/en/sql/language-manual/sql-ref-syntax-ddl-create-table-using.html) for [BigQuery](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#column_name_and_column_schema).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See my other comment in the PR discussion, but I don't think that adding information to other data warehouses is relevant if we are currently only showing those docs when people select Snowflake

Copy link
Contributor

@mirnawong1 mirnawong1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @nataliefiann ! have added my suggestions/feedback!

@b-per
Copy link
Contributor

b-per commented Sep 12, 2024

Is there a preview to look at?

@mirnawong1
Copy link
Contributor

Is there a preview to look at?

hey @b-per - yes! here's the preview for you: https://docs-getdbt-khhsr2j4f-dbt-labs.vercel.app/reference/resource-properties/constraints#custom-constraints

@mirnawong1
Copy link
Contributor

hey @nataliefiann @b-per - is this pr ok now?

@mirnawong1 mirnawong1 merged commit cda5488 into current Oct 4, 2024
4 checks passed
@mirnawong1 mirnawong1 deleted the nfiann-snowflake-constraints branch October 4, 2024 08:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to content size: medium This change will take up to a week to address
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants