Skip to content

Document SHOW CLUSTER REPLICAS output columns #36194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
maheshwarip wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Document SHOW CLUSTER REPLICAS output columns #36194

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
966b655
doc: add output column descriptions to SHOW CLUSTER REPLICAS
claude Apr 21, 2026
ece9eb8
doc: remove link to index hydration from SHOW CLUSTER REPLICAS
claude Apr 21, 2026
43c82f3
doc: fix broken anchor link in SHOW CLUSTER REPLICAS
claude Apr 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions doc/user/content/sql/show-cluster-replicas.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,25 @@ Syntax element | Description
**LIKE** \<pattern\> | If specified, only show clusters that match the pattern.
**WHERE** <condition(s)> | If specified, only show clusters that match the condition(s).

## Output

Column | Description
-------------|------------
**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.
Copy link
Copy Markdown
Contributor

@kay-kim kay-kim Apr 22, 2026

Choose a reason for hiding this comment

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

these two sentences ... so ... is it all objects on the cluster have hydrated? or all objects on this replica are hydrated?

**comment** | The [comment](/sql/comment-on) associated with the cluster replica, if any.

## Examples

```mzsql
SHOW CLUSTER REPLICAS;
```

```nofmt
cluster | replica | size | ready |
---------------+---------|--------|-------|
cluster | replica | size | ready | comment
---------------+---------|--------|-------|--------
auction_house | bigger | 1600cc | t |
quickstart | r1 | 25cc | t |
```
Expand All @@ -41,9 +51,9 @@ SHOW CLUSTER REPLICAS WHERE cluster = 'quickstart';
```

```nofmt
cluster | replica | size | ready|
---------------+---------|--------|-------
quickstart | r1 | 25cc | t |
cluster | replica | size | ready | comment
---------------+---------|--------|-------|--------
quickstart | r1 | 25cc | t |
```


Expand Down
Loading