This is an automated email from the ASF dual-hosted git repository. hui pushed a commit to branch lmh/docUpdate in repository https://gitbox.apache.org/repos/asf/iotdb.git
commit dfb7d1d61eea7ef09d8a43e4a7da218b881caeab Author: Minghui Liu <[email protected]> AuthorDate: Wed Nov 2 15:06:55 2022 +0800 delete Tracing-Tool & Without-Null in user guide --- docs/UserGuide/Query-Data/Tracing-Tool.md | 48 -------- docs/UserGuide/Query-Data/Without-Null.md | 172 --------------------------- docs/zh/UserGuide/Query-Data/Tracing-Tool.md | 48 -------- docs/zh/UserGuide/Query-Data/Without-Null.md | 172 --------------------------- site/src/main/.vuepress/config.js | 12 +- 5 files changed, 4 insertions(+), 448 deletions(-) diff --git a/docs/UserGuide/Query-Data/Tracing-Tool.md b/docs/UserGuide/Query-Data/Tracing-Tool.md deleted file mode 100644 index a6529413a6..0000000000 --- a/docs/UserGuide/Query-Data/Tracing-Tool.md +++ /dev/null @@ -1,48 +0,0 @@ -<!-- - - 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. - ---> - -# Performance Tracing Tool - -IoTDB supports the use of the `TRACING` clause to enable performance tracing of executed query statements. Users can use the performance tracing tool to analyze potential performance problems in some statements. - -The current performance analysis includes the following contents: -1. The elapsed time of each stage of the execution process. -2. Statistics related to performance analysis, it includes the number of time series queried, the number of Tsfile files accessed, the total number of chunks to be scanned, and the average number of data points contained in the chunk, the total number of pages read, and the number of overlapped pages. - -For example, execute `tracing select * from root`, will display the following contents: - -``` -Tracing Activties: -+------------------------------------------------------+------------+ -| Activity|Elapsed Time| -+------------------------------------------------------+------------+ -|Start to execute statement: tracing select * from root| 0| -| Parse SQL to physical plan| 4| -| Create and cache dataset| 16| -| * Num of series paths: 3| | -| * Num of sequence files read: 2| | -| * Num of unsequence files read: 1| | -| * Num of sequence chunks: 6, avg points: 100.0| | -| * Num of unsequence chunks: 3, avg points: 100.0| | -| * Num of Pages: 9, overlapped pages: 0 (0.0%)| | -| Request complete| 20| -+------------------------------------------------------+------------+ -``` \ No newline at end of file diff --git a/docs/UserGuide/Query-Data/Without-Null.md b/docs/UserGuide/Query-Data/Without-Null.md deleted file mode 100644 index 6d5c3c2d0b..0000000000 --- a/docs/UserGuide/Query-Data/Without-Null.md +++ /dev/null @@ -1,172 +0,0 @@ -<!-- - - 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. - ---> - -# Null Value Filter - -In practical application, users may want to filter some rows with null values in the query result set. In IoTDB, the `WITHOUT NULL` clause can be used to filter null values in the result set. There are two filtering strategies: `WITHOUT NULL ANY`和`WITHOUT NULL ALL`. In addition, the `WITHOUT NULL` clause supports specifying the corresponding columns for filtering. - -> WITHOUT NULL ANY: if one of the columns in the specified column set is null, the conditions are met for filtering. -> -> WITHOUT NULL ALL: if all columns in the specified column set are null, the conditions are met for filtering. - -## Don't specify columns - -> By default, it is effective for all columns in the result set. That is the specified column set includes all columns in the result set. - -1. In the following query, if any column of one row in the result set is null, the row will be filtered out. That is the result set obtained does not contain any null values. - -```sql -select * from root.ln.** where time <= 2017-11-01T00:01:00 WITHOUT NULL ANY -``` - -2. In the following query, if all columns of one row in the result set are null, the row will be filtered out. - -```sql -select * from root.ln.** where group by ([1,10), 2ms) WITHOUT NULL ALL -``` - -## Specify columns - -> take effect only for the specified column set - -Use the `WITHOUT NULL` clause to filter the null value of the specified column in the result set. The following are some examples and descriptions: - -> Note that if the specified column does not exist in the current metadata, it will be filtered directly, which is consistent with the output result of the current query. -> If the specified column exists but does not match the column name output from the result set, an error will be reported: `The without null columns don't match the columns queried.If has alias, please use the alias.` - -For examples: - -1. In `without null` specified column set, `root.test.sg1.s1` column exists in the current metadata,`root.test.sg1.usag` column does not exist in the current metadata. The function of the `without null` clause in the following query is equivalent to without null all(s1). - -```sql -select * from root.test.sg1 without null all (s1, usag) -``` - -2. In `without null` specified column set, `root.test.sg1.s2` column exists in the current metadata, but doesn't exist in the result set of the query. So it will report an error: `The without null columns don't match the columns queried.If has alias, please use the alias.` - -```sql -select s1 + s2, s1 - s2, s1 * s2, s1 / s2, s1 % s2 from root.test.sg1 without null all (s1+s2, s2) -``` - -### Raw data query - -1. If the column `root.ln.sg1.s1` of one row in the result set of the query is null, the row will be filtered out. - -```sql -select * from root.ln.sg1 WITHOUT NULL ANY(s1) -``` - -2. If at least one column in `root.ln.sg1.s1` and `root.ln.sg1.s2` of one row is null in the result set of the query, the row will be filtered out. - -```sql -select * from root.ln.sg1 WITHOUT NULL ANY(s1, s2) -``` - -3. If both `root.ln.sg1.s1` and `root.ln.sg1.s2` columns of one row are null in the result set of the query, the row will be filtered out. - -```sql -select * from root.ln.sg1 WITHOUT NULL ALL(s1, s2) -``` - -### With expression query - -specified columns can be expression - -1. If both `s2+s4` and `s2` columns of one row are null in the result set of the query, the row will be filtered out. - -```sql -select s2, - s2, s4, + s4, s2 + s4, s2 - s4, s2 * s4, s2 / s4, s2 % s4 from root.test.sg1 without null all (s2+s4, s2) -``` - -2. If at least one column in `s2+s4` and `s2` of one row is null in the result set of the query, the row will be filtered out. - -```sql -select s2, - s2, s4, + s4, s2 + s4, s2 - s4, s2 * s4, s2 / s4, s2 % s4 from root.test.sg1 without null any (s2+s4, s2) -``` - - -### With function query - -```sql -select s1, sin(s2) + cos(s2), cos(sin(s2 + s4) + s2) from root.test.sg1 without null all (sin(s2) + cos(s2), cos(sin(s2 + s4) + s2)) -``` - -### Align by device query - -```sql -select last_value(*) from root.test.sg1 group by([1,10), 2ms) without null all(last_value(s2), last_value(s3)) align by device -``` - -Examples of results are as follows： - -``` -IoTDB> select last_value(*) from root.sg1.* group by([1,10), 2ms) without null all(last_value(s2), last_value(s3)) align by device -+-----------------------------+-----------+--------------+--------------+--------------+ -| Time| Device|last_value(s1)|last_value(s2)|last_value(s3)| -+-----------------------------+-----------+--------------+--------------+--------------+ -|1970-01-01T08:00:00.001+08:00|root.sg1.d1| 1.0| 2.0| null| -|1970-01-01T08:00:00.003+08:00|root.sg1.d1| 3.0| 4.0| null| -|1970-01-01T08:00:00.001+08:00|root.sg1.d2| 1.0| 1.0| 1.0| -+-----------------------------+-----------+--------------+--------------+--------------+ -Total line number = 3 -It costs 0.007s -``` - -The specified column name corresponds to the column name of the output result. At present, the `without null` clause doesn't support specifying a column of a device. If you do, an error will be reported: `The without null columns don't match the columns queried.If has alias, please use the alias.` For example, in the following query example, it is not supported to filter the row with column `last_value(root.sg1.d1.s3)` that is null. - -```sql -select last_value(*) from root.test.sg1 group by([1,10), 2ms) without null all(last_value(`root.sg1.d1.s3`)) align by device -``` - -### Aggregation query - -```sql -select avg(s4), sum(s2) from root.test.sg1 group by ([1,10), 2ms) without null all(sum(s2)) -``` - -```sql -select avg(s4), sum(s2), count(s3) from root.test.sg1 group by ([1,10), 2ms) without null all(avg(s4), sum(s2)) -``` - -### Specify full path columns - -Assuming that the output results of the following query are listed as `root.test.sg1.s2`, `root.test.sg1.s3`, `root.test.sg2.s2` and `root.test.sg2.s3`, you can specify the corresponding columns with full pathname for filtering, such as the following example: - -1. If both `root.test.sg1.s2` and `root.test.sg2.s3` columns of one row are null in the result set of the query, the row will be filtered out. - -```sql -select s2, s3 from root.test.** without null all(root.test.sg1.s2, root.test.sg2.s3) -``` - -2. If `root.test.sg1.s2`, `root.test.sg1.s3` and `root.test.sg2.s3` columns of one row are null in the result set of the query, the row will be filtered out. - -```sql -select s2, s3 from root.test.** without null all(root.test.sg1.s2, s3) -``` - -### Aligned Timeseries Query - -1. You can specify the `without null` column name as the aligned timeseries column name. - -```sql -CREATE ALIGNED TIMESERIES root.test.sg3(s5 INT32, s6 BOOLEAN, s7 DOUBLE, s8 INT32) -select sg1.s1, sg1.s2, sg2.s3, sg3.* from root.test without null all (sg3.s5, sg3.s6, sg2.s3) -``` \ No newline at end of file diff --git a/docs/zh/UserGuide/Query-Data/Tracing-Tool.md b/docs/zh/UserGuide/Query-Data/Tracing-Tool.md deleted file mode 100644 index 6ec4641639..0000000000 --- a/docs/zh/UserGuide/Query-Data/Tracing-Tool.md +++ /dev/null @@ -1,48 +0,0 @@ -<!-- - - 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. - ---> - -# 查询性能追踪 - -IoTDB 支持使用 `TRACING` 关键词对查询语句进行性能追踪。用户可以使用性能追踪工具来分析语句执行中存在的潜在性能问题。 - -性能追踪的结果包括： -1. 查询执行过程中各个阶段的累积耗时。 -2. 与查询性能分析相关的统计信息，包括查询的时间序列数、涉及访问的 Tsfile 文件数、需要扫描的 chunk 总数以及平均每个 chunk 包含的数据点个数、读取的 Page 总数以及其中乱序 Page 的个数。 - -例如执行 `tracing select * from root.**`，输出结果如下： - -``` -Tracing Activties: -+---------------------------------------------------------+------------+ -| Activity|Elapsed Time| -+---------------------------------------------------------+------------+ -|Start to execute statement: tracing select * from root.**| 0| -| Parse SQL to physical plan| 4| -| Create and cache dataset| 16| -| * Num of series paths: 3| | -| * Num of sequence files read: 2| | -| * Num of unsequence files read: 1| | -| * Num of sequence chunks: 6, avg points: 100.0| | -| * Num of unsequence chunks: 3, avg points: 100.0| | -| * Num of Pages: 9, overlapped pages: 0 (0.0%)| | -| Request complete| 20| -+---------------------------------------------------------+------------+ -``` \ No newline at end of file diff --git a/docs/zh/UserGuide/Query-Data/Without-Null.md b/docs/zh/UserGuide/Query-Data/Without-Null.md deleted file mode 100644 index 0c1f34454b..0000000000 --- a/docs/zh/UserGuide/Query-Data/Without-Null.md +++ /dev/null @@ -1,172 +0,0 @@ -<!-- - - 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. - ---> - -# 结果集空值过滤 - -在实际应用中，用户可能希望对查询的结果集中某些存在空值的行进行过滤。在 IoTDB 中，可以使用 `WITHOUT NULL` 子句对结果集中的空值进行过滤，有两种过滤策略：`WITHOUT NULL ANY`和`WITHOUT NULL ALL`。不仅如此， `WITHOUT NULL` 子句支持指定相应列进行过滤。 - -> WITHOUT NULL ANY: 指定的列集中，存在一列为NULL,则满足条件进行过滤 -> -> WITHOUT NULL ALL: 指定的列集中，所有列都为NULL,才满足条件进行过滤 - -## 不指定列 - -> 默认就是对结果集中的所有列生效，即指定的列集为结果集中的所有列 - -1. 在下列查询中，如果结果集中某一行任意一列为 null，则过滤掉该行；即获得的结果集不包含任何空值。 - -```sql -select * from root.ln.** where time <= 2017-11-01T00:01:00 WITHOUT NULL ANY -``` - -2. 在下列查询中，如果结果集的某一行所有列都为 null，则过滤掉该行；即获得的结果集不包含所有值都为 null 的行。 - -```sql -select * from root.ln.** where group by ([1,10), 2ms) WITHOUT NULL ALL -``` - -## 指定列 - -> 只对指定的列集生效 - -使用 `WITHOUT NULL`子句对结果集中指定列名的空值进行过滤，下面是一些例子及其说明: - -> 注意，如果指定的列在当前元数据里不存在则会直接过滤掉，这与目前查询列的输出结果是一致的; -> 如果指定的列存在，但与结果集中输出的列名不匹配，则会报错: `The without null columns don't match the columns queried.If has alias, please use the alias.` - -比如下面的例子 - -1. 比如`without null`指定的列集中`root.test.sg1.s1`列在元数据中存在，`root.test.sg1.usag`列在元数据不存在，则下面查询的without null子句的作用相当于without null all(s1) - -```sql -select * from root.test.sg1 without null all (s1, usag) -``` - -2. 比如`without null`指定的列集中`root.test.sg1.s2`列在元数据中存在，但查询的结果集中输出列不包括，所以会报错:`The without null columns don't match the columns queried.If has alias, please use the alias.` - -```sql -select s1 + s2, s1 - s2, s1 * s2, s1 / s2, s1 % s2 from root.test.sg1 without null all (s1+s2, s2) -``` - -### 原始数据查询 - -1. 如果查询的结果集中, root.ln.sg1.s1这一列如果为null,则过滤掉该行 - -```sql -select * from root.ln.sg1 WITHOUT NULL ANY(s1) -``` - -2. 如果查询的结果集中, root.ln.sg1.s1和root.ln.sg1.s2中只要存在至少一列为null,则过滤掉该行 - -```sql -select * from root.ln.sg1 WITHOUT NULL ANY(s1, s2) -``` - -3. 如果查询的结果集中, 只要root.ln.sg1.s1和root.ln.sg1.s2这两列都为null,则过滤掉该行 - -```sql -select * from root.ln.sg1 WITHOUT NULL ALL(s1, s2) -``` - -### 带表达式查询 - -指定的列可以为表达式 - -1. 计算s2+s4和s2这两列是否都为null,如果是则过滤 - -```sql -select s2, - s2, s4, + s4, s2 + s4, s2 - s4, s2 * s4, s2 / s4, s2 % s4 from root.test.sg1 without null all (s2+s4, s2) -``` - -2. 计算s2+s4和s2这两列是否至少有一列为null,如果是则过滤 - -```sql -select s2, - s2, s4, + s4, s2 + s4, s2 - s4, s2 * s4, s2 / s4, s2 % s4 from root.test.sg1 without null any (s2+s4, s2) -``` - - -### 带函数查询 - -```sql -select s1, sin(s2) + cos(s2), cos(sin(s2 + s4) + s2) from root.test.sg1 without null all (sin(s2) + cos(s2), cos(sin(s2 + s4) + s2)) -``` - -### 按设备对齐查询 - -```sql -select last_value(*) from root.test.sg1 group by([1,10), 2ms) without null all(last_value(s2), last_value(s3)) align by device -``` - -结果示例如下： - -``` -IoTDB> select last_value(*) from root.sg1.* group by([1,10), 2ms) without null all(last_value(s2), last_value(s3)) align by device -+-----------------------------+-----------+--------------+--------------+--------------+ -| Time| Device|last_value(s1)|last_value(s2)|last_value(s3)| -+-----------------------------+-----------+--------------+--------------+--------------+ -|1970-01-01T08:00:00.001+08:00|root.sg1.d1| 1.0| 2.0| null| -|1970-01-01T08:00:00.003+08:00|root.sg1.d1| 3.0| 4.0| null| -|1970-01-01T08:00:00.001+08:00|root.sg1.d2| 1.0| 1.0| 1.0| -+-----------------------------+-----------+--------------+--------------+--------------+ -Total line number = 3 -It costs 0.007s -``` - -指定的列名是与输出结果的列名对应，目前`without null`子句不支持指定某设备的某列，会报错:`The without null columns don't match the columns queried.If has alias, please use the alias.` 比如下面这个查询例子,指定last_value(root.sg1.d1.s3)为null的行进行过滤，目前是不支持的。 - -```sql -select last_value(*) from root.test.sg1 group by([1,10), 2ms) without null all(last_value(`root.sg1.d1.s3`)) align by device -``` - -### 聚合查询 - -```sql -select avg(s4), sum(s2) from root.test.sg1 group by ([1,10), 2ms) without null all(sum(s2)) -``` - -```sql -select avg(s4), sum(s2), count(s3) from root.test.sg1 group by ([1,10), 2ms) without null all(avg(s4), sum(s2)) -``` - -### 指定全路径列名 - -假设下面的查询输出的结果列为"root.test.sg1.s2", "root.test.sg1.s3", "root.test.sg2.s2", "root.test.sg2.s3"四个，可以使用全路径名指定相应列进行过滤，比如下面的例子： - -1. 指定`root.test.sg1.s2`, `root.test.sg2.s3`两列都为null则过滤 - -```sql -select s2, s3 from root.test.** without null all(root.test.sg1.s2, root.test.sg2.s3) -``` - -2. 指定`root.test.sg1.s2`, `root.test.sg1.s3`, `root.test.sg2.s3`三列都为null则过滤 - -```sql -select s2, s3 from root.test.** without null all(root.test.sg1.s2, s3) -``` - -### 对齐序列查询 - -1. 可以指定`without null` 子句后的列名为对齐序列列名 - -```sql -CREATE ALIGNED TIMESERIES root.test.sg3(s5 INT32, s6 BOOLEAN, s7 DOUBLE, s8 INT32) -select sg1.s1, sg1.s2, sg2.s3, sg3.* from root.test without null all (sg3.s5, sg3.s6, sg2.s3) -``` \ No newline at end of file diff --git a/site/src/main/.vuepress/config.js b/site/src/main/.vuepress/config.js index acebd98e00..3940c726ba 100644 --- a/site/src/main/.vuepress/config.js +++ b/site/src/main/.vuepress/config.js @@ -647,7 +647,7 @@ var config = { ], '/UserGuide/V0.13.x/': [ { - title:'IoTDB User Guide (latest)', + title:'IoTDB User Guide (V0.13.x)', collapsable: false, }, { @@ -921,9 +921,7 @@ var config = { ['Query-Data/Result-Format.md','Query Result Formats'], ['Query-Data/Aggregate-Query.md','Aggregate Query'], ['Query-Data/Last-Query.md','Last Query'], - ['Query-Data/Fill-Null-Value.md','Fill Null Value'], - ['Query-Data/Without-Null.md','Without Null'], - ['Query-Data/Tracing-Tool.md','Tracing Tool'] + ['Query-Data/Fill-Null-Value.md','Fill Null Value'] ] }, { @@ -1581,7 +1579,7 @@ var config = { ], '/zh/UserGuide/V0.13.x/': [ { - title: 'IoTDB用户手册 (In progress)', + title: 'IoTDB用户手册 (V0.13.x)', collapsable: false, }, { @@ -1855,9 +1853,7 @@ var config = { ['Query-Data/Result-Format.md','查询结果对齐格式'], ['Query-Data/Aggregate-Query.md','聚合查询'], ['Query-Data/Last-Query.md','最新点查询'], - ['Query-Data/Fill-Null-Value.md','空值填充'], - ['Query-Data/Without-Null.md','空值过滤'], - ['Query-Data/Tracing-Tool.md','查询性能追踪'] + ['Query-Data/Fill-Null-Value.md','空值填充'] ] }, {
