Skip to Content
SQL ReferenceCluster Operations

Cluster Operations

Cluster inspection and administration are documented on the CLI page first. The CLI renders the structured SQL results returned by the server, which keeps operational output out of backend string-formatting paths.

See Interactive Commands — cluster for the supported operator commands and SQL Workflows — follower write forwarding for the end-to-end flow when a write lands on a follower node. For the Multi-Raft architecture, see /docs/server/architecture/clustering.

Inspect cluster state

Use the CLI for node and group views:

BASH
kalam --command "\\cluster list"kalam --command "\\cluster list groups"

For raw tabular access, query the system views directly:

SQL
SELECT * FROM system.cluster ORDER BY is_leader DESC, node_id ASC;SELECT * FROM system.cluster_groups ORDER BY group_id ASC;

CLUSTER LIST, CLUSTER STATUS, and CLUSTER LS are no longer documented SQL commands. Use \cluster list or the system.cluster views instead.

Run cluster operations

Use the CLI cluster meta-commands documented in Interactive Commands. Those commands still use the SQL transport under the hood, but the CLI owns the operator-facing rendering.

Automation note

The underlying SQL transport is still what the CLI calls, so automation can keep using the cluster SQL statements when you want the raw row payload instead of CLI rendering.

Unsupported or removed commands

SQL
CLUSTER LEAVE; -- unsupported

CLUSTER LEAVE is still unsupported. For list-style inspection, use \cluster list or the system views instead of old CLUSTER LIST/STATUS/LS SQL forms.

CLUSTER TRANSFER LEADER is still routed by the backend, but some builds can report it as unsupported at runtime depending on the OpenRaft version in use.

Last updated on
Built-in FunctionsBackup & Restore