Add unified SQL reference for ALTER ... SET PARALLELISM#958
Add unified SQL reference for ALTER ... SET PARALLELISM#958
Conversation
Co-authored-by: kwannoel <47273164+kwannoel@users.noreply.github.com>
…ER commands Co-authored-by: kwannoel <47273164+kwannoel@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Adds a unified SQL reference page for ALTER ... SET PARALLELISM to improve discoverability and consolidate behavior/syntax across supported object types, plus links from existing docs to the new reference.
Changes:
- Added a new unified page:
sql/commands/sql-alter-parallelism.mdx. - Added backlinks from each individual
ALTER ...page that supportsSET PARALLELISM. - Improved discoverability via SQL commands overview and cross-links from key concepts and cluster scaling docs.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| sql/commands/sql-alter-parallelism.mdx | New consolidated reference page covering syntax, values, object types, and operational notes. |
| sql/commands/sql-alter-table.mdx | Adds a <Note> linking to the unified ALTER ... SET PARALLELISM page. |
| sql/commands/sql-alter-materialized-view.mdx | Adds a <Note> linking to the unified page. |
| sql/commands/sql-alter-index.mdx | Adds a <Note> linking to the unified page. |
| sql/commands/sql-alter-sink.mdx | Adds a <Note> linking to the unified page. |
| sql/commands/sql-alter-source.mdx | Adds a <Note> linking to the unified page. |
| sql/commands/sql-alter-fragment.mdx | Adds a <Note> linking to the unified page. |
| sql/commands/overview.mdx | Adds a new Card entry for the unified page in the SQL commands overview. |
| reference/key-concepts.mdx | Adds a link from the Parallelism concept section to the unified page. |
| deploy/k8s-cluster-scaling.mdx | Adds a link to the unified page from scaling policy documentation. |
| SELECT f.fragment_id, f.parallelism, f.parallelism_policy | ||
| FROM rw_fragments f | ||
| JOIN rw_fragment_parallelism fp ON f.fragment_id = fp.fragment_id | ||
| WHERE fp.object_name = 'your_object_name'; |
There was a problem hiding this comment.
The filtering example under “View parallelism for a specific object's fragments” uses fp.object_name, but rw_fragment_parallelism is documented elsewhere with columns like name/relation_type (and no object_name). This query will fail as written; update it to filter using the actual column names (e.g., fp.name and optionally fp.relation_type) or switch to the simpler SELECT * FROM rw_fragment_parallelism WHERE name = ... pattern used in existing docs.
| WHERE fp.object_name = 'your_object_name'; | |
| WHERE fp.name = 'your_object_name'; |
| --- | ||
| title: "ALTER ... SET PARALLELISM" | ||
| description: "The SET PARALLELISM clause controls the degree of parallelism for streaming jobs and fragments in RisingWave." | ||
| sidebarTitle: "ALTER ... SET PARALLELISM" | ||
| --- |
There was a problem hiding this comment.
This new page is linked from other docs, but it is not added to the SQL commands sidebar navigation in docs.json (the list currently includes many sql/commands/sql-alter-* pages but not sql/commands/sql-alter-parallelism). This conflicts with the PR description/checklist claiming the TOC config was updated; please add sql/commands/sql-alter-parallelism to docs.json so the page is discoverable from the sidebar.
Description
SET PARALLELISMwas documented only within individualALTERcommand pages (TABLE, MATERIALIZED VIEW, INDEX, SINK, SOURCE, FRAGMENT), making it hard to discover and understand holistically. Users searching for "ALTER PARALLELISM" found nothing.New unified reference page at
/sql/commands/sql-alter-parallelism.mdx:ADAPTIVE(default since v1.7), fixed numbers,0,DEFAULT(fragments only)Discoverability improvements:
Example from new page showing syntax consistency:
Related code PR
N/A - documentation only
Related doc issue
Addresses user feedback from Slack thread about missing ALTER PARALLELISM documentation in SQL reference.
Checklist
mint.jsonto include the page in the table of contents.Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.