Skip to content

add table_disk_usage from 2091 #1084

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 table_disk_usage from 2091 #1084

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
78 changes: 77 additions & 1 deletion 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 @@ -59,6 +59,7 @@ IoTDB> show tables from information_schema
| regions| INF|
| services| INF|
| subscriptions| INF|
| table_disk_usage| INF|
| tables| INF|
| topics| INF|
| views| INF|
Expand All @@ -67,7 +68,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`, `SERVICES` (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`, `TABLE_DISK_USAGE` (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 @@ -713,6 +714,81 @@ IoTDB> SELECT * FROM information_schema.services
+------------+-----------+---------+
```

##### 2.22 TABLE_DISK_USAGE
> This system table is available since version V2.0.9-beta

Used to display the disk space usage of specified tables (excluding views), 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.

The table structure is shown below:

| Column Name | Data Type | Column Type | Description |
|-----------------|-----------|-------------|----------------------------------|
| database | string | Field | Database name |
| table_name | string | Field | Table name |
| datanode_id | int32 | Field | DataNode node ID |
| region_id | int32 | Field | Region ID |
| time_partition | int64 | Field | Time partition ID |
| size_in_bytes | int64 | Field | Disk space occupied (in bytes) |

**Query Examples**:

```SQL
-- Query all data;
select * from information_schema.table_disk_usage;
```

```Bash
+---------+-------------------+-----------+---------+--------------+-------------+
| database| table_name|datanode_id|region_id|time_partition|size_in_bytes|
+---------+-------------------+-----------+---------+--------------+-------------+
|database1| table1| 1| 3| 2864| 867|
|database1| table11| 1| 3| 2864| 0|
|database1| table3| 1| 3| 2864| 0|
|database1| table1| 1| 3| 2865| 1411|
|database1| table11| 1| 3| 2865| 0|
|database1| table3| 1| 3| 2865| 0|
|database1| table1| 1| 3| 2925| 590|
|database1| table11| 1| 3| 2925| 0|
|database1| table3| 1| 3| 2925| 0|
|database1| table1| 1| 4| 2864| 883|
|database1| table11| 1| 4| 2864| 0|
|database1| table3| 1| 4| 2864| 0|
|database1| table1| 1| 4| 2865| 1224|
|database1| table11| 1| 4| 2865| 0|
|database1| table3| 1| 4| 2865| 0|
|database1| table1| 1| 4| 2888| 0|
|database1| table11| 1| 4| 2888| 0|
|database1| table3| 1| 4| 2888| 205|
| etth| tab_cov_forecast| 1| 8| 0| 0|
| etth| tab_real| 1| 8| 0| 963|
| etth|tab_target_forecast| 1| 8| 0| 0|
| etth| tab_cov_forecast| 1| 9| 0| 448|
| etth| tab_real| 1| 9| 0| 0|
| etth|tab_target_forecast| 1| 9| 0| 0|
+---------+-------------------+-----------+---------+--------------+-------------+
```

```SQL
-- Specify query conditions;
select * from information_schema.table_disk_usage where region_id = 4 and table_name like '%1';
```

```Bash
+---------+----------+-----------+---------+--------------+-------------+
| database|table_name|datanode_id|region_id|time_partition|size_in_bytes|
+---------+----------+-----------+---------+--------------+-------------+
|database1| table1| 1| 4| 2864| 883|
|database1| table11| 1| 4| 2864| 0|
|database1| table1| 1| 4| 2865| 1224|
|database1| table11| 1| 4| 2865| 0|
|database1| table1| 1| 4| 2888| 0|
|database1| table11| 1| 4| 2888| 0|
+---------+----------+-----------+---------+--------------+-------------+
```


## 3. Permission Description

* GRANT/REVOKE operations are not supported for the `information_schema` database or any of its tables.
Expand Down
81 changes: 78 additions & 3 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 @@ -23,8 +23,8 @@

IoTDB has a built-in system database called `INFORMATION_SCHEMA`, which contains a series of system tables for storing IoTDB runtime information (such as currently executing SQL statements, etc.). Currently, the `INFORMATION_SCHEMA` database only supports read operations.

> 💡 **[V2.0.8.2 Version Update]**<br>
> 👉 Added onw system tables: **[SERVICES](#_2-21-services)** (service status management), enhancing cluster maintenance and performance analysis.
> 💡 **[V2.0.9 Version Update]**<br>
> 👉 Added onw system tables: **[TABLE_DISK_USAGE](#_2-22-table-disk-usage)** (Table-level Storage Space Statistics), enhancing cluster maintenance and performance analysis.


## 1. System Database
Expand Down Expand Up @@ -63,6 +63,7 @@ IoTDB> show tables from information_schema
| regions| INF|
| services| INF|
| subscriptions| INF|
| table_disk_usage| INF|
| tables| INF|
| topics| INF|
| views| INF|
Expand All @@ -71,7 +72,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`, `SERVICES` (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`, `TABLE_DISK_USAGE` (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 @@ -717,6 +718,80 @@ IoTDB> SELECT * FROM information_schema.services
+------------+-----------+---------+
```

##### 2.22 TABLE_DISK_USAGE
> This system table is available since version V2.0.9

Used to display the disk space usage of specified tables (excluding views), 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.

The table structure is shown below:

| Column Name | Data Type | Column Type | Description |
|-----------------|-----------|-------------|----------------------------------|
| database | string | Field | Database name |
| table_name | string | Field | Table name |
| datanode_id | int32 | Field | DataNode node ID |
| region_id | int32 | Field | Region ID |
| time_partition | int64 | Field | Time partition ID |
| size_in_bytes | int64 | Field | Disk space occupied (in bytes) |

**Query Examples**:

```SQL
-- Query all data;
select * from information_schema.table_disk_usage;
```

```Bash
+---------+-------------------+-----------+---------+--------------+-------------+
| database| table_name|datanode_id|region_id|time_partition|size_in_bytes|
+---------+-------------------+-----------+---------+--------------+-------------+
|database1| table1| 1| 3| 2864| 867|
|database1| table11| 1| 3| 2864| 0|
|database1| table3| 1| 3| 2864| 0|
|database1| table1| 1| 3| 2865| 1411|
|database1| table11| 1| 3| 2865| 0|
|database1| table3| 1| 3| 2865| 0|
|database1| table1| 1| 3| 2925| 590|
|database1| table11| 1| 3| 2925| 0|
|database1| table3| 1| 3| 2925| 0|
|database1| table1| 1| 4| 2864| 883|
|database1| table11| 1| 4| 2864| 0|
|database1| table3| 1| 4| 2864| 0|
|database1| table1| 1| 4| 2865| 1224|
|database1| table11| 1| 4| 2865| 0|
|database1| table3| 1| 4| 2865| 0|
|database1| table1| 1| 4| 2888| 0|
|database1| table11| 1| 4| 2888| 0|
|database1| table3| 1| 4| 2888| 205|
| etth| tab_cov_forecast| 1| 8| 0| 0|
| etth| tab_real| 1| 8| 0| 963|
| etth|tab_target_forecast| 1| 8| 0| 0|
| etth| tab_cov_forecast| 1| 9| 0| 448|
| etth| tab_real| 1| 9| 0| 0|
| etth|tab_target_forecast| 1| 9| 0| 0|
+---------+-------------------+-----------+---------+--------------+-------------+
```

```SQL
-- Specify query conditions;
select * from information_schema.table_disk_usage where region_id = 4 and table_name like '%1';
```

```Bash
+---------+----------+-----------+---------+--------------+-------------+
| database|table_name|datanode_id|region_id|time_partition|size_in_bytes|
+---------+----------+-----------+---------+--------------+-------------+
|database1| table1| 1| 4| 2864| 883|
|database1| table11| 1| 4| 2864| 0|
|database1| table1| 1| 4| 2865| 1224|
|database1| table11| 1| 4| 2865| 0|
|database1| table1| 1| 4| 2888| 0|
|database1| table11| 1| 4| 2888| 0|
+---------+----------+-----------+---------+--------------+-------------+
```


## 3. Permission Description

Expand Down
45 changes: 45 additions & 0 deletions src/UserGuide/Master/Tree/User-Manual/Maintenance-commands_apache.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,6 +302,51 @@ Execution result:
+--------------+-------------+---------+
```

### 1.9 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-beta

#### Syntax:
```sql
showDiskUsageStatement
: SHOW DISK_USAGE FROM pathPattern
whereClause?
orderByClause?
rowPaginationClause?
;
pathPattern
: ROOT (DOT nodeName)*
;
```

**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 |
| DataNodeId | int32 | DataNode node ID |
| RegionId | int32 | Region ID |
| TimePartition | int64 | Time partition ID |
| SizeInBytes | int64 | Disk space occupied (in bytes) |

#### Example:
```sql
SHOW DISK_USAGE FROM root.ln.**;
```

**Execution Result**:
```bash
+--------+----------+--------+-------------+-----------+
|Database|DataNodeId|RegionId|TimePartition|SizeInBytes|
+--------+----------+--------+-------------+-----------+
| root.ln| 1| 13| 2932| 203|
+--------+----------+--------+-------------+-----------+
```


## 2. Status Setting

Expand Down
44 changes: 44 additions & 0 deletions src/UserGuide/Master/Tree/User-Manual/Maintenance-commands_timecho.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,6 +302,50 @@ Execution result:
+--------------+-------------+---------+
```

### 1.9 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

#### Syntax:
```sql
showDiskUsageStatement
: SHOW DISK_USAGE FROM pathPattern
whereClause?
orderByClause?
rowPaginationClause?
;
pathPattern
: ROOT (DOT nodeName)*
;
```

**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 |
| DataNodeId | int32 | DataNode node ID |
| RegionId | int32 | Region ID |
| TimePartition | int64 | Time partition ID |
| SizeInBytes | int64 | Disk space occupied (in bytes) |

#### Example:
```sql
SHOW DISK_USAGE FROM root.ln.**;
```

**Execution Result**:
```bash
+--------+----------+--------+-------------+-----------+
|Database|DataNodeId|RegionId|TimePartition|SizeInBytes|
+--------+----------+--------+-------------+-----------+
| root.ln| 1| 13| 2932| 203|
+--------+----------+--------+-------------+-----------+
```

## 2. Status Setting

Expand Down
Loading