Skip to content

add two methods of showing services to systemtable and maintenance fr… #998

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
leto-b wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add two methods of showing services to systemtable and maintenance fr… #998

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
57 changes: 41 additions & 16 deletions src/UserGuide/Master/Table/Reference/System-Tables_apache.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ IoTDB> show tables from information_schema
| queries| INF|
|queries_costs_histogram| INF|
| regions| INF|
| services| INF|
| subscriptions| INF|
| tables| INF|
| topics| INF|
Expand All @@ -66,7 +67,7 @@ IoTDB> show tables from information_schema

## 2. System Tables

* ​**Names**​: `DATABASES`, `TABLES`, `REGIONS`, `QUERIES`, `COLUMNS`, `PIPES`, `PIPE_PLUGINS`, `SUBSCRIPTION`, `TOPICS`, `VIEWS`, `MODELS`, `FUNCTIONS`, `CONFIGURATIONS`, `KEYWORDS`, `NODES`, `CONFIG_NODES`, `DATA_NODES` , `CONNECTIONS`, `CURRENT_QUERIES`, `QUERIES_COSTS_HISTOGRAM` (detailed descriptions in later sections)
* ​**Names**​: `DATABASES`, `TABLES`, `REGIONS`, `QUERIES`, `COLUMNS`, `PIPES`, `PIPE_PLUGINS`, `SUBSCRIPTION`, `TOPICS`, `VIEWS`, `MODELS`, `FUNCTIONS`, `CONFIGURATIONS`, `KEYWORDS`, `NODES`, `CONFIG_NODES`, `DATA_NODES` , `CONNECTIONS`, `CURRENT_QUERIES`, `QUERIES_COSTS_HISTOGRAM`, `SERVICES` (detailed descriptions in later sections)
* ​**Operations**​: Read-only, only supports `SELECT`, `COUNT/SHOW DEVICES`, `DESC`. Any modifications to table structure or content are not allowed and will result in an error: `"The database 'information_schema' can only be queried." `
* ​**Column Names**​: System table column names are all lowercase by default and separated by underscores (`_`).

Expand Down Expand Up @@ -343,7 +344,7 @@ IoTDB> select * from information_schema.topics
+----------+----------------------------------------------------------------+
```

### 2.10 VIEWS Table
### 2.10 VIEWS

> This system table is available starting from version V2.0.5.

Expand All @@ -369,9 +370,9 @@ IoTDB> select * from information_schema.views
```


### 2.11 MODELS Table
### 2.11 MODELS

> This system table is available starting from version V 2.0.5 and has been discontinued since version V 2.0.8.
> This system table is available starting from version V 2.0.5 and has been discontinued since version V 2.0.8-beta.

* Contains information about all models in the database.
* The table structure is as follows:
Expand Down Expand Up @@ -402,7 +403,7 @@ IoTDB> select * from information_schema.models where model_type = 'BUILT_IN_FORE
```


### 2.12 FUNCTIONS Table
### 2.12 FUNCTIONS

> This system table is available starting from version V2.0.5.

Expand Down Expand Up @@ -434,7 +435,7 @@ IoTDB> select * from information_schema.functions where function_type='built-in
```


### 2.13 CONFIGURATIONS Table
### 2.13 CONFIGURATIONS

> This system table is available starting from version V2.0.5.

Expand Down Expand Up @@ -473,7 +474,7 @@ IoTDB> select * from information_schema.configurations
```


### 2.14 KEYWORDS Table
### 2.14 KEYWORDS

> This system table is available starting from version V2.0.5.

Expand Down Expand Up @@ -506,7 +507,7 @@ IoTDB> select * from information_schema.keywords limit 10
```


### 2.15 NODES Table
### 2.15 NODES

> This system table is available starting from version V2.0.5.

Expand Down Expand Up @@ -538,7 +539,7 @@ IoTDB> select * from information_schema.nodes
```


### 2.16 CONFIG\_NODES Table
### 2.16 CONFIG\_NODES

> This system table is available starting from version V2.0.5.

Expand All @@ -564,7 +565,7 @@ IoTDB> select * from information_schema.config_nodes
```


### 2.17 DATA\_NODES Table
### 2.17 DATA\_NODES

> This system table is available starting from version V2.0.5.

Expand Down Expand Up @@ -594,9 +595,9 @@ IoTDB> select * from information_schema.data_nodes
+-------+---------------+-----------------+-----------+--------+--------+-------------------+---------------------+
```

### 2.18 CONNECTIONS Table
### 2.18 CONNECTIONS

> This system table is available starting from version V 2.0.8
> This system table is available starting from version V 2.0.8-beta

* Contains all connections in the cluster.
* The table structure is as follows:
Expand All @@ -621,9 +622,9 @@ IoTDB> select * from information_schema.connections;
+-----------+-------+----------+---------+-----------------------------+---------+
```

### 2.19 CURRENT_QUERIES Table
### 2.19 CURRENT_QUERIES

> This system table is available starting from version V 2.0.8
> This system table is available starting from version V 2.0.8-beta

* Contains all queries whose execution end time falls within the range `[now() - query_cost_stat_window, now())`, including currently executing queries. The `query_cost_stat_window` parameter represents the query cost statistics window. Its default value is 0 and can be configured via the `iotdb-system.properties` configuration file.
* The table structure is as follows:
Expand Down Expand Up @@ -652,9 +653,9 @@ IoTDB> select * from information_schema.current_queries;
+-----------------------+-------+-----------------------------+--------+-----------+---------+------------------------------------------------+----+---------+
```

### 2.20 QUERIES_COSTS_HISTOGRAM Table
### 2.20 QUERIES_COSTS_HISTOGRAM

> This system table is available starting from version V 2.0.8
> This system table is available starting from version V 2.0.8-beta

* Contains a histogram of query execution times within the past `query_cost_stat_window` period (only statistics for completed SQL queries). The `query_cost_stat_window` parameter represents the query cost statistics window. Its default value is 0 and can be configured via the `iotdb-system.properties` configuration file.
* The table structure is as follows:
Expand Down Expand Up @@ -686,6 +687,30 @@ IoTDB> select * from information_schema.queries_costs_histogram limit 10
+------+----+-----------+
```

### 2.21 SERVICES

> This system table is available starting from version V 2.0.8-beta

* Displays services (MQTT service, REST service) on all active DataNodes (with RUNNING or READ-ONLY status).
* Table structure:

| Column Name | Data Type | Column Type | Description |
|---------------|-----------|-------------|---------------------------------|
| service_name | STRING | TAG | Service Name |
| datanode_id | INT32 | ATTRIBUTE | DataNode ID where service runs |
| state | STRING | ATTRIBUTE | Service status: RUNNING/STOPPED |

* Query example:
```sql
IoTDB> SELECT * FROM information_schema.services
+------------+-----------+---------+
|service_name|datanode_id|state |
+------------+-----------+---------+
|MQTT |1 |STOPPED |
|REST |1 |RUNNING |
+------------+-----------+---------+
```


## 3. Permission Description

Expand Down
57 changes: 41 additions & 16 deletions src/UserGuide/Master/Table/Reference/System-Tables_timecho.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ IoTDB> show tables from information_schema
| queries| INF|
|queries_costs_histogram| INF|
| regions| INF|
| services| INF|
| subscriptions| INF|
| tables| INF|
| topics| INF|
Expand All @@ -66,7 +67,7 @@ IoTDB> show tables from information_schema

## 2. System Tables

* ​**Names**​: `DATABASES`, `TABLES`, `REGIONS`, `QUERIES`, `COLUMNS`, `PIPES`, `PIPE_PLUGINS`, `SUBSCRIPTION`, `TOPICS`, `VIEWS`, `MODELS`, `FUNCTIONS`, `CONFIGURATIONS`, `KEYWORDS`, `NODES`, `CONFIG_NODES`, `DATA_NODES`, `CONNECTIONS`, `CURRENT_QUERIES`, `QUERIES_COSTS_HISTOGRAM` (detailed descriptions in later sections)
* ​**Names**​: `DATABASES`, `TABLES`, `REGIONS`, `QUERIES`, `COLUMNS`, `PIPES`, `PIPE_PLUGINS`, `SUBSCRIPTION`, `TOPICS`, `VIEWS`, `MODELS`, `FUNCTIONS`, `CONFIGURATIONS`, `KEYWORDS`, `NODES`, `CONFIG_NODES`, `DATA_NODES`, `CONNECTIONS`, `CURRENT_QUERIES`, `QUERIES_COSTS_HISTOGRAM`, `SERVICES` (detailed descriptions in later sections)
* ​**Operations**​: Read-only, only supports `SELECT`, `COUNT/SHOW DEVICES`, `DESC`. Any modifications to table structure or content are not allowed and will result in an error: `"The database 'information_schema' can only be queried." `
* ​**Column Names**​: System table column names are all lowercase by default and separated by underscores (`_`).

Expand Down Expand Up @@ -343,7 +344,7 @@ IoTDB> select * from information_schema.topics
+----------+----------------------------------------------------------------+
```

### 2.10 VIEWS Table
### 2.10 VIEWS

> This system table is available starting from version V2.0.5.

Expand All @@ -369,9 +370,9 @@ IoTDB> select * from information_schema.views
```


### 2.11 MODELS Table
### 2.11 MODELS

> This system table is available starting from version V 2.0.5 and has been discontinued since version V 2.0.8.
> This system table is available starting from version V 2.0.5 and has been discontinued since version V 2.0.8-beta.

* Contains information about all models in the database.
* The table structure is as follows:
Expand Down Expand Up @@ -402,7 +403,7 @@ IoTDB> select * from information_schema.models where model_type = 'BUILT_IN_FORE
```


### 2.12 FUNCTIONS Table
### 2.12 FUNCTIONS

> This system table is available starting from version V2.0.5.

Expand Down Expand Up @@ -434,7 +435,7 @@ IoTDB> select * from information_schema.functions where function_type='built-in
```


### 2.13 CONFIGURATIONS Table
### 2.13 CONFIGURATIONS

> This system table is available starting from version V2.0.5.

Expand Down Expand Up @@ -473,7 +474,7 @@ IoTDB> select * from information_schema.configurations
```


### 2.14 KEYWORDS Table
### 2.14 KEYWORDS

> This system table is available starting from version V2.0.5.

Expand Down Expand Up @@ -506,7 +507,7 @@ IoTDB> select * from information_schema.keywords limit 10
```


### 2.15 NODES Table
### 2.15 NODES

> This system table is available starting from version V2.0.5.

Expand Down Expand Up @@ -538,7 +539,7 @@ IoTDB> select * from information_schema.nodes
```


### 2.16 CONFIG\_NODES Table
### 2.16 CONFIG\_NODES

> This system table is available starting from version V2.0.5.

Expand All @@ -564,7 +565,7 @@ IoTDB> select * from information_schema.config_nodes
```


### 2.17 DATA\_NODES Table
### 2.17 DATA\_NODES

> This system table is available starting from version V2.0.5.

Expand Down Expand Up @@ -594,9 +595,9 @@ IoTDB> select * from information_schema.data_nodes
+-------+---------------+-----------------+-----------+--------+--------+-------------------+---------------------+
```

### 2.18 CONNECTIONS Table
### 2.18 CONNECTIONS

> This system table is available starting from version V 2.0.8
> This system table is available starting from version V 2.0.8-beta

* Contains all connections in the cluster.
* The table structure is as follows:
Expand All @@ -621,9 +622,9 @@ IoTDB> select * from information_schema.connections;
+-----------+-------+----------+---------+-----------------------------+---------+
```

### 2.19 CURRENT_QUERIES Table
### 2.19 CURRENT_QUERIES

> This system table is available starting from version V 2.0.8
> This system table is available starting from version V 2.0.8-beta

* Contains all queries whose execution end time falls within the range `[now() - query_cost_stat_window, now())`, including currently executing queries. The `query_cost_stat_window` parameter represents the query cost statistics window. Its default value is 0 and can be configured via the `iotdb-system.properties` configuration file.
* The table structure is as follows:
Expand Down Expand Up @@ -652,9 +653,9 @@ IoTDB> select * from information_schema.current_queries;
+-----------------------+-------+-----------------------------+--------+-----------+---------+------------------------------------------------+----+---------+
```

### 2.20 QUERIES_COSTS_HISTOGRAM Table
### 2.20 QUERIES_COSTS_HISTOGRAM

> This system table is available starting from version V 2.0.8
> This system table is available starting from version V 2.0.8-beta

* Contains a histogram of query execution times within the past `query_cost_stat_window` period (only statistics for completed SQL queries). The `query_cost_stat_window` parameter represents the query cost statistics window. Its default value is 0 and can be configured via the `iotdb-system.properties` configuration file.
* The table structure is as follows:
Expand Down Expand Up @@ -686,6 +687,30 @@ IoTDB> select * from information_schema.queries_costs_histogram limit 10
+------+----+-----------+
```

### 2.21 SERVICES

> This system table is available starting from version V 2.0.8-beta

* Displays services (MQTT service, REST service) on all active DataNodes (with RUNNING or READ-ONLY status).
* Table structure:

| Column Name | Data Type | Column Type | Description |
|---------------|-----------|-------------|---------------------------------|
| service_name | STRING | TAG | Service Name |
| datanode_id | INT32 | ATTRIBUTE | DataNode ID where service runs |
| state | STRING | ATTRIBUTE | Service status: RUNNING/STOPPED |

* Query example:
```sql
IoTDB> SELECT * FROM information_schema.services
+------------+-----------+---------+
|service_name|datanode_id|state |
+------------+-----------+---------+
|MQTT |1 |STOPPED |
|REST |1 |RUNNING |
+------------+-----------+---------+
```


## 3. Permission Description

Expand Down
30 changes: 29 additions & 1 deletion src/UserGuide/Master/Table/User-Manual/Maintenance-commands_apache.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,7 @@ IoTDB> SHOW REGIONS

**Description**: Returns the RPC addresses and ports of all available DataNodes in the current cluster. Note: A DataNode is considered "available" if it is not in the REMOVING state.

> This feature is supported starting from v2.0.8.
> This feature is supported starting from v2.0.8-beta.

**Syntax**:

Expand All @@ -367,6 +367,34 @@ IoTDB> SHOW AVAILABLE URLS
+----------+-------+
```

### 1.11 View Service Information

**Description**: Returns service information (MQTT service, REST service) on all active DataNodes (in RUNNING or READ-ONLY state) in the current cluster.

> Supported since V2.0.8-beta

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

#### Examples:
```sql
IoTDB> SHOW SERVICES
IoTDB> SHOW SERVICES ON 1
```

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

## 2. Status Setting

Expand Down
Loading