-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Add Snowflake semantic view skill and contributing guidelines #515
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
Open
MiguelElGallo
wants to merge
1
commit into
github:main
Choose a base branch
from
MiguelElGallo:snowflake-semantic-view
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+80
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| --- | ||
| name: snowflake-semanticview | ||
| description: Create, alter, and validate Snowflake semantic views using Snowflake CLI (snow). Use when asked to build or troubleshoot semantic views/semantic layer definitions with CREATE/ALTER SEMANTIC VIEW, to validate semantic-view DDL against Snowflake via CLI, or to guide Snowflake CLI installation and connection setup. | ||
MiguelElGallo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| --- | ||
|
|
||
| # Snowflake Semantic Views | ||
|
|
||
| ## One-Time Setup | ||
|
|
||
| - Verify Snowflake CLI installation by opening a new terminal and running `snow --help`. | ||
| - If Snowflake CLI is missing or the user cannot install it, direct them to https://docs.snowflake.com/en/developer-guide/snowflake-cli/installation/installation. | ||
| - Configure a Snowflake connection with `snow connection add` per https://docs.snowflake.com/en/developer-guide/snowflake-cli/connecting/configure-connections#add-a-connection. | ||
| - Use the configured connection for all validation and execution steps. | ||
|
|
||
| ## Workflow For Each Semantic View Request | ||
|
|
||
| 1. Confirm the target database, schema, role, warehouse, and final semantic view name. | ||
| 2. Confirm the model follows a star schema (facts with conformed dimensions). | ||
| 3. Draft the semantic view DDL using the official syntax: | ||
| - https://docs.snowflake.com/en/sql-reference/sql/create-semantic-view | ||
| 4. Populate synonyms and comments for each dimension, fact, and metric: | ||
| - Read Snowflake table/view/column comments first (preferred source): | ||
| - https://docs.snowflake.com/en/sql-reference/sql/comment | ||
| - If comments or synonyms are missing, ask whether you can create them, whether the user wants to provide text, or whether you should draft suggestions for approval. | ||
| 5. Create a temporary validation name (for example, append `__tmp_validate`) while keeping the same database and schema. | ||
| 6. Always validate by sending the DDL to Snowflake via Snowflake CLI before finalizing: | ||
| - Use `snow sql` to execute the statement with the configured connection. | ||
| - If flags differ by version, check `snow sql --help` and use the connection option shown there. | ||
| 7. If validation fails, iterate on the DDL and re-run the validation step until it succeeds. | ||
| 8. Apply the final DDL (create or alter) using the real semantic view name. | ||
| 9. Clean up any temporary semantic view created during validation. | ||
|
|
||
| ## Synonyms And Comments (Required) | ||
|
|
||
| - Use the semantic view syntax for synonyms and comments: | ||
|
|
||
| ``` | ||
| WITH SYNONYMS [ = ] ( 'synonym' [ , ... ] ) | ||
| COMMENT = 'comment_about_dim_fact_or_metric' | ||
| ``` | ||
|
|
||
| - Treat synonyms as informational only; do not use them to reference dimensions, facts, or metrics elsewhere. | ||
| - Use Snowflake comments as the preferred and first source for synonyms and comments: | ||
| - https://docs.snowflake.com/en/sql-reference/sql/comment | ||
| - If Snowflake comments are missing, ask whether you can create them, whether the user wants to provide text, or whether you should draft suggestions for approval. | ||
| - Do not invent synonyms or comments without user approval. | ||
|
|
||
| ## Validation Pattern (Required) | ||
|
|
||
| - Never skip validation. Always execute the DDL against Snowflake with Snowflake CLI before presenting it as final. | ||
| - Prefer a temporary name for validation to avoid clobbering the real view. | ||
|
|
||
| ## Example CLI Validation (Template) | ||
|
|
||
| ```bash | ||
| # Replace placeholders with real values. | ||
| snow sql -q "<CREATE OR ALTER SEMANTIC VIEW ...>" --connection <connection_name> | ||
| ``` | ||
|
|
||
| If the CLI uses a different connection flag in your version, run: | ||
|
|
||
| ```bash | ||
| snow sql --help | ||
| ``` | ||
|
|
||
| ## Notes | ||
|
|
||
| - Treat installation and connection setup as one-time steps, but confirm they are done before the first validation. | ||
| - Keep the final semantic view definition identical to the validated temporary definition except for the name. | ||
| - Do not omit synonyms or comments; consider them required for completeness even if optional in syntax. | ||
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.
Uh oh!
There was an error while loading. Please reload this page.