Document SHOW CLUSTER REPLICAS output columns#36194
Open
maheshwarip wants to merge 3 commits intomainfrom
Open
Document SHOW CLUSTER REPLICAS output columns#36194maheshwarip wants to merge 3 commits intomainfrom
maheshwarip wants to merge 3 commits intomainfrom
Conversation
Document the `ready` and `comment` columns that were missing from the docs. The `ready` column indicates whether all objects on the replica have hydrated. Also update examples to include the `comment` column. https://claude.ai/code/session_01LfobjPj58rtwpvWVGtcqiV
The link pointed to the index-specific hydration section, which is too narrow for the `ready` column that covers all object types. https://claude.ai/code/session_01LfobjPj58rtwpvWVGtcqiV
The anchor #size doesn't exist on the create-cluster page; the correct anchor is #available-sizes. https://claude.ai/code/session_01LfobjPj58rtwpvWVGtcqiV
kay-kim
reviewed
Apr 22, 2026
| **cluster** | The name of the cluster. | ||
| **replica** | The name of the replica. | ||
| **size** | The [size](/sql/create-cluster#available-sizes) of the replica. | ||
| **ready** | Whether all objects on the cluster have hydrated. `true` indicates that all indexes, materialized views, and other objects on this replica are caught up with the upstream data and ready to serve queries. |
Contributor
There was a problem hiding this comment.
these two sentences ... so ... is it all objects on the cluster have hydrated? or all objects on this replica are hydrated?
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
3 participants
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.
Motivation
The
SHOW CLUSTER REPLICASdocumentation was missing a formal description of the output columns returned by the command. This makes it harder for users to understand what each column represents.Description
This change adds an "Output" section to the
SHOW CLUSTER REPLICASdocumentation that describes each column:The example output tables have also been updated to include the
commentcolumn and fix formatting inconsistencies to match the documented output format.Verification
Documentation change only. The output format matches the actual command behavior.
https://claude.ai/code/session_01LfobjPj58rtwpvWVGtcqiV