Skip to content

README page for snowflake plugin / tiny refactor of snowflake plugin#11

Merged
babourine merged 1 commit intomainfrom
stan_snowflake_readme
Jun 5, 2025
Merged

README page for snowflake plugin / tiny refactor of snowflake plugin#11
babourine merged 1 commit intomainfrom
stan_snowflake_readme

Conversation

@babourine
Copy link
Contributor

No description provided.

Copilot AI review requested due to automatic review settings June 4, 2025 21:37
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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 snowflake plugin with usage, configuration, and best practices
  • Refactors the Snowflake command code by extracting snowflakeClusterContext and snowflakeJobContext, removing the unused DSN field
  • Updates the main README.md to 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{}

@babourine babourine merged commit cbb14ac into main Jun 5, 2025
5 checks passed
@babourine babourine deleted the stan_snowflake_readme branch June 5, 2025 13:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants