From 966b6557466a0c020fab6cae35f2b224b8c15588 Mon Sep 17 00:00:00 2001 From: Claude Date: Tue, 21 Apr 2026 21:34:33 +0000 Subject: [PATCH 1/3] doc: add output column descriptions to SHOW CLUSTER REPLICAS 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 --- doc/user/content/sql/show-cluster-replicas.md | 20 ++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/doc/user/content/sql/show-cluster-replicas.md b/doc/user/content/sql/show-cluster-replicas.md index f6d94fc214059..48a405239ac94 100644 --- a/doc/user/content/sql/show-cluster-replicas.md +++ b/doc/user/content/sql/show-cluster-replicas.md @@ -23,6 +23,16 @@ Syntax element | Description **LIKE** \ | If specified, only show clusters that match the pattern. **WHERE** | 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#size) of the replica. +**ready** | Whether all objects on the cluster have [hydrated](/sql/create-index/#index-hydration). `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. +**comment** | The [comment](/sql/comment-on) associated with the cluster replica, if any. + ## Examples ```mzsql @@ -30,8 +40,8 @@ SHOW CLUSTER REPLICAS; ``` ```nofmt - cluster | replica | size | ready | ----------------+---------|--------|-------| + cluster | replica | size | ready | comment +---------------+---------|--------|-------|-------- auction_house | bigger | 1600cc | t | quickstart | r1 | 25cc | t | ``` @@ -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 | ``` From ece9eb81b15fd665587ace7d955938183cd651c9 Mon Sep 17 00:00:00 2001 From: Claude Date: Tue, 21 Apr 2026 21:36:03 +0000 Subject: [PATCH 2/3] doc: remove link to index hydration from SHOW CLUSTER REPLICAS 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 --- doc/user/content/sql/show-cluster-replicas.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/user/content/sql/show-cluster-replicas.md b/doc/user/content/sql/show-cluster-replicas.md index 48a405239ac94..f5d9cd0f3d752 100644 --- a/doc/user/content/sql/show-cluster-replicas.md +++ b/doc/user/content/sql/show-cluster-replicas.md @@ -30,7 +30,7 @@ Column | Description **cluster** | The name of the cluster. **replica** | The name of the replica. **size** | The [size](/sql/create-cluster#size) of the replica. -**ready** | Whether all objects on the cluster have [hydrated](/sql/create-index/#index-hydration). `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. +**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. **comment** | The [comment](/sql/comment-on) associated with the cluster replica, if any. ## Examples From 43c82f36ea33c3358d87eb41bba2c7d43b12a184 Mon Sep 17 00:00:00 2001 From: Claude Date: Wed, 22 Apr 2026 21:03:43 +0000 Subject: [PATCH 3/3] doc: fix broken anchor link in SHOW CLUSTER REPLICAS The anchor #size doesn't exist on the create-cluster page; the correct anchor is #available-sizes. https://claude.ai/code/session_01LfobjPj58rtwpvWVGtcqiV --- doc/user/content/sql/show-cluster-replicas.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/user/content/sql/show-cluster-replicas.md b/doc/user/content/sql/show-cluster-replicas.md index f5d9cd0f3d752..7168761e136d5 100644 --- a/doc/user/content/sql/show-cluster-replicas.md +++ b/doc/user/content/sql/show-cluster-replicas.md @@ -29,7 +29,7 @@ Column | Description -------------|------------ **cluster** | The name of the cluster. **replica** | The name of the replica. -**size** | The [size](/sql/create-cluster#size) 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. **comment** | The [comment](/sql/comment-on) associated with the cluster replica, if any.