| <!-- |
| |
| Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance |
| with the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, |
| software distributed under the License is distributed on an |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| KIND, either express or implied. See the License for the |
| specific language governing permissions and limitations |
| under the License. |
| |
| --> |
| |
| # Cluster Information Query Command |
| |
| ## Show Variables |
| |
| Currently, IoTDB supports showing key parameters of the cluster: |
| ``` |
| SHOW VARIABLES |
| ``` |
| |
| Eg: |
| ``` |
| IoTDB> show variables |
| +----------------------------------+-----------------------------------------------------------------+ |
| | Variables| Value| |
| +----------------------------------+-----------------------------------------------------------------+ |
| | ClusterName| defaultCluster| |
| | DataReplicationFactor| 1| |
| | SchemaReplicationFactor| 1| |
| | DataRegionConsensusProtocolClass| org.apache.iotdb.consensus.iot.IoTConsensus| |
| |SchemaRegionConsensusProtocolClass| org.apache.iotdb.consensus.ratis.RatisConsensus| |
| | ConfigNodeConsensusProtocolClass| org.apache.iotdb.consensus.ratis.RatisConsensus| |
| | TimePartitionInterval| 604800000| |
| | DefaultTTL(ms)| 9223372036854775807| |
| | ReadConsistencyLevel| strong| |
| | SchemaRegionPerDataNode| 1.0| |
| | DataRegionPerDataNode| 5.0| |
| | LeastDataRegionGroupNum| 5| |
| | SeriesSlotNum| 10000| |
| | SeriesSlotExecutorClass|org.apache.iotdb.commons.partition.executor.hash.BKDRHashExecutor| |
| | DiskSpaceWarningThreshold| 0.05| |
| +----------------------------------+-----------------------------------------------------------------+ |
| Total line number = 15 |
| It costs 0.225s |
| ``` |
| |
| **Notice:** Ensure that all key parameters displayed in this SQL are consist on each node in the same cluster |
| |
| ## Show ConfigNode information |
| |
| Currently, IoTDB supports showing ConfigNode information by the following SQL: |
| ``` |
| SHOW CONFIGNODES |
| ``` |
| |
| Eg: |
| ``` |
| IoTDB> show confignodes |
| +------+-------+---------------+------------+--------+ |
| |NodeID| Status|InternalAddress|InternalPort| Role| |
| +------+-------+---------------+------------+--------+ |
| | 0|Running| 127.0.0.1| 10710| Leader| |
| | 1|Running| 127.0.0.1| 10711|Follower| |
| | 2|Running| 127.0.0.1| 10712|Follower| |
| +------+-------+---------------+------------+--------+ |
| Total line number = 3 |
| It costs 0.030s |
| ``` |
| |
| ### ConfigNode status definition |
| The ConfigNode statuses are defined as follows: |
| |
| - **Running**: The ConfigNode is running properly. |
| - **Unknown**: The ConfigNode doesn't report heartbeat properly. |
| - Can't receive data synchronized from other ConfigNodes |
| - Won't be selected as the cluster ConfigNode-leader |
| |
| ## Show DataNode information |
| |
| Currently, IoTDB supports showing DataNode information by the following SQL: |
| ``` |
| SHOW DATANODES |
| ``` |
| |
| Eg: |
| ``` |
| IoTDB> create timeseries root.sg.d1.s1 with datatype=BOOLEAN,encoding=PLAIN |
| Msg: The statement is executed successfully. |
| IoTDB> create timeseries root.sg.d2.s1 with datatype=BOOLEAN,encoding=PLAIN |
| Msg: The statement is executed successfully. |
| IoTDB> create timeseries root.ln.d1.s1 with datatype=BOOLEAN,encoding=PLAIN |
| Msg: The statement is executed successfully. |
| IoTDB> show datanodes |
| +------+-------+----------+-------+-------------+---------------+ |
| |NodeID| Status|RpcAddress|RpcPort|DataRegionNum|SchemaRegionNum| |
| +------+-------+----------+-------+-------------+---------------+ |
| | 1|Running| 127.0.0.1| 6667| 0| 1| |
| | 2|Running| 127.0.0.1| 6668| 0| 1| |
| +------+-------+----------+-------+-------------+---------------+ |
| Total line number = 2 |
| It costs 0.007s |
| |
| IoTDB> insert into root.ln.d1(timestamp,s1) values(1,true) |
| Msg: The statement is executed successfully. |
| IoTDB> show datanodes |
| +------+-------+----------+-------+-------------+---------------+ |
| |NodeID| Status|RpcAddress|RpcPort|DataRegionNum|SchemaRegionNum| |
| +------+-------+----------+-------+-------------+---------------+ |
| | 1|Running| 127.0.0.1| 6667| 1| 1| |
| | 2|Running| 127.0.0.1| 6668| 0| 1| |
| +------+-------+----------+-------+-------------+---------------+ |
| Total line number = 2 |
| It costs 0.006s |
| ``` |
| |
| ### DataNode status definition |
| The state machine of DataNode is shown in the figure below: |
| <img style="width:100%; max-width:500px; max-height:500px; margin-left:auto; margin-right:auto; display:block;" src="https://alioss.timecho.com/docs/img/UserGuide/Cluster/DataNode-StateMachine-EN.jpg?raw=true"> |
| |
| The DataNode statuses are defined as follows: |
| |
| - **Running**: The DataNode is running properly and is readable and writable. |
| - **Unknown**: The DataNode doesn't report heartbeat properly, the ConfigNode considers the DataNode as unreadable and un-writable. |
| - The cluster is still readable and writable if some DataNodes are Unknown |
| - **Removing**: The DataNode is being removed from the cluster and is unreadable and un-writable. |
| - The cluster is still readable and writable if some DataNodes are Removing |
| - **ReadOnly**: The remaining disk space of DataNode is lower than disk_warning_threshold(default is 5%), the DataNode is readable but un-writable and cannot synchronize data. |
| - The cluster is still readable and writable if some DataNodes are ReadOnly |
| - The schema and data in a ReadOnly DataNode is readable |
| - The schema and data in a ReadOnly DataNode is deletable |
| - A ReadOnly DataNode is creatable for schema, but un-writable for data |
| - Data cannot be written to the cluster when all DataNodes are ReadOnly, but new Databases and schema is still creatable |
| |
| **For a DataNode**, the following table describes the impact of schema read, write, and deletion in different status: |
| |
| | DataNode status | readable | creatable | deletable | |
| |-----------------|----------|-----------|-----------| |
| | Running | yes | yes | yes | |
| | Unknown | no | no | no | |
| | Removing | no | no | no | |
| | ReadOnly | yes | yes | yes | |
| |
| **For a DataNode**, the following table describes the impact of data read, write, and deletion in different status: |
| |
| | DataNode status | readable | writable | deletable | |
| |-----------------|----------|----------|-----------| |
| | Running | yes | yes | yes | |
| | Unknown | no | no | no | |
| | Removing | no | no | no | |
| | ReadOnly | yes | no | yes | |
| |
| ## Show all Node information |
| |
| Currently, IoTDB supports show the information of all Nodes by the following SQL: |
| ``` |
| SHOW CLUSTER |
| ``` |
| |
| Eg: |
| ``` |
| IoTDB> show cluster |
| +------+----------+-------+---------------+------------+ |
| |NodeID| NodeType| Status|InternalAddress|InternalPort| |
| +------+----------+-------+---------------+------------+ |
| | 0|ConfigNode|Running| 127.0.0.1| 10710| |
| | 1|ConfigNode|Running| 127.0.0.1| 10711| |
| | 2|ConfigNode|Running| 127.0.0.1| 10712| |
| | 3| DataNode|Running| 127.0.0.1| 10730| |
| | 4| DataNode|Running| 127.0.0.1| 10731| |
| | 5| DataNode|Running| 127.0.0.1| 10732| |
| +------+----------+-------+---------------+------------+ |
| Total line number = 6 |
| It costs 0.011s |
| ``` |
| |
| After a node is stopped, its status will change, as shown below: |
| ``` |
| IoTDB> show cluster |
| +------+----------+-------+---------------+------------+ |
| |NodeID| NodeType| Status|InternalAddress|InternalPort| |
| +------+----------+-------+---------------+------------+ |
| | 0|ConfigNode|Running| 127.0.0.1| 10710| |
| | 1|ConfigNode|Unknown| 127.0.0.1| 10711| |
| | 2|ConfigNode|Running| 127.0.0.1| 10712| |
| | 3| DataNode|Running| 127.0.0.1| 10730| |
| | 4| DataNode|Running| 127.0.0.1| 10731| |
| | 5| DataNode|Running| 127.0.0.1| 10732| |
| +------+----------+-------+---------------+------------+ |
| Total line number = 6 |
| It costs 0.012s |
| ``` |
| |
| Show the details of all nodes: |
| ``` |
| SHOW CLUSTER DETAILS |
| ``` |
| |
| Eg: |
| ``` |
| IoTDB> show cluster details |
| +------+----------+-------+---------------+------------+-------------------+----------+-------+-------+-------------------+-----------------+ |
| |NodeID| NodeType| Status|InternalAddress|InternalPort|ConfigConsensusPort|RpcAddress|RpcPort|MppPort|SchemaConsensusPort|DataConsensusPort| |
| +------+----------+-------+---------------+------------+-------------------+----------+-------+-------+-------------------+-----------------+ |
| | 0|ConfigNode|Running| 127.0.0.1| 10710| 10720| | | | | | |
| | 1|ConfigNode|Running| 127.0.0.1| 10711| 10721| | | | | | |
| | 2|ConfigNode|Running| 127.0.0.1| 10712| 10722| | | | | | |
| | 3| DataNode|Running| 127.0.0.1| 10730| | 127.0.0.1| 6667| 10740| 10750| 10760| |
| | 4| DataNode|Running| 127.0.0.1| 10731| | 127.0.0.1| 6668| 10741| 10751| 10761| |
| | 5| DataNode|Running| 127.0.0.1| 10732| | 127.0.0.1| 6669| 10742| 10752| 10762| |
| +------+----------+-------+---------------+------------+-------------------+----------+-------+-------+-------------------+-----------------+ |
| Total line number = 6 |
| It costs 0.340s |
| ``` |
| |
| ## Show Region information |
| |
| The cluster uses a SchemaRegion/DataRegion as a unit for schema/data replication and data management. |
| The Region status and distribution is helpful for system operation and maintenance testing, as shown in the following scenarios: |
| |
| - Check which DataNodes are allocated to each Region in the cluster and whether they are balanced. |
| - Check the partitions allocated to each Region in the cluster and whether they are balanced. |
| - Check which DataNodes are allocated by the leaders of each RegionGroup in the cluster and whether they are balanced. |
| |
| Currently, IoTDB supports show Region information by the following SQL: |
| |
| - `SHOW REGIONS`: Show distribution of all Regions. |
| - `SHOW SCHEMA REGIONS`: Show distribution of all SchemaRegions. |
| - `SHOW DATA REGIONS`: Show distribution of all DataRegions. |
| - `SHOW (DATA|SCHEMA)? REGIONS OF DATABASE <sg1,sg2,...>`: Show Region distribution of specified StorageGroups. |
| - `SHOW (DATA|SCHEMA)? REGIONS ON NODEID <id1,id2,...>`: Show Region distribution on specified Nodes. |
| - `SHOW (DATA|SCHEMA)? REGIONS (OF DATABASE <sg1,sg2,...>)? (ON NODEID <id1,id2,...>)?`: Show Region distribution of specified StorageGroups on specified Nodes. |
| |
| Show distribution of all Regions: |
| ``` |
| IoTDB> show regions |
| +--------+------------+-------+--------+-------------+-----------+----------+----------+-------+--------+-----------------------+ |
| |RegionId| Type| Status|Database|SeriesSlotNum|TimeSlotNum|DataNodeId|RpcAddress|RpcPort| Role| CreateTime| |
| +--------+------------+-------+--------+-------------+-----------+----------+----------+-------+--------+-----------------------+ |
| | 0| DataRegion|Running|root.sg1| 1| 1| 1| 127.0.0.1| 6667|Follower|2023-03-07T17:32:18.520| |
| | 0| DataRegion|Running|root.sg1| 1| 1| 2| 127.0.0.1| 6668| Leader|2023-03-07T17:32:18.749| |
| | 0| DataRegion|Running|root.sg1| 1| 1| 3| 127.0.0.1| 6669|Follower|2023-03-07T17:32:19.013| |
| | 1|SchemaRegion|Running|root.sg1| 1| 0| 1| 127.0.0.1| 6667|Follower|2023-03-07T17:32:18.111| |
| | 1|SchemaRegion|Running|root.sg1| 1| 0| 2| 127.0.0.1| 6668|Follower|2023-03-07T17:32:18.245| |
| | 1|SchemaRegion|Running|root.sg1| 1| 0| 3| 127.0.0.1| 6669| Leader|2023-03-07T17:32:18.398| |
| | 2| DataRegion|Running|root.sg2| 1| 1| 1| 127.0.0.1| 6667| Leader|2023-03-07T17:32:19.834| |
| | 2| DataRegion|Running|root.sg2| 1| 1| 2| 127.0.0.1| 6668|Follower|2023-03-07T17:32:20.011| |
| | 2| DataRegion|Running|root.sg2| 1| 1| 3| 127.0.0.1| 6669|Follower|2023-03-07T17:32:20.395| |
| | 3|SchemaRegion|Running|root.sg2| 1| 0| 1| 127.0.0.1| 6667|Follower|2023-03-07T17:32:19.232| |
| | 3|SchemaRegion|Running|root.sg2| 1| 0| 2| 127.0.0.1| 6668| Leader|2023-03-07T17:32:19.450| |
| | 3|SchemaRegion|Running|root.sg2| 1| 0| 3| 127.0.0.1| 6669|Follower|2023-03-07T17:32:19.637| |
| +--------+------------+-------+--------+-------------+-----------+----------+----------+-------+--------+-----------------------+ |
| Total line number = 12 |
| It costs 0.165s |
| ``` |
| |
| The SeriesSlotNum refers to the number of the seriesSlots in the region. In the same light, the TimeSlotNum means the number of the timeSlots in the region. |
| |
| Show the distribution of SchemaRegions or DataRegions: |
| ``` |
| IoTDB> show data regions |
| +--------+------------+-------+--------+-------------+-----------+----------+----------+-------+--------+-----------------------+ |
| |RegionId| Type| Status|Database|SeriesSlotNum|TimeSlotNum|DataNodeId|RpcAddress|RpcPort| Role| CreateTime| |
| +--------+------------+-------+--------+-------------+-----------+----------+----------+-------+--------+-----------------------+ |
| | 0| DataRegion|Running|root.sg1| 1| 1| 1| 127.0.0.1| 6667|Follower|2023-03-07T17:32:18.520| |
| | 0| DataRegion|Running|root.sg1| 1| 1| 2| 127.0.0.1| 6668| Leader|2023-03-07T17:32:18.749| |
| | 0| DataRegion|Running|root.sg1| 1| 1| 3| 127.0.0.1| 6669|Follower|2023-03-07T17:32:19.013| |
| | 2| DataRegion|Running|root.sg2| 1| 1| 1| 127.0.0.1| 6667| Leader|2023-03-07T17:32:19.834| |
| | 2| DataRegion|Running|root.sg2| 1| 1| 2| 127.0.0.1| 6668|Follower|2023-03-07T17:32:20.011| |
| | 2| DataRegion|Running|root.sg2| 1| 1| 3| 127.0.0.1| 6669|Follower|2023-03-07T17:32:20.395| |
| +--------+------------+-------+--------+-------------+-----------+----------+----------+-------+--------+-----------------------+ |
| Total line number = 6 |
| It costs 0.011s |
| |
| IoTDB> show schema regions |
| +--------+------------+-------+--------+-------------+-----------+----------+----------+-------+--------+-----------------------+ |
| |RegionId| Type| Status|Database|SeriesSlotNum|TimeSlotNum|DataNodeId|RpcAddress|RpcPort| Role| CreateTime| |
| +--------+------------+-------+--------+-------------+-----------+----------+----------+-------+--------+-----------------------+ |
| | 1|SchemaRegion|Running|root.sg1| 1| 0| 1| 127.0.0.1| 6667|Follower|2023-03-07T17:32:18.111| |
| | 1|SchemaRegion|Running|root.sg1| 1| 0| 2| 127.0.0.1| 6668|Follower|2023-03-07T17:32:18.245| |
| | 1|SchemaRegion|Running|root.sg1| 1| 0| 3| 127.0.0.1| 6669| Leader|2023-03-07T17:32:18.398| |
| | 3|SchemaRegion|Running|root.sg2| 1| 0| 1| 127.0.0.1| 6667|Follower|2023-03-07T17:32:19.232| |
| | 3|SchemaRegion|Running|root.sg2| 1| 0| 2| 127.0.0.1| 6668| Leader|2023-03-07T17:32:19.450| |
| | 3|SchemaRegion|Running|root.sg2| 1| 0| 3| 127.0.0.1| 6669|Follower|2023-03-07T17:32:19.637| |
| +--------+------------+-------+--------+-------------+-----------+----------+----------+-------+--------+-----------------------+ |
| Total line number = 6 |
| It costs 0.012s |
| ``` |
| |
| Show Region distribution of specified DataBases: |
| ``` |
| IoTDB> show regions of database root.sg1 |
| +--------+------------+-------+--------+-------------+-----------+----------+----------+-------+--------+-----------------------+ |
| |RegionId| Type| Status|Database|SeriesSlotNum|TimeSlotNum|DataNodeId|RpcAddress|RpcPort| Role| CreateTime| |
| +--------+------------+-------+-- -----+-------------+-----------+----------+----------+-------+--------+-----------------------+ |
| | 0| DataRegion|Running|root.sg1| 1| 1| 1| 127.0.0.1| 6667|Follower|2023-03-07T17:32:18.520| |
| | 0| DataRegion|Running|root.sg1| 1| 1| 2| 127.0.0.1| 6668| Leader|2023-03-07T17:32:18.749| |
| | 0| DataRegion|Running|root.sg1| 1| 1| 3| 127.0.0.1| 6669|Follower|2023-03-07T17:32:19.013| |
| | 1|SchemaRegion|Running|root.sg1| 1| 0| 1| 127.0.0.1| 6667|Follower|2023-03-07T17:32:18.111| |
| | 1|SchemaRegion|Running|root.sg1| 1| 0| 2| 127.0.0.1| 6668|Follower|2023-03-07T17:32:18.245| |
| | 1|SchemaRegion|Running|root.sg1| 1| 0| 3| 127.0.0.1| 6669| Leader|2023-03-07T17:32:18.398| |
| +--------+------------+-------+--------+-------------+-----------+----------+----------+-------+--------+-----------------------+ |
| Total line number = 6 |
| It costs 0.007s |
| |
| IoTDB> show regions of database root.sg1, root.sg2 |
| +--------+------------+-------+--------+-------------+-----------+----------+----------+-------+--------+-----------------------+ |
| |RegionId| Type| Status|Database|SeriesSlotNum|TimeSlotNum|DataNodeId|RpcAddress|RpcPort| Role| CreateTime| |
| +--------+------------+-------+--------+-------------+-----------+----------+----------+-------+--------+-----------------------+ |
| | 0| DataRegion|Running|root.sg1| 1| 1| 1| 127.0.0.1| 6667|Follower|2023-03-07T17:32:18.520| |
| | 0| DataRegion|Running|root.sg1| 1| 1| 2| 127.0.0.1| 6668| Leader|2023-03-07T17:32:18.749| |
| | 0| DataRegion|Running|root.sg1| 1| 1| 3| 127.0.0.1| 6669|Follower|2023-03-07T17:32:19.013| |
| | 1|SchemaRegion|Running|root.sg1| 1| 0| 1| 127.0.0.1| 6667|Follower|2023-03-07T17:32:18.111| |
| | 1|SchemaRegion|Running|root.sg1| 1| 0| 2| 127.0.0.1| 6668|Follower|2023-03-07T17:32:18.245| |
| | 1|SchemaRegion|Running|root.sg1| 1| 0| 3| 127.0.0.1| 6669| Leader|2023-03-07T17:32:18.398| |
| | 2| DataRegion|Running|root.sg2| 1| 1| 1| 127.0.0.1| 6667| Leader|2023-03-07T17:32:19.834| |
| | 2| DataRegion|Running|root.sg2| 1| 1| 2| 127.0.0.1| 6668|Follower|2023-03-07T17:32:20.011| |
| | 2| DataRegion|Running|root.sg2| 1| 1| 3| 127.0.0.1| 6669|Follower|2023-03-07T17:32:20.395| |
| | 3|SchemaRegion|Running|root.sg2| 1| 0| 1| 127.0.0.1| 6667|Follower|2023-03-07T17:32:19.232| |
| | 3|SchemaRegion|Running|root.sg2| 1| 0| 2| 127.0.0.1| 6668| Leader|2023-03-07T17:32:19.450| |
| | 3|SchemaRegion|Running|root.sg2| 1| 0| 3| 127.0.0.1| 6669|Follower|2023-03-07T17:32:19.637| |
| +--------+------------+-------+--------+-------------+-----------+----------+----------+-------+--------+-----------------------+ |
| Total line number = 12 |
| It costs 0.009s |
| |
| IoTDB> show data regions of database root.sg1, root.sg2 |
| +--------+----------+-------+--------+-------------+-----------+----------+----------+-------+--------+-----------------------+ |
| |RegionId| Type| Status|Database|SeriesSlotNum|TimeSlotNum|DataNodeId|RpcAddress|RpcPort| Role| CreateTime| |
| +--------+----------+-------+--------+-------------+-----------+----------+----------+-------+--------+-----------------------+ |
| | 0|DataRegion|Running|root.sg1| 1| 1| 1| 127.0.0.1| 6667|Follower|2023-03-07T17:32:18.520| |
| | 0|DataRegion|Running|root.sg1| 1| 1| 2| 127.0.0.1| 6668| Leader|2023-03-07T17:32:18.749| |
| | 0|DataRegion|Running|root.sg1| 1| 1| 3| 127.0.0.1| 6669|Follower|2023-03-07T17:32:19.013| |
| | 2|DataRegion|Running|root.sg2| 1| 1| 1| 127.0.0.1| 6667| Leader|2023-03-07T17:32:19.834| |
| | 2|DataRegion|Running|root.sg2| 1| 1| 2| 127.0.0.1| 6668|Follower|2023-03-07T17:32:20.011| |
| | 2|DataRegion|Running|root.sg2| 1| 1| 3| 127.0.0.1| 6669|Follower|2023-03-07T17:32:20.395| |
| +--------+----------+-------+--------+-------------+-----------+----------+----------+-------+--------+-----------------------+ |
| Total line number = 6 |
| It costs 0.007s |
| |
| IoTDB> show schema regions of database root.sg1, root.sg2 |
| +--------+------------+-------+--------+-------------+-----------+----------+----------+-------+--------+-----------------------+ |
| |RegionId| Type| Status|Database|SeriesSlotNum|TimeSlotNum|DataNodeId|RpcAddress|RpcPort| Role| CreateTime| |
| +--------+------------+-------+--------+-------------+-----------+----------+----------+-------+--------+-----------------------+ |
| | 1|SchemaRegion|Running|root.sg1| 1| 0| 1| 127.0.0.1| 6667|Follower|2023-03-07T17:32:18.111| |
| | 1|SchemaRegion|Running|root.sg1| 1| 0| 2| 127.0.0.1| 6668|Follower|2023-03-07T17:32:18.245| |
| | 1|SchemaRegion|Running|root.sg1| 1| 0| 3| 127.0.0.1| 6669| Leader|2023-03-07T17:32:18.398| |
| | 3|SchemaRegion|Running|root.sg2| 1| 0| 1| 127.0.0.1| 6667|Follower|2023-03-07T17:32:19.232| |
| | 3|SchemaRegion|Running|root.sg2| 1| 0| 2| 127.0.0.1| 6668| Leader|2023-03-07T17:32:19.450| |
| | 3|SchemaRegion|Running|root.sg2| 1| 0| 3| 127.0.0.1| 6669|Follower|2023-03-07T17:32:19.637| |
| +--------+------------+-------+--------+-------------+-----------+----------+----------+-------+--------+-----------------------+ |
| Total line number = 6 |
| It costs 0.009s |
| ``` |
| |
| Show Region distribution on specified Nodes: |
| ``` |
| IoTDB> show regions on nodeid 1 |
| +--------+------------+-------+--------+-------------+-----------+----------+----------+-------+--------+-----------------------+ |
| |RegionId| Type| Status|Database|SeriesSlotNum|TimeSlotNum|DataNodeId|RpcAddress|RpcPort| Role| CreateTime| |
| +--------+------------+-------+--------+-------------+-----------+----------+----------+-------+--------+-----------------------+ |
| | 0| DataRegion|Running|root.sg1| 1| 1| 1| 127.0.0.1| 6667|Follower|2023-03-07T17:32:18.520| |
| | 1|SchemaRegion|Running|root.sg1| 1| 0| 1| 127.0.0.1| 6667|Follower|2023-03-07T17:32:18.111| |
| | 2| DataRegion|Running|root.sg2| 1| 1| 1| 127.0.0.1| 6667| Leader|2023-03-07T17:32:19.834| |
| | 3|SchemaRegion|Running|root.sg2| 1| 0| 1| 127.0.0.1| 6667|Follower|2023-03-07T17:32:19.232| |
| +--------+------------+-------+--------+-------------+-----------+----------+----------+-------+--------+-----------------------+ |
| Total line number = 4 |
| It costs 0.165s |
| |
| IoTDB> show regions on nodeid 1, 2 |
| +--------+------------+-------+--------+-------------+-----------+----------+----------+-------+--------+-----------------------+ |
| |RegionId| Type| Status|Database|SeriesSlotNum|TimeSlotNum|DataNodeId|RpcAddress|RpcPort| Role| CreateTime| |
| +--------+------------+-------+--------+-------------+-----------+----------+----------+-------+--------+-----------------------+ |
| | 0| DataRegion|Running|root.sg1| 1| 1| 1| 127.0.0.1| 6667|Follower|2023-03-07T17:32:18.520| |
| | 0| DataRegion|Running|root.sg1| 1| 1| 2| 127.0.0.1| 6668| Leader|2023-03-07T17:32:18.749| |
| | 1|SchemaRegion|Running|root.sg1| 1| 0| 1| 127.0.0.1| 6667|Follower|2023-03-07T17:32:18.111| |
| | 1|SchemaRegion|Running|root.sg1| 1| 0| 2| 127.0.0.1| 6668|Follower|2023-03-07T17:32:18.245| |
| | 2| DataRegion|Running|root.sg2| 1| 1| 1| 127.0.0.1| 6667| Leader|2023-03-07T17:32:19.834| |
| | 2| DataRegion|Running|root.sg2| 1| 1| 2| 127.0.0.1| 6668|Follower|2023-03-07T17:32:19.011| |
| | 3|SchemaRegion|Running|root.sg2| 1| 0| 1| 127.0.0.1| 6667|Follower|2023-03-07T17:32:19.232| |
| | 3|SchemaRegion|Running|root.sg2| 1| 0| 2| 127.0.0.1| 6668| Leader|2023-03-07T17:32:19.450| |
| +--------+------------+-------+--------+-------------+-----------+----------+----------+-------+--------+-----------------------+ |
| Total line number = 8 |
| It costs 0.165s |
| ``` |
| |
| Show Region distribution of specified StorageGroups on specified Nodes： |
| ``` |
| IoTDB> show regions of database root.sg1 on nodeid 1 |
| +--------+------------+-------+--------+-------------+-----------+----------+----------+-------+--------+-----------------------+ |
| |RegionId| Type| Status|Database|SeriesSlotNum|TimeSlotNum|DataNodeId|RpcAddress|RpcPort| Role| CreateTime| |
| +--------+------------+-------+--------+-------------+-----------+----------+----------+-------+--------+-----------------------+ |
| | 0| DataRegion|Running|root.sg1| 1| 1| 1| 127.0.0.1| 6667|Follower|2023-03-07T17:32:18.520| |
| | 1|SchemaRegion|Running|root.sg1| 1| 0| 1| 127.0.0.1| 6667|Follower|2023-03-07T17:32:18.111| |
| +--------+------------+-------+--------+-------------+-----------+----------+----------+-------+--------+-----------------------+ |
| Total line number = 2 |
| It costs 0.165s |
| |
| IoTDB> show data regions of database root.sg1, root.sg2 on nodeid 1, 2 |
| +--------+------------+-------+--------+-------------+-----------+----------+----------+-------+--------+-----------------------+ |
| |RegionId| Type| Status|Database|SeriesSlotNum|TimeSlotNum|DataNodeId|RpcAddress|RpcPort| Role| CreateTime| |
| +--------+------------+-------+--------+-------------+-----------+----------+----------+-------+--------+-----------------------+ |
| | 0| DataRegion|Running|root.sg1| 1| 1| 1| 127.0.0.1| 6667|Follower|2023-03-07T17:32:18.520| |
| | 0| DataRegion|Running|root.sg1| 1| 1| 2| 127.0.0.1| 6668| Leader|2023-03-07T17:32:18.749| |
| | 2| DataRegion|Running|root.sg2| 1| 1| 1| 127.0.0.1| 6667| Leader|2023-03-07T17:32:19.834| |
| | 2| DataRegion|Running|root.sg2| 1| 1| 2| 127.0.0.1| 6668|Follower|2023-03-07T17:32:19.011| |
| +--------+------------+-------+--------+-------------+-----------+----------+----------+-------+--------+-----------------------+ |
| Total line number = 4 |
| It costs 0.165s |
| ``` |
| |
| |
| ### Region status definition |
| Region inherits the status of the DataNode where the Region resides. And Region states are defined as follows: |
| |
| - **Running**: The DataNode where the Region resides is running properly, the Region is readable and writable. |
| - **Unknown**: The DataNode where the Region resides doesn't report heartbeat properly, the ConfigNode considers the Region is unreadable and un-writable. |
| - **Removing**: The DataNode where the Region resides is being removed from the cluster, the Region is unreadable and un-writable. |
| - **ReadOnly**: The available disk space of the DataNode where the Region resides is lower than the disk_warning_threshold(5% by default). The Region is readable but un-writable and cannot synchronize data. |
| |
| **The status switchover of a Region doesn't affect the belonged RegionGroup**, |
| when setting up a multi-replica cluster(i.e. the number of schema replica and data replica is greater than 1), |
| other Running Regions of the same RegionGroup ensure the high availability of RegionGroup. |
| |
| **For a RegionGroup:** |
| - It's readable, writable and deletable if and only if more than half of its Regions are Running |
| - It's unreadable, un-writable and un-deletable when the number of its Running Regions is less than half |
| |
| ## Show cluster slots information |
| |
| The cluster uses partitions for schema and data arrangement, the partition defined as follows: |
| |
| - `SchemaPartition`: SeriesSlot |
| - `DataPartition`: <SeriesSlot, SeriesTimeSlot> |
| |
| More details can be found in the [Cluster-Concept](./Cluster-Concept.md) document. |
| |
| The cluster slots information can be shown by the following SQLs: |
| |
| ### Show the DataRegion where a DataPartition resides in |
| |
| Show the DataRegion where a DataPartition of a certain database or device resides in: |
| |
| - `SHOW DATA REGIONID WHERE (DATABASE=root.xxx |DEVICE=root.xxx.xxx) (AND TIME=xxxxx)?` |
| |
| Specifications: |
| |
| 1. "DEVICE" corresponds to a unique SeriesSlot for the device path, while "TIME" corresponds to a unique SeriesTimeSlot for either a timestamp or a universal time. |
| |
| 2. "DATABASE" and "DEVICE" must begin with "root". If the path does not exist, it will return empty instead of reporting an error, as will be seen below. |
| |
| 3. Currently, "DATABASE" and "DEVICE" do not support wildcard matching or multiple queries. If it contains a wildcard character(such as * or **) or multiple DATABASE and DEVICE, an error will be reported, as will be seen below. |
| |
| 4. "TIME" supports both timestamps and universal dates. For timestamp, it must be greater than or equal to 0. For universal time, it need to be no earlier than 1970-01-01 00:00:00. |
| |
| Eg: |
| ``` |
| IoTDB> show data regionid where device=root.sg.m1.d1 |
| +--------+ |
| |RegionId| |
| +--------+ |
| | 1| |
| | 2| |
| +--------+ |
| Total line number = 2 |
| It costs 0.006s |
| |
| IoTDB> show data regionid where device=root.sg.m1.d1 and time=604800000 |
| +--------+ |
| |RegionId| |
| +--------+ |
| | 1| |
| +--------+ |
| Total line number = 1 |
| It costs 0.006s |
| |
| IoTDB> show data regionid where device=root.sg.m1.d1 and time=1970-01-08T00:00:00.000 |
| +--------+ |
| |RegionId| |
| +--------+ |
| | 1| |
| +--------+ |
| Total line number = 1 |
| It costs 0.006s |
| |
| IoTDB> show data regionid where database=root.sg |
| +--------+ |
| |RegionId| |
| +--------+ |
| | 1| |
| | 2| |
| +--------+ |
| Total line number = 2 |
| It costs 0.006s |
| |
| IoTDB> show data regionid where database=root.sg and time=604800000 |
| +--------+ |
| |RegionId| |
| +--------+ |
| | 1| |
| +--------+ |
| Total line number = 1 |
| It costs 0.006s |
| |
| IoTDB> show data regionid where database=root.sg and time=1970-01-08T00:00:00.000 |
| +--------+ |
| |RegionId| |
| +--------+ |
| | 1| |
| +--------+ |
| Total line number = 1 |
| It costs 0.006s |
| ``` |
| |
| ### Show the SchemaRegion where a SchemaPartition resides in |
| |
| Show the SchemaRegion where a DataPartition of a certain database or device resides in: |
| |
| - `SHOW SCHEMA REGIONID WHERE (DATABASE=root.xxx | DEVICE=root.xxx.xxx)` |
| |
| Eg: |
| ``` |
| IoTDB> show schema regionid where device=root.sg.m1.d2 |
| +--------+ |
| |RegionId| |
| +--------+ |
| | 0| |
| +--------+ |
| Total line number = 1 |
| It costs 0.007s |
| |
| IoTDB> show schema regionid where database=root.sg |
| +--------+ |
| |RegionId| |
| +--------+ |
| | 0| |
| +--------+ |
| Total line number = 1 |
| It costs 0.007s |
| ``` |
| |
| ### Show Database's series slots |
| |
| Show the data/schema series slots related to a database: |
| - `SHOW (DATA|SCHEMA) SERIESSLOTID WHERE DATABASE=root.xxx` |
| |
| Eg: |
| ``` |
| IoTDB> show data seriesslotid where database = root.sg |
| +------------+ |
| |SeriesSlotId| |
| +------------+ |
| | 5286| |
| +------------+ |
| Total line number = 1 |
| It costs 0.007s |
| |
| IoTDB> show schema seriesslotid where database = root.sg |
| +------------+ |
| |SeriesSlotId| |
| +------------+ |
| | 5286| |
| +------------+ |
| Total line number = 1 |
| It costs 0.006s |
| ``` |
| |
| ### Show the time partition under filtering conditions. |
| |
| Show the TimePartition of a certain device, database, or DataRegion. |
| |
| - `SHOW TIMEPARTITION WHERE (DEVICE=root.a.b |REGIONID = r0 | DATABASE=root.xxx) (AND STARTTIME=t1)?(AND ENDTIME=t2)?` |
| |
| Specifications: |
| |
| 1. TimePartition is short for SeriesTimeSlotId. |
| 2. If REGIONID is the Id of schemaRegion, return empty instead of reporting an error. |
| 3. REGIONID do not support multiple queries. If it contains multiple REGIONID, an error will be reported, as will be seen below. |
| 4. "STARTTIME" and "ENDTIME" support both timestamps and universal dates. For timestamp, it must be greater than or equal to 0. For universal time, it need to be no earlier than 1970-01-01 00:00:00. |
| 5. The StartTime in the returned result is the starting time of the TimePartition's corresponding time interval. |
| |
| Eg: |
| ``` |
| IoTDB> show timePartition where device=root.sg.m1.d1 |
| +-------------------------------------+ |
| |TimePartition| StartTime| |
| +-------------------------------------+ |
| | 0|1970-01-01T00:00:00.000| |
| +-------------------------------------+ |
| Total line number = 1 |
| It costs 0.007s |
| |
| IoTDB> show timePartition where regionId = 1 |
| +-------------------------------------+ |
| |TimePartition| StartTime| |
| +-------------------------------------+ |
| | 0|1970-01-01T00:00:00.000| |
| +-------------------------------------+ |
| Total line number = 1 |
| It costs 0.007s |
| |
| IoTDB> show timePartition where database = root.sg |
| +-------------------------------------+ |
| |TimePartition| StartTime| |
| +-------------------------------------+ |
| | 0|1970-01-01T00:00:00.000| |
| +-------------------------------------+ |
| | 1|1970-01-08T00:00:00.000| |
| +-------------------------------------+ |
| Total line number = 2 |
| It costs 0.007s |
| ``` |
| #### Count the time partition under filtering conditions. |
| |
| Count the TimePartition of a certain device, database, or DataRegion. |
| |
| - `COUNT TIMEPARTITION WHERE (DEVICE=root.a.b |REGIONID = r0 | DATABASE=root.xxx) (AND STARTTIME=t1)?(AND ENDTIME=t2)?` |
| |
| ``` |
| IoTDB> count timePartition where device=root.sg.m1.d1 |
| +--------------------+ |
| |count(timePartition)| |
| +--------------------+ |
| | 1| |
| +--------------------+ |
| Total line number = 1 |
| It costs 0.007s |
| |
| IoTDB> count timePartition where regionId = 1 |
| +--------------------+ |
| |count(timePartition)| |
| +--------------------+ |
| | 1| |
| +--------------------+ |
| Total line number = 1 |
| It costs 0.007s |
| |
| IoTDB> count timePartition where database = root.sg |
| +--------------------+ |
| |count(timePartition)| |
| +--------------------+ |
| | 2| |
| +--------------------+ |
| Total line number = 1 |
| It costs 0.007s |
| ``` |
| |
| |
| ## Migrate Region |
| The following sql can be applied to manually migrate a region, for load balancing or other purposes. |
| ``` |
| MIGRATE REGION <Region-id> FROM <original-DataNodeId> TO <dest-DataNodeId> |
| ``` |
| Eg: |
| ``` |
| IoTDB> SHOW REGIONS |
| +--------+------------+-------+-------------+------------+----------+----------+----------+-------+--------+ |
| |RegionId| Type| Status| Database|SeriesSlotId|TimeSlotId|DataNodeId|RpcAddress|RpcPort| Role| |
| +--------+------------+-------+-------------+------------+----------+----------+----------+-------+--------+ |
| | 0|SchemaRegion|Running|root.test.g_0| 500| 0| 3| 127.0.0.1| 6670| Leader| |
| | 0|SchemaRegion|Running|root.test.g_0| 500| 0| 4| 127.0.0.1| 6681|Follower| |
| | 0|SchemaRegion|Running|root.test.g_0| 500| 0| 5| 127.0.0.1| 6668|Follower| |
| | 1| DataRegion|Running|root.test.g_0| 183| 200| 1| 127.0.0.1| 6667|Follower| |
| | 1| DataRegion|Running|root.test.g_0| 183| 200| 3| 127.0.0.1| 6670|Follower| |
| | 1| DataRegion|Running|root.test.g_0| 183| 200| 7| 127.0.0.1| 6669| Leader| |
| | 2| DataRegion|Running|root.test.g_0| 181| 200| 3| 127.0.0.1| 6670| Leader| |
| | 2| DataRegion|Running|root.test.g_0| 181| 200| 4| 127.0.0.1| 6681|Follower| |
| | 2| DataRegion|Running|root.test.g_0| 181| 200| 5| 127.0.0.1| 6668|Follower| |
| | 3| DataRegion|Running|root.test.g_0| 180| 200| 1| 127.0.0.1| 6667|Follower| |
| | 3| DataRegion|Running|root.test.g_0| 180| 200| 5| 127.0.0.1| 6668| Leader| |
| | 3| DataRegion|Running|root.test.g_0| 180| 200| 7| 127.0.0.1| 6669|Follower| |
| | 4| DataRegion|Running|root.test.g_0| 179| 200| 3| 127.0.0.1| 6670|Follower| |
| | 4| DataRegion|Running|root.test.g_0| 179| 200| 4| 127.0.0.1| 6681| Leader| |
| | 4| DataRegion|Running|root.test.g_0| 179| 200| 7| 127.0.0.1| 6669|Follower| |
| | 5| DataRegion|Running|root.test.g_0| 179| 200| 1| 127.0.0.1| 6667| Leader| |
| | 5| DataRegion|Running|root.test.g_0| 179| 200| 4| 127.0.0.1| 6681|Follower| |
| | 5| DataRegion|Running|root.test.g_0| 179| 200| 5| 127.0.0.1| 6668|Follower| |
| +--------+------------+-------+-------------+------------+----------+----------+----------+-------+--------+ |
| Total line number = 18 |
| It costs 0.161s |
| |
| IoTDB> MIGRATE REGION 1 FROM 3 TO 4 |
| Msg: The statement is executed successfully. |
| |
| IoTDB> SHOW REGIONS |
| +--------+------------+-------+-------------+------------+----------+----------+----------+-------+--------+ |
| |RegionId| Type| Status| Database|SeriesSlotId|TimeSlotId|DataNodeId|RpcAddress|RpcPort| Role| |
| +--------+------------+-------+-------------+------------+----------+----------+----------+-------+--------+ |
| | 0|SchemaRegion|Running|root.test.g_0| 500| 0| 3| 127.0.0.1| 6670| Leader| |
| | 0|SchemaRegion|Running|root.test.g_0| 500| 0| 4| 127.0.0.1| 6681|Follower| |
| | 0|SchemaRegion|Running|root.test.g_0| 500| 0| 5| 127.0.0.1| 6668|Follower| |
| | 1| DataRegion|Running|root.test.g_0| 183| 200| 1| 127.0.0.1| 6667|Follower| |
| | 1| DataRegion|Running|root.test.g_0| 183| 200| 4| 127.0.0.1| 6681|Follower| |
| | 1| DataRegion|Running|root.test.g_0| 183| 200| 7| 127.0.0.1| 6669| Leader| |
| | 2| DataRegion|Running|root.test.g_0| 181| 200| 3| 127.0.0.1| 6670| Leader| |
| | 2| DataRegion|Running|root.test.g_0| 181| 200| 4| 127.0.0.1| 6681|Follower| |
| | 2| DataRegion|Running|root.test.g_0| 181| 200| 5| 127.0.0.1| 6668|Follower| |
| | 3| DataRegion|Running|root.test.g_0| 180| 200| 1| 127.0.0.1| 6667|Follower| |
| | 3| DataRegion|Running|root.test.g_0| 180| 200| 5| 127.0.0.1| 6668| Leader| |
| | 3| DataRegion|Running|root.test.g_0| 180| 200| 7| 127.0.0.1| 6669|Follower| |
| | 4| DataRegion|Running|root.test.g_0| 179| 200| 3| 127.0.0.1| 6670|Follower| |
| | 4| DataRegion|Running|root.test.g_0| 179| 200| 4| 127.0.0.1| 6681| Leader| |
| | 4| DataRegion|Running|root.test.g_0| 179| 200| 7| 127.0.0.1| 6669|Follower| |
| | 5| DataRegion|Running|root.test.g_0| 179| 200| 1| 127.0.0.1| 6667| Leader| |
| | 5| DataRegion|Running|root.test.g_0| 179| 200| 4| 127.0.0.1| 6681|Follower| |
| | 5| DataRegion|Running|root.test.g_0| 179| 200| 5| 127.0.0.1| 6668|Follower| |
| +--------+------------+-------+-------------+------------+----------+----------+----------+-------+--------+ |
| Total line number = 18 |
| It costs 0.165s |
| ``` |
