Skip to content

docs: remove deprecated CLI from Snowflake docs#43

Merged
mason-sharp merged 1 commit into
mainfrom
docs/remove-deprecated-cli
Jul 20, 2026
Merged

docs: remove deprecated CLI from Snowflake docs#43
mason-sharp merged 1 commit into
mainfrom
docs/remove-deprecated-cli

Conversation

@AntTheLimey

Copy link
Copy Markdown
Member

What

The pgEdge CLI is deprecated, but the Snowflake docs still instruct
users to configure snowflake.node with ./pgedge commands. This
rewrites those instructions to be deployment-aware and SQL-based.

docs/creating.md

  • Removes the CLI-driven pgedge spock node-create, pgedge db guc-set, and pgedge reload steps (and the "9 nodes or fewer"
    auto-numbering narrative that only existed because of the CLI).
  • Adds a "managed deployment" section: the Control Plane (node
    ordinal), Helm charts (node name), and Ansible (zone) each set
    snowflake.node automatically.
  • Adds a "manual" section using ALTER SYSTEM SET snowflake.node
    plus SELECT pg_reload_conf();, keeping pg_ctl reload as the
    shell alternative.

README.md

  • Drops the "pgEdge binary" install phrasing in favor of "your
    pgEdge deployment or from source".

Verification

  • snowflake.node range (1-1023) and PGC_SUSET context confirmed
    against snowflake.c.
  • Per-platform node numbering confirmed in control-plane, pgedge-helm,
    and pgedge-ansible.
  • No residual ./pgedge / CLI references remain in the docs.

Targets main; picked up by the next tagged Snowflake release.

The pgEdge CLI is deprecated. Rewrite the snowflake.node setup
to cover managed deployments and use ALTER SYSTEM plus
pg_reload_conf() in place of ./pgedge commands, across
docs/creating.md and README.md.
@coderabbitai

coderabbitai Bot commented Jul 20, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The documentation updates revise Snowflake installation wording and replace CLI-focused snowflake.node setup instructions with managed-deployment and manual-configuration paths, including reload commands.

Changes

Snowflake setup documentation

Layer / File(s) Summary
Installation guidance
README.md
Installation instructions now refer to installing the Snowflake extension with a pgEdge deployment or from source code.
Node configuration guidance
docs/creating.md
Instructions now describe unique node identifiers, automatic assignment for managed deployments, manual configuration options, and configuration reload procedures.

Poem

I’m a rabbit with docs in my paws,
Tuning Snowflake’s setup laws.
Deployments assign, or numbers you set,
Reload the server—no worries yet.
From source or pgEdge, the path is clear,
Sequences hop onward, bright and dear.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: removing deprecated CLI instructions from the Snowflake docs.
Description check ✅ Passed The description clearly matches the documentation updates and references the same CLI-to-SQL changes described in the diff.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/remove-deprecated-cli

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/creating.md`:
- Around line 17-22: Update the installation example around ALTER SYSTEM SET
snowflake.node to state that this command must be executed by a superuser, while
leaving the existing node identifier and reload instructions unchanged.
- Around line 17-27: Update the installation guidance around the ALTER SYSTEM
and postgresql.conf examples to state that they are alternative configuration
methods. Explain that ALTER SYSTEM writes to postgresql.auto.conf and can
override the postgresql.conf value, instructing readers to use one method or
remove/reset any existing ALTER SYSTEM setting before switching.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: fcd7594d-efe6-464b-b6a8-33a35250a7eb

📥 Commits

Reviewing files that changed from the base of the PR and between fce5e57 and 00e200f.

📒 Files selected for processing (2)
  • README.md
  • docs/creating.md

Comment thread docs/creating.md
Comment thread docs/creating.md
@AntTheLimey
AntTheLimey requested a review from mason-sharp July 20, 2026 18:43
@mason-sharp
mason-sharp merged commit 4c75e98 into main Jul 20, 2026
14 checks passed
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.

2 participants