Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/.vuepress/sidebar_timecho/V1.3.x/en.ts
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ export const enSidebar = {
children: [
{ text: 'Query Performance Analysis', link: 'Query-Performance-Analysis' },
{ text: 'Load Balance', link: 'Load-Balance' },
{ text: 'Maintenance statement', link: 'Maintenance-commands_timecho' },
{ text: 'Maintenance statement', link: 'Maintenance-commands' },
],
},
],
Expand Down
2 changes: 1 addition & 1 deletion src/.vuepress/sidebar_timecho/V1.3.x/zh.ts
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ export const zhSidebar = {
children: [
{ text: '查询性能分析', link: 'Query-Performance-Analysis' },
{ text: '负载均衡', link: 'Load-Balance' },
{ text: '运维语句', link: 'Maintenance-statement_timecho' },
{ text: '运维语句', link: 'Maintenance-statement' },
],
},
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,66 @@ IoTDB> SHOW AVAILABLE URLS
+----------+-------+
```

### 1.10 View Service Information

> Supported since V2.0.8.2

**Syntax**:

```sql
showServicesStatement
: SHOW SERVICES <ON dataNodeId>
;
```

**Example**:

```sql
IoTDB> SHOW SERVICES
IoTDB> SHOW SERVICES ON 1
```

**Result**:

```sql
+--------------+-------------+---------+
| Service Name | DataNode ID | State |
+--------------+-------------+---------+
| MQTT | 1 | STOPPED |
| REST | 1 | RUNNING |
+--------------+-------------+---------+
```

### 1.11 View Cluster Activation Status

**Syntax**:

```SQL
showActivationStatement
: SHOW ACTIVATION
;
```

**Example**:

```SQL
IoTDB> SHOW ACTIVATION
```

**Result**:

```SQL
+---------------+---------+-----------------------------+
| LicenseInfo| Usage| Limit|
+---------------+---------+-----------------------------+
| Status|ACTIVATED| -|
| ExpiredTime| -|2026-04-30T00:00:00.000+08:00|
| DataNodeLimit| 1| Unlimited|
| CpuLimit| 16| Unlimited|
| DeviceLimit| 30| Unlimited|
|TimeSeriesLimit| 72| 1,000,000,000|
+---------------+---------+-----------------------------+
```

## 2. Status Configuration

Expand Down Expand Up @@ -373,32 +433,6 @@ localOrClusterMode
IoTDB> FLUSH test_db TRUE ON LOCAL;
```

### 3.2 Clear DataNode Cache

**Syntax:**

```SQL
clearCacheStatement
: CLEAR clearCacheOptions? CACHE localOrClusterMode?
;

clearCacheOptions
: ATTRIBUTE
| QUERY
| ALL
;

localOrClusterMode
: (ON (LOCAL | CLUSTER))
;
```

**Example:**

```SQL
IoTDB> CLEAR ALL CACHE ON LOCAL;
```

## 4. Data Repair

### 4.1 Start Background TsFile Repair
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -396,12 +396,46 @@ Execution result:
+--------------+-------------+---------+
```

### 1.12 View Cluster Activation Status

**Description**:Returns the activation status of the current cluster.

#### Syntax:

```SQL
showActivationStatement
: SHOW ACTIVATION
;
```

#### Examples:

```SQL
IoTDB> SHOW ACTIVATION
```

Execution result:

```SQL
+---------------+---------+-----------------------------+
| LicenseInfo| Usage| Limit|
+---------------+---------+-----------------------------+
| Status|ACTIVATED| -|
| ExpiredTime| -|2026-04-30T00:00:00.000+08:00|
| DataNodeLimit| 1| Unlimited|
| CpuLimit| 16| Unlimited|
| DeviceLimit| 30| Unlimited|
|TimeSeriesLimit| 72| 1,000,000,000|
+---------------+---------+-----------------------------+
```

### 1.13 View Node Configuration

**Description**: By default, returns the effective configuration items from the configuration file of the specified node (identified by `node_id`). If `node_id` is not specified, returns the configuration of the directly connected DataNode.
Adding the `all` parameter returns all configuration items (the `value` of unconfigured items is `null`).
Adding the `with desc` parameter returns configuration items with descriptions.

> Supported since version 2.0.9
> Supported since version 2.0.9.1

#### Syntax:
```SQL
Expand All @@ -419,6 +453,7 @@ showConfigurationStatement
| description | string | Configuration description (optional) |

#### Examples:

1. View configuration of the directly connected DataNode
```SQL
SHOW CONFIGURATION;
Expand Down
5 changes: 4 additions & 1 deletion src/UserGuide/Master/Tree/SQL-Manual/SQL-Manual_timecho.md
Original file line number Diff line number Diff line change
Expand Up @@ -842,7 +842,7 @@ select * into ::(backup_${4}) from root.sg.** align by device;
select s1, s2 into root.sg_copy.d1(t1, t2), aligned root.sg_copy.d2(t1, t2) from root.sg.d1, root.sg.d2 align by device;
```

