diff --git a/doc/user/content/sql/show-cluster-replicas.md b/doc/user/content/sql/show-cluster-replicas.md index f6d94fc214059..7168761e136d5 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#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. + ## 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 | ```