Cluster Management Commands
On this page
Node Requirements for SingleStore Commands
SingleStore commands must be run on the appropriate type(s) of node in a SingleStore cluster.
When sync_
and enable_
are set to ON
, all Data Definition Language (DDL) commands can be forwarded from child aggregator to master.
For more information about these variables, see the Sync Variables Lists.
-
X = recommended to run on this type of node
-
P = possible (but not recommended) to run on this type of node
-
blank = cannot run on this type of node
SingleStore Command |
Master Aggregator |
Child Aggregator |
Leaf |
---|---|---|---|
X |
X |
||
X |
|||
X |
X |
||
X |
|||
X |
X |
||
X |
X |
||
X |
X |
P |
|
X |
X |
P |
|
X |
X |
||
X |
X |
||
X |
X |
||
X |
X |
||
X |
X |
P |
|
X |
X |
||
X |
X |
P |
|
P |
P |
P |
|
X |
X |
||
X |
X |
P |
|
X |
X |
||
X |
X |
||
X |
X |
P |
|
X |
X |
||
X |
X |
||
X |
X |
||
X |
X |
||
X |
X |
P |
|
X |
X |
||
X |
X |
||
X |
X |
P |
|
X |
X |
X |
|
X |
X |
||
X |
X |
||
X |
X |
P |
|
X |
X |
||
X |
X |
||
X |
X |
P |
|
X |
X |
||
X |
X |
||
X |
X |
||
X |
X |
||
X |
X |
P |
|
X |
X |
||
X |
X |
X |
|
X |
X |
P |
|
X |
X |
P |
|
X |
X |
X |
|
X |
X |
||
X |
P |
||
X |
X |
X |
|
X |
X |
X |
|
X |
X |
X |
|
X |
X |
P |
|
X |
X |
P |
|
X |
X |
P |
|
X |
X |
P |
|
X |
X |
P |
|
P |
P |
P |
|
X |
X |
||
X |
X |
||
X |
X |
||
X |
X |
||
X |
X |
||
X |
X |
X |
|
X |
X |
P |
|
P |
P |
P |
|
X |
X |
||
X |
X |
||
X |
X |
P |
|
X |
X |
||
X |
X |
||
X |
X |
||
X |
X |
P |
|
X |
X |
P |
|
X |
X |
||
X |
X |
||
X |
X |
P |
|
X |
X |
P |
|
X |
X |
X |
|
X |
X |
P |
|
X |
X |
P |
|
X |
X |
||
X |
X |
||
X |
X |
X |
|
X |
X |
X |
|
X |
X |
X |
|
X |
X |
P |
|
X |
X |
X |
|
X |
X |
X |
|
X |
X |
P |
|
X |
X |
X |
|
X |
X |
X |
|
X |
X |
X |
|
X |
X |
X |
|
X |
X |
X |
|
X |
X |
X |
|
X |
X |
X |
|
X |
X |
X |
|
X |
X |
||
X |
X |
||
X |
X |
X |
|
X |
X |
||
X |
|||
X |
X |
P |
|
X |
X |
P |
Leaf States
Each leaf is in one of the following states:
State |
Description |
---|---|
|
In this state, a leaf is not part of the cluster. This is the state before you run ADD LEAF to introduce the leaf into the system. |
|
This is the default, healthy state of a leaf. |
|
The master aggregator periodically sends a heartbeat (ping) to all the nodes in a cluster to determine if they are responsive and online. If the cluster is in redundancy 2 any partitions on the
See How Failover is Triggered in HA for failover cases. |
|
Not online, and not available for read or write queries. |
|
In this state, the leaf is detached from the cluster. A leaf transitions from |
|
A leaf transitions from The master aggregator will automatically run ATTACH LEAF to attach any partitions on the leaf back into the cluster. |
The following diagram summarizes the leaf states and the transitions between them.
In this section
- ADD AGGREGATOR
- ADD LEAF
- AGGREGATOR SET AS MASTER
- ATTACH LEAF
- ATTACH LEAF ALL
- BOOTSTRAP AGGREGATOR
- DETACH LEAF
- EXPLAIN REBALANCE ALL DATABASES
- EXPLAIN REBALANCE PARTITIONS
- EXPLAIN RESTORE REDUNDANCY
- FILL and FLUSH CONNECTION POOLS
- FLUSH EXTRACTOR POOLS
- FLUSH HOSTS
- PROMOTE AGGREGATOR … TO MASTER
- REBALANCE ALL DATABASES
- REBALANCE PARTITIONS
- REMOVE AGGREGATOR
- REMOVE LEAF
- RESTORE REDUNDANCY
- SHOW AGGREGATORS
- SHOW LEAVES
- SHOW CLUSTER STATUS
- SHOW REBALANCE ALL DATABASES STATUS
- SHOW REBALANCE STATUS
- TRIGGER GC
Last modified: September 11, 2024