## 7. Maintennance
## 7. Maintenance
Generate the corresponding query plan:
```sql
explain select s1,s2 from root.sg.d1;
Expand All @@ -851,6 +851,9 @@ Execute the corresponding SQL, analyze the execution and output:
```sql
explain analyze select s1,s2 from root.sg.d1 order by s1;
```

For more Maintenance commands, please refer to[Maintenance commands](../User-Manual/Maintenance-commands_timecho.md)

## 8. OPERATOR

For more details, see document [Operator-and-Expression](./Operator-and-Expression.md).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -302,12 +302,46 @@ Execution result:
+--------------+-------------+---------+
```

### 1.9 View Disk Space Usage
### 1.9 View Cluster Activation Status

**Description**:Returns the activation status of the current cluster.

#### Syntax:

```SQL
showActivationStatement
: SHOW ACTIVATION
;
```

#### Examples:

```SQL
IoTDB> SHOW ACTIVATION
```

Execution result:

```SQL
+---------------+---------+-----------------------------+
| LicenseInfo| Usage| Limit|
+---------------+---------+-----------------------------+
| Status|ACTIVATED| -|
| ExpiredTime| -|2026-04-30T00:00:00.000+08:00|
| DataNodeLimit| 1| Unlimited|
| CpuLimit| 16| Unlimited|
| DeviceLimit| 30| Unlimited|
|TimeSeriesLimit| 72| 1,000,000,000|
+---------------+---------+-----------------------------+
```

### 1.10 View Disk Space Usage

**Description**: Returns the disk space usage of the specified `pattern`, including the size of ChunkGroups and the size of Metadata.

**Note**: Statistics are based on the actual size of data in TsFiles; therefore, deletions made via `mods` are not considered.

> Supported since version 2.0.9
> Supported since version 2.0.9.1

#### Syntax:
```sql
Expand All @@ -325,6 +359,7 @@ pathPattern
**Explanation**: The `pattern` is used to match devices, must start with `ROOT`, and intermediate nodes in the path support `*` or `**`.

#### Result Set

| Column Name | Column Type | Description |
|---------------|-------------|----------------------------------|
| Database | string | Database name |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,66 @@ IoTDB> SHOW AVAILABLE URLS
+----------+-------+
```

### 1.10 View Service Information

> Supported since V2.0.8.2

**Syntax**:

```sql
showServicesStatement
: SHOW SERVICES <ON dataNodeId>
;
```

**Example**:

```sql
IoTDB> SHOW SERVICES
IoTDB> SHOW SERVICES ON 1
```

**Result**:

```sql
+--------------+-------------+---------+
| Service Name | DataNode ID | State |
+--------------+-------------+---------+
| MQTT | 1 | STOPPED |
| REST | 1 | RUNNING |
+--------------+-------------+---------+
```

### 1.11 View Cluster Activation Status

**Syntax**:

```SQL
showActivationStatement
: SHOW ACTIVATION
;
```

**Example**:

```SQL
IoTDB> SHOW ACTIVATION
```

**Result**:

```SQL
+---------------+---------+-----------------------------+
| LicenseInfo| Usage| Limit|
+---------------+---------+-----------------------------+
| Status|ACTIVATED| -|
| ExpiredTime| -|2026-04-30T00:00:00.000+08:00|
| DataNodeLimit| 1| Unlimited|
| CpuLimit| 16| Unlimited|
| DeviceLimit| 30| Unlimited|
|TimeSeriesLimit| 72| 1,000,000,000|
+---------------+---------+-----------------------------+
```

## 2. Status Configuration

Expand Down Expand Up @@ -373,32 +433,6 @@ localOrClusterMode
IoTDB> FLUSH test_db TRUE ON LOCAL;
```

### 3.2 Clear DataNode Cache

**Syntax:**

```SQL
clearCacheStatement
: CLEAR clearCacheOptions? CACHE localOrClusterMode?
;

clearCacheOptions
: ATTRIBUTE
| QUERY
| ALL
;

localOrClusterMode
: (ON (LOCAL | CLUSTER))
;
```

**Example:**

```SQL
IoTDB> CLEAR ALL CACHE ON LOCAL;
```

## 4. Data Repair

### 4.1 Start Background TsFile Repair
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -396,12 +396,45 @@ Execution result:
+--------------+-------------+---------+
```

### 1.12 View Cluster Activation Status

**Description**:Returns the activation status of the current cluster.

#### Syntax:

```SQL
showActivationStatement
: SHOW ACTIVATION
;
```

#### Examples:

```SQL
IoTDB> SHOW ACTIVATION
```

Execution result:

```SQL
+---------------+---------+-----------------------------+
| LicenseInfo| Usage| Limit|
+---------------+---------+-----------------------------+
| Status|ACTIVATED| -|
| ExpiredTime| -|2026-04-30T00:00:00.000+08:00|
| DataNodeLimit| 1| Unlimited|
| CpuLimit| 16| Unlimited|
| DeviceLimit| 30| Unlimited|
|TimeSeriesLimit| 72| 1,000,000,000|
+---------------+---------+-----------------------------+
```

### 1.13 View Node Configuration
**Description**: By default, returns the effective configuration items from the configuration file of the specified node (identified by `node_id`). If `node_id` is not specified, returns the configuration of the directly connected DataNode.
Adding the `all` parameter returns all configuration items (the `value` of unconfigured items is `null`).
Adding the `with desc` parameter returns configuration items with descriptions.

> Supported since version 2.0.9
> Supported since version 2.0.9.1

#### Syntax:
```SQL
Expand Down
Loading