README page for snowflake plugin / tiny refactor of snowflake plugin#11
Merged
README page for snowflake plugin / tiny refactor of snowflake plugin#11
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces comprehensive documentation for the Snowflake plugin and performs a small refactor of its internal context handling.
- Adds a dedicated README for the
snowflakeplugin with usage, configuration, and best practices - Refactors the Snowflake command code by extracting
snowflakeClusterContextandsnowflakeJobContext, removing the unused DSN field - Updates the main
README.mdto link to the new Snowflake plugin documentation
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| plugins/snowflake/README.md | New plugin documentation covering setup, job submission, result retrieval, and security |
| internal/pkg/object/command/snowflake/snowflake.go | Split contexts into separate structs, removed unused fields, updated unmarshalling |
| README.md | Added hyperlink for the Snowflake plugin entry in the plugin overview table |
Comments suppressed due to low confidence (3)
internal/pkg/object/command/snowflake/snowflake.go:27
- Typo in error message: 'invalida' should be 'invalid'.
ErrInvalidKeyType = fmt.Errorf(`invalida key type`)
plugins/snowflake/README.md:67
- The example uses 'type:snowflake-prod', which doesn't match the defined cluster tags ('type:snowflake', 'data:prod'). Update the criteria to align with the actual tags or clarify the matching logic.
"cluster_criteria": ["type:snowflake-prod"],
internal/pkg/object/command/snowflake/snowflake.go:30
- [nitpick] This struct is empty and may not be needed; consider removing it or adding a comment to explain its intended use.
type snowflakeCommandContext struct{}
wlggraham
approved these changes
Jun 4, 2025
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
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.
No description provided.