This is an automated email from the ASF dual-hosted git repository. qiaojialin pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/iotdb-docs.git
The following commit(s) were added to refs/heads/main by this push: new c668871 fix the rest doc bugs of V1.3.1 and master (#217) c668871 is described below commit c6688712895a5d9c1366e22a01e2a7ac752eb89a Author: wanghui42 <105700158+wanghu...@users.noreply.github.com> AuthorDate: Thu May 9 15:44:12 2024 +0800 fix the rest doc bugs of V1.3.1 and master (#217) --- .../Deployment-Guide_timecho.md | 1 - src/UserGuide/Master/FAQ/Frequently-asked-questions.md | 9 ++++++--- src/UserGuide/Master/QuickStart/ClusterQuickStart.md | 4 ++-- src/UserGuide/Master/QuickStart/QuickStart.md | 12 +----------- src/UserGuide/Master/SQL-Manual/SQL-Manual.md | 14 +++----------- src/UserGuide/Master/User-Manual/AINode_timecho.md | 6 +++--- src/UserGuide/Master/User-Manual/IoTDB-View_timecho.md | 2 +- src/UserGuide/Master/User-Manual/Operate-Metadata.md | 5 ++++- .../Master/User-Manual/Operator-and-Expression.md | 5 +++-- .../Deployment-Guide_timecho.md | 1 - src/UserGuide/latest/FAQ/Frequently-asked-questions.md | 13 ++++++++----- src/UserGuide/latest/QuickStart/ClusterQuickStart.md | 4 ++-- src/UserGuide/latest/QuickStart/QuickStart.md | 12 +----------- src/UserGuide/latest/SQL-Manual/SQL-Manual.md | 17 +++-------------- src/UserGuide/latest/User-Manual/AINode_timecho.md | 6 +++--- src/UserGuide/latest/User-Manual/IoTDB-View_timecho.md | 2 +- src/UserGuide/latest/User-Manual/Operate-Metadata.md | 5 ++++- .../latest/User-Manual/Operator-and-Expression.md | 5 +++-- .../UserGuide/Master/FAQ/Frequently-asked-questions.md | 10 +++++----- src/zh/UserGuide/Master/SQL-Manual/SQL-Manual.md | 12 +----------- src/zh/UserGuide/Master/User-Manual/AINode_timecho.md | 8 ++++---- src/zh/UserGuide/Master/User-Manual/Operate-Metadata.md | 5 ++++- src/zh/UserGuide/Master/User-Manual/Syntax-Rule.md | 2 +- .../latest/Basic-Concept/Encoding-and-Compression.md | 2 +- .../UserGuide/latest/FAQ/Frequently-asked-questions.md | 10 +++++----- src/zh/UserGuide/latest/SQL-Manual/SQL-Manual.md | 13 ++----------- src/zh/UserGuide/latest/User-Manual/AINode_timecho.md | 8 ++++---- src/zh/UserGuide/latest/User-Manual/Operate-Metadata.md | 5 ++++- src/zh/UserGuide/latest/User-Manual/Syntax-Rule.md | 2 +- 29 files changed, 80 insertions(+), 120 deletions(-) diff --git a/src/UserGuide/Master/Deployment-and-Maintenance/Deployment-Guide_timecho.md b/src/UserGuide/Master/Deployment-and-Maintenance/Deployment-Guide_timecho.md index 7e64348..cde1133 100644 --- a/src/UserGuide/Master/Deployment-and-Maintenance/Deployment-Guide_timecho.md +++ b/src/UserGuide/Master/Deployment-and-Maintenance/Deployment-Guide_timecho.md @@ -162,7 +162,6 @@ IOTDB_JMX_OPTS="$IOTDB_JMX_OPTS -XX:MaxGCPauseMillis=200" | name | Confignode name | YES | | deploy\_dir | IoTDB config node deployment directory | YES | | iotdb-confignode.properties | Corresponding to `iotdb/config/iotdb-confignode.properties`, please refer to the `iotdb-confignode.properties` file description for more details. | NO | -| cn\_internal\_address | Corresponds to iotdb/internal communication address, corresponding to `cn_internal_address` in `iotdb/config/iotdb-confignode.properties` | YES | | cn_internal_address | The cluster configuration address points to the surviving ConfigNode, and it points to confignode_x by default. When `global` and `confignode_servers` are configured at the same time, the value in `confignode_servers` is used first, corresponding to `cn_internal_address` in `iotdb/config/iotdb-confignode.properties` | YES | | cn\_internal\_port | Internal communication port, corresponding to `cn_internal_port` in `iotdb/config/iotdb-confignode.properties` | YES | | cn\_consensus\_port | Corresponds to `cn_consensus_port` in `iotdb/config/iotdb-confignode.properties` | NO | diff --git a/src/UserGuide/Master/FAQ/Frequently-asked-questions.md b/src/UserGuide/Master/FAQ/Frequently-asked-questions.md index e9e7b13..5e4b2d9 100644 --- a/src/UserGuide/Master/FAQ/Frequently-asked-questions.md +++ b/src/UserGuide/Master/FAQ/Frequently-asked-questions.md @@ -116,7 +116,7 @@ If you are using Linux, you can use the following shell command: ### 5. Can I use Hadoop and Spark to read TsFile in IoTDB? -Yes. IoTDB has intense integration with Open Source Ecosystem. IoTDB supports [Hadoop](https://github.com/apache/iotdb/tree/master/hadoop), [Spark](https://github.com/apache/iotdb/tree/master/spark-tsfile) and [Grafana](https://github.com/apache/iotdb/tree/master/grafana-plugin) visualization tool. +Yes. IoTDB has intense integration with Open Source Ecosystem. IoTDB supports [Hadoop](https://github.com/apache/iotdb/tree/master/iotdb-connector/hadoop), [Spark](https://github.com/apache/iotdb/tree/master/iotdb-connector/spark-iotdb-connector) and [Grafana](https://github.com/apache/iotdb/tree/master/iotdb-connector/grafana-connector) visualization tool. ### 6. How does IoTDB handle duplicate points? @@ -126,10 +126,10 @@ A data point is uniquely identified by a full time series path (e.g. ```root.veh Use ```SHOW TIMESERIES <timeseries path>``` SQL in IoTDB's Command Line Interface: -For example, if you want to know the type of all timeseries, the \<timeseries path> should be `root`. The statement will be: +For example, if you want to know the type of all timeseries, the \<timeseries path> should be `root.**`. The statement will be: ``` -IoTDB> show timeseries root +IoTDB> show timeseries.** ``` If you want to query specific sensor, you can replace the \<timeseries path> with the sensor name. For example: @@ -154,6 +154,9 @@ The default IoTDB's Cli time display format is readable (e.g. ```1970-01-01T08:0 ### 9. How to handle error `IndexOutOfBoundsException` from `org.apache.ratis.grpc.server.GrpcLogAppender`? +This is an internal error log from Ratis 2.4.1, our dependency, and no impact on data writes or reads is expected. +It has been reported to the Ratis community and will be fixed in the future releases. + ### 10. How to deal with estimated out of memory errors? Report an error message: diff --git a/src/UserGuide/Master/QuickStart/ClusterQuickStart.md b/src/UserGuide/Master/QuickStart/ClusterQuickStart.md index e5dea94..eb4fda3 100644 --- a/src/UserGuide/Master/QuickStart/ClusterQuickStart.md +++ b/src/UserGuide/Master/QuickStart/ClusterQuickStart.md @@ -72,10 +72,10 @@ Modify the specified configuration file according to the table below: | Configuration| Configuration Option | IP:192.168.132.10 | IP:192.168.132.11 | IP:192.168.132.12 | |------------|:-------------------------------|----------------------|----------------------|:---------------------| | iotdb-confignode.properties | cn\_internal\_address | 192.168.132.10 | 192.168.132.11 | 192.168.132.12 | -| | cn\_target\_config\_node\_list | 192.168.132.10:10710 | 192.168.132.10:10710 | 192.168.132.10:10710 | +| | cn_seed_config_node | 192.168.132.10:10710 | 192.168.132.10:10710 | 192.168.132.10:10710 | | iotdb-datanode.properties | dn\_rpc\_address | 192.168.132.10 | 192.168.132.11 | 192.168.132.12 | | | dn\_internal\_address | 192.168.132.10 | 192.168.132.11 | 192.168.132.12 | -| | dn\_target\_config\_node\_list | 192.168.132.10:10710 | 192.168.132.10:10710 | 192.168.132.10:10710 | +| | dn_seed_config_node | 192.168.132.10:10710 | 192.168.132.10:10710 | 192.168.132.10:10710 | **Notice:** It's recommended that the configurations of iotdb-common.properties and the heap size of JVM in all nodes are the same. diff --git a/src/UserGuide/Master/QuickStart/QuickStart.md b/src/UserGuide/Master/QuickStart/QuickStart.md index efaff2d..24606d1 100644 --- a/src/UserGuide/Master/QuickStart/QuickStart.md +++ b/src/UserGuide/Master/QuickStart/QuickStart.md @@ -44,16 +44,6 @@ IoTDB provides you three installation methods, you can refer to the following su You can download the binary file from: [Download Page](https://iotdb.apache.org/Download/) -## Configurations - -Configuration files are under "conf" folder - - * environment config module (`datanode-env.bat`, `datanode-env.sh`), - * system config module (`iotdb-datanode.properties`) - * log config module (`logback.xml`). - -For more, see [Config](../Reference/DataNode-Config-Manual.md) in detail. - ## Start You can go through the following step to test the installation, if there is no error after execution, the installation is completed. @@ -230,7 +220,7 @@ ALTER USER <username> SET PASSWORD <password>; Example: IoTDB > ALTER USER root SET PASSWORD 'newpwd'; ``` -More about administration management:[Administration Management](https://iotdb.apache.org/UserGuide/V1.0.x/Administration-Management/Administration.html) +More about administration management:[Administration Management](../User-Manual/Authority-Management.md) ## Basic configuration diff --git a/src/UserGuide/Master/SQL-Manual/SQL-Manual.md b/src/UserGuide/Master/SQL-Manual/SQL-Manual.md index a3f4a12..44e105c 100644 --- a/src/UserGuide/Master/SQL-Manual/SQL-Manual.md +++ b/src/UserGuide/Master/SQL-Manual/SQL-Manual.md @@ -30,10 +30,6 @@ For more details, see document [Operate-Metadata](../User-Manual/Operate-Metadat ```sql IoTDB > create database root.ln IoTDB > create database root.sgcc -IoTDB> CREATE DATABASE root.ln.wf01 -Msg: 300: root.ln has already been created as database. -IoTDB> create database root.ln.wf01 -Msg: 300: root.ln has already been created as database. ``` ### Show Databases @@ -114,13 +110,9 @@ For more details, see document [Operate-Metadata](../User-Manual/Operate-Metadat -Create template(s1 int, s2 float) on root.sg -Create device root.sg.d1 - - -![img](https://alioss.timecho.com/docs/img/%E6%A8%A1%E6%9D%BF%E6%B5%81%E7%A8%8B.png) +![img](https://alioss.timecho.com/docs/img/templateEN.jpg) ### Create Device Template @@ -1349,7 +1341,7 @@ select rm(s0, s1,"tb"="3","vb"="2") from root.test.d0 ## LAMBDA EXPRESSION -For details and examples, see the document [Lambda](../Reference/Function-and-Expression#lambda-expression). +For details and examples, see the document [Lambda](../Reference/Function-and-Expression.md#lambda-expression). ```sql select jexl(temperature, 'expr'='x -> {x + x}') as jexl1, jexl(temperature, 'expr'='x -> {x * 3}') as jexl2, jexl(temperature, 'expr'='x -> {x * x}') as jexl3, jexl(temperature, 'expr'='x -> {multiply(x, 100)}') as jexl4, jexl(temperature, st, 'expr'='(x, y) -> {x + y}') as jexl5, jexl(temperature, st, str, 'expr'='(x, y, z) -> {x + y + z}') as jexl6 from root.ln.wf01.wt01;``` @@ -1357,7 +1349,7 @@ select jexl(temperature, 'expr'='x -> {x + x}') as jexl1, jexl(temperature, 'exp ## CONDITIONAL EXPRESSION -For details and examples, see the document [Conditional Expressions](../Reference/Function-and-Expression#conditional-expressions). +For details and examples, see the document [Conditional Expressions](../Reference/Function-and-Expression.md#conditional-expressions). ```sql select T, P, case diff --git a/src/UserGuide/Master/User-Manual/AINode_timecho.md b/src/UserGuide/Master/User-Manual/AINode_timecho.md index 927369d..ddd3879 100644 --- a/src/UserGuide/Master/User-Manual/AINode_timecho.md +++ b/src/UserGuide/Master/User-Manual/AINode_timecho.md @@ -437,12 +437,12 @@ where the labels of each row in the result set correspond to the model output co ## 5. Privilege Management -When using AINode related functions, the authentication of IoTDB itself can be used to do a permission management, users can only use the model management related functions when they have the USE_ML permission. When using the inference function, the user needs to have the permission to access the source sequence corresponding to the SQL of the input model. +When using AINode related functions, the authentication of IoTDB itself can be used to do a permission management, users can only use the model management related functions when they have the USE_MODEL permission. When using the inference function, the user needs to have the permission to access the source sequence corresponding to the SQL of the input model. | Privilege Name | Privilege Scope | Administrator User (default ROOT) | Normal User | Path Related | | --------- | --------------------------------- | ---------------------- | -------- | -------- | -| USE_MODEL | create model/show model/sdrop model | √ | √ √ | x | -| | | call inference | | | | | +| USE_MODEL | create model/show models/drop model | √ | √ | x | +| READ_DATA| call inference | √ | √|√ | ## 6. Practical Examples diff --git a/src/UserGuide/Master/User-Manual/IoTDB-View_timecho.md b/src/UserGuide/Master/User-Manual/IoTDB-View_timecho.md index 6595b59..ac0bb02 100644 --- a/src/UserGuide/Master/User-Manual/IoTDB-View_timecho.md +++ b/src/UserGuide/Master/User-Manual/IoTDB-View_timecho.md @@ -308,7 +308,7 @@ AS SELECT temperature FROM root.db.* ``` -This is modelled on the query writeback (`SELECT INTO`) convention for naming rules, which uses variable placeholders to specify naming rules. See also: [QUERY WRITEBACK (SELECT INTO)](https://iotdb.apache.org/zh/UserGuide/Master/Query-Data/Select-Into.html) +This is modelled on the query writeback (`SELECT INTO`) convention for naming rules, which uses variable placeholders to specify naming rules. See also: [QUERY WRITEBACK (SELECT INTO)](../User-Manual/Query-Data.md#into-clause-query-write-back) Here `root.db.*.temperature` specifies what time series will be included in the view; and `${2}` specifies from which node in the time series the name is extracted to name the sequence view. diff --git a/src/UserGuide/Master/User-Manual/Operate-Metadata.md b/src/UserGuide/Master/User-Manual/Operate-Metadata.md index fa1b10c..c4ceac6 100644 --- a/src/UserGuide/Master/User-Manual/Operate-Metadata.md +++ b/src/UserGuide/Master/User-Manual/Operate-Metadata.md @@ -315,7 +315,9 @@ IoTDB> show all ttl IoTDB supports the device template function, enabling different entities of the same type to share metadata, reduce the memory usage of metadata, and simplify the management of numerous entities and measurements. -Note: The `device` keyword in the following statements can be omitted. +![img](https://alioss.timecho.com/docs/img/%E6%A8%A1%E6%9D%BF.png) + +![img](https://alioss.timecho.com/docs/img/templateEN.jpg) ### Create Device Template @@ -339,6 +341,7 @@ IoTDB> create device template t2 aligned (lat FLOAT encoding=Gorilla, lon FLOAT The` lat` and `lon` measurements are aligned. + ### Set Device Template After a device template is created, it should be set to specific path before creating related timeseries or insert data. diff --git a/src/UserGuide/Master/User-Manual/Operator-and-Expression.md b/src/UserGuide/Master/User-Manual/Operator-and-Expression.md index 1bc2604..53a0bc5 100644 --- a/src/UserGuide/Master/User-Manual/Operator-and-Expression.md +++ b/src/UserGuide/Master/User-Manual/Operator-and-Expression.md @@ -259,7 +259,7 @@ The functions in this function library are not built-in functions, and must be l 1. [Download](https://archive.apache.org/dist/iotdb/1.0.1/apache-iotdb-1.0.1-library-udf-bin.zip) the JAR with all dependencies and the script of registering UDF. 2. Copy the JAR package to `ext\udf` under the directory of IoTDB system (Please put JAR to this directory of all DataNodes if you use Cluster). -3. Run `sbin\start-server.bat` (for Windows) or `sbin\start-server.sh` (for Linux or MacOS) to start IoTDB server. +3. Run `sbin\start-confignode.bat` and then `sbin\start-datanode.bat` (for Windows) or `sbin\start-confignode.sh` and `sbin\start-datanode.sh` (for Linux or MacOS) to start IoTDB server. 4. Copy the script to the directory of IoTDB system (under the root directory, at the same level as `sbin`), modify the parameters in the script if needed and run it to register UDF. ### Implemented Functions @@ -342,7 +342,8 @@ Aggregate functions are many-to-one functions. They perform aggregate calculatio > select a, count(a) from root.sg group by ([10,100),10ms) > ``` -For the aggregation functions supported by IoTDB, see chapter 2.1 of this documentation. +For the aggregation functions supported by IoTDB, see the document [Aggregate Functions](../Reference/Function-and-Expression.md#aggregate-functions). + #### Time Series Generation Function diff --git a/src/UserGuide/latest/Deployment-and-Maintenance/Deployment-Guide_timecho.md b/src/UserGuide/latest/Deployment-and-Maintenance/Deployment-Guide_timecho.md index 7e64348..cde1133 100644 --- a/src/UserGuide/latest/Deployment-and-Maintenance/Deployment-Guide_timecho.md +++ b/src/UserGuide/latest/Deployment-and-Maintenance/Deployment-Guide_timecho.md @@ -162,7 +162,6 @@ IOTDB_JMX_OPTS="$IOTDB_JMX_OPTS -XX:MaxGCPauseMillis=200" | name | Confignode name | YES | | deploy\_dir | IoTDB config node deployment directory | YES | | iotdb-confignode.properties | Corresponding to `iotdb/config/iotdb-confignode.properties`, please refer to the `iotdb-confignode.properties` file description for more details. | NO | -| cn\_internal\_address | Corresponds to iotdb/internal communication address, corresponding to `cn_internal_address` in `iotdb/config/iotdb-confignode.properties` | YES | | cn_internal_address | The cluster configuration address points to the surviving ConfigNode, and it points to confignode_x by default. When `global` and `confignode_servers` are configured at the same time, the value in `confignode_servers` is used first, corresponding to `cn_internal_address` in `iotdb/config/iotdb-confignode.properties` | YES | | cn\_internal\_port | Internal communication port, corresponding to `cn_internal_port` in `iotdb/config/iotdb-confignode.properties` | YES | | cn\_consensus\_port | Corresponds to `cn_consensus_port` in `iotdb/config/iotdb-confignode.properties` | NO | diff --git a/src/UserGuide/latest/FAQ/Frequently-asked-questions.md b/src/UserGuide/latest/FAQ/Frequently-asked-questions.md index e9e7b13..f718599 100644 --- a/src/UserGuide/latest/FAQ/Frequently-asked-questions.md +++ b/src/UserGuide/latest/FAQ/Frequently-asked-questions.md @@ -96,7 +96,7 @@ By default settings, the data files (including tsfile, metadata, and WAL files) Use IoTDB's Command Line Interface: ``` -IoTDB> show timeseries root +IoTDB> show timeseries ``` In the result, there is a statement shows `Total timeseries number`, this number is the timeseries number in IoTDB. @@ -104,7 +104,7 @@ In the result, there is a statement shows `Total timeseries number`, this number In the current version, IoTDB supports querying the number of time series. Use IoTDB's Command Line Interface: ``` -IoTDB> count timeseries root +IoTDB> count timeseries ``` If you are using Linux, you can use the following shell command: @@ -116,7 +116,7 @@ If you are using Linux, you can use the following shell command: ### 5. Can I use Hadoop and Spark to read TsFile in IoTDB? -Yes. IoTDB has intense integration with Open Source Ecosystem. IoTDB supports [Hadoop](https://github.com/apache/iotdb/tree/master/hadoop), [Spark](https://github.com/apache/iotdb/tree/master/spark-tsfile) and [Grafana](https://github.com/apache/iotdb/tree/master/grafana-plugin) visualization tool. +Yes. IoTDB has intense integration with Open Source Ecosystem. IoTDB supports [Hadoop](https://github.com/apache/iotdb/tree/master/iotdb-connector/hadoop), [Spark](https://github.com/apache/iotdb/tree/master/iotdb-connector/spark-iotdb-connector) and [Grafana](https://github.com/apache/iotdb/tree/master/iotdb-connector/grafana-connector) visualization tool. ### 6. How does IoTDB handle duplicate points? @@ -126,10 +126,10 @@ A data point is uniquely identified by a full time series path (e.g. ```root.veh Use ```SHOW TIMESERIES <timeseries path>``` SQL in IoTDB's Command Line Interface: -For example, if you want to know the type of all timeseries, the \<timeseries path> should be `root`. The statement will be: +For example, if you want to know the type of all timeseries, the \<timeseries path> should be `root.**`. The statement will be: ``` -IoTDB> show timeseries root +IoTDB> show timeseries root.** ``` If you want to query specific sensor, you can replace the \<timeseries path> with the sensor name. For example: @@ -154,6 +154,9 @@ The default IoTDB's Cli time display format is readable (e.g. ```1970-01-01T08:0 ### 9. How to handle error `IndexOutOfBoundsException` from `org.apache.ratis.grpc.server.GrpcLogAppender`? +This is an internal error log from Ratis 2.4.1, our dependency, and no impact on data writes or reads is expected. +It has been reported to the Ratis community and will be fixed in the future releases. + ### 10. How to deal with estimated out of memory errors? Report an error message: diff --git a/src/UserGuide/latest/QuickStart/ClusterQuickStart.md b/src/UserGuide/latest/QuickStart/ClusterQuickStart.md index e5dea94..eb4fda3 100644 --- a/src/UserGuide/latest/QuickStart/ClusterQuickStart.md +++ b/src/UserGuide/latest/QuickStart/ClusterQuickStart.md @@ -72,10 +72,10 @@ Modify the specified configuration file according to the table below: | Configuration| Configuration Option | IP:192.168.132.10 | IP:192.168.132.11 | IP:192.168.132.12 | |------------|:-------------------------------|----------------------|----------------------|:---------------------| | iotdb-confignode.properties | cn\_internal\_address | 192.168.132.10 | 192.168.132.11 | 192.168.132.12 | -| | cn\_target\_config\_node\_list | 192.168.132.10:10710 | 192.168.132.10:10710 | 192.168.132.10:10710 | +| | cn_seed_config_node | 192.168.132.10:10710 | 192.168.132.10:10710 | 192.168.132.10:10710 | | iotdb-datanode.properties | dn\_rpc\_address | 192.168.132.10 | 192.168.132.11 | 192.168.132.12 | | | dn\_internal\_address | 192.168.132.10 | 192.168.132.11 | 192.168.132.12 | -| | dn\_target\_config\_node\_list | 192.168.132.10:10710 | 192.168.132.10:10710 | 192.168.132.10:10710 | +| | dn_seed_config_node | 192.168.132.10:10710 | 192.168.132.10:10710 | 192.168.132.10:10710 | **Notice:** It's recommended that the configurations of iotdb-common.properties and the heap size of JVM in all nodes are the same. diff --git a/src/UserGuide/latest/QuickStart/QuickStart.md b/src/UserGuide/latest/QuickStart/QuickStart.md index 45cc65e..a5fc87a 100644 --- a/src/UserGuide/latest/QuickStart/QuickStart.md +++ b/src/UserGuide/latest/QuickStart/QuickStart.md @@ -44,16 +44,6 @@ IoTDB provides you three installation methods, you can refer to the following su You can download the binary file from: [Download Page](https://iotdb.apache.org/Download/) -## Configurations - -Configuration files are under "conf" folder - - * environment config module (`datanode-env.bat`, `datanode-env.sh`), - * system config module (`iotdb-datanode.properties`) - * log config module (`logback.xml`). - -For more, see [Config](../Reference/DataNode-Config-Manual.md) in detail. - ## Start You can go through the following step to test the installation, if there is no error after execution, the installation is completed. @@ -230,7 +220,7 @@ ALTER USER <username> SET PASSWORD <password>; Example: IoTDB > ALTER USER root SET PASSWORD 'newpwd'; ``` -More about administration management:[Administration Management](https://iotdb.apache.org/UserGuide/V1.0.x/Administration-Management/Administration.html) +More about administration management:[Administration Management](../User-Manual/Authority-Management.md) ## Basic configuration diff --git a/src/UserGuide/latest/SQL-Manual/SQL-Manual.md b/src/UserGuide/latest/SQL-Manual/SQL-Manual.md index 8fbd4f9..ee94ba5 100644 --- a/src/UserGuide/latest/SQL-Manual/SQL-Manual.md +++ b/src/UserGuide/latest/SQL-Manual/SQL-Manual.md @@ -30,10 +30,6 @@ For more details, see document [Operate-Metadata](../User-Manual/Operate-Metadat ```sql IoTDB > create database root.ln IoTDB > create database root.sgcc -IoTDB> CREATE DATABASE root.ln.wf01 -Msg: 300: root.ln has already been created as database. -IoTDB> create database root.ln.wf01 -Msg: 300: root.ln has already been created as database. ``` ### Show Databases @@ -112,16 +108,9 @@ For more details, see document [Operate-Metadata](../User-Manual/Operate-Metadat ![img](https://alioss.timecho.com/docs/img/%E6%A8%A1%E6%9D%BF.png) +![img](https://alioss.timecho.com/docs/img/templateEN.jpg) -Create template(s1 int, s2 float) on root.sg - -Create device root.sg.d1 - - - -![img](https://alioss.timecho.com/docs/img/%E6%A8%A1%E6%9D%BF%E6%B5%81%E7%A8%8B.png) - ### Create Device Template **Example 1:** Create a template containing two non-aligned timeseires @@ -1348,7 +1337,7 @@ select rm(s0, s1,"tb"="3","vb"="2") from root.test.d0 ## LAMBDA EXPRESSION -For details and examples, see the document [Lambda](../Reference/Function-and-Expression#lambda-expression). +For details and examples, see the document [Lambda](../Reference/Function-and-Expression.md#lambda-expression). ```sql select jexl(temperature, 'expr'='x -> {x + x}') as jexl1, jexl(temperature, 'expr'='x -> {x * 3}') as jexl2, jexl(temperature, 'expr'='x -> {x * x}') as jexl3, jexl(temperature, 'expr'='x -> {multiply(x, 100)}') as jexl4, jexl(temperature, st, 'expr'='(x, y) -> {x + y}') as jexl5, jexl(temperature, st, str, 'expr'='(x, y, z) -> {x + y + z}') as jexl6 from root.ln.wf01.wt01;``` @@ -1356,7 +1345,7 @@ select jexl(temperature, 'expr'='x -> {x + x}') as jexl1, jexl(temperature, 'exp ## CONDITIONAL EXPRESSION -For details and examples, see the document [Conditional Expressions](../Reference/Function-and-Expression#conditional-expressions). +For details and examples, see the document [Conditional Expressions](../Reference/Function-and-Expression.md#conditional-expressions). ```sql select T, P, case diff --git a/src/UserGuide/latest/User-Manual/AINode_timecho.md b/src/UserGuide/latest/User-Manual/AINode_timecho.md index 927369d..ddd3879 100644 --- a/src/UserGuide/latest/User-Manual/AINode_timecho.md +++ b/src/UserGuide/latest/User-Manual/AINode_timecho.md @@ -437,12 +437,12 @@ where the labels of each row in the result set correspond to the model output co ## 5. Privilege Management -When using AINode related functions, the authentication of IoTDB itself can be used to do a permission management, users can only use the model management related functions when they have the USE_ML permission. When using the inference function, the user needs to have the permission to access the source sequence corresponding to the SQL of the input model. +When using AINode related functions, the authentication of IoTDB itself can be used to do a permission management, users can only use the model management related functions when they have the USE_MODEL permission. When using the inference function, the user needs to have the permission to access the source sequence corresponding to the SQL of the input model. | Privilege Name | Privilege Scope | Administrator User (default ROOT) | Normal User | Path Related | | --------- | --------------------------------- | ---------------------- | -------- | -------- | -| USE_MODEL | create model/show model/sdrop model | √ | √ √ | x | -| | | call inference | | | | | +| USE_MODEL | create model/show models/drop model | √ | √ | x | +| READ_DATA| call inference | √ | √|√ | ## 6. Practical Examples diff --git a/src/UserGuide/latest/User-Manual/IoTDB-View_timecho.md b/src/UserGuide/latest/User-Manual/IoTDB-View_timecho.md index 6595b59..ac0bb02 100644 --- a/src/UserGuide/latest/User-Manual/IoTDB-View_timecho.md +++ b/src/UserGuide/latest/User-Manual/IoTDB-View_timecho.md @@ -308,7 +308,7 @@ AS SELECT temperature FROM root.db.* ``` -This is modelled on the query writeback (`SELECT INTO`) convention for naming rules, which uses variable placeholders to specify naming rules. See also: [QUERY WRITEBACK (SELECT INTO)](https://iotdb.apache.org/zh/UserGuide/Master/Query-Data/Select-Into.html) +This is modelled on the query writeback (`SELECT INTO`) convention for naming rules, which uses variable placeholders to specify naming rules. See also: [QUERY WRITEBACK (SELECT INTO)](../User-Manual/Query-Data.md#into-clause-query-write-back) Here `root.db.*.temperature` specifies what time series will be included in the view; and `${2}` specifies from which node in the time series the name is extracted to name the sequence view. diff --git a/src/UserGuide/latest/User-Manual/Operate-Metadata.md b/src/UserGuide/latest/User-Manual/Operate-Metadata.md index fa1b10c..fdfe893 100644 --- a/src/UserGuide/latest/User-Manual/Operate-Metadata.md +++ b/src/UserGuide/latest/User-Manual/Operate-Metadata.md @@ -315,7 +315,6 @@ IoTDB> show all ttl IoTDB supports the device template function, enabling different entities of the same type to share metadata, reduce the memory usage of metadata, and simplify the management of numerous entities and measurements. -Note: The `device` keyword in the following statements can be omitted. ### Create Device Template @@ -339,6 +338,10 @@ IoTDB> create device template t2 aligned (lat FLOAT encoding=Gorilla, lon FLOAT The` lat` and `lon` measurements are aligned. +![img](https://alioss.timecho.com/docs/img/%E6%A8%A1%E6%9D%BF.png) + +![img](https://alioss.timecho.com/docs/img/templateEN.jpg) + ### Set Device Template After a device template is created, it should be set to specific path before creating related timeseries or insert data. diff --git a/src/UserGuide/latest/User-Manual/Operator-and-Expression.md b/src/UserGuide/latest/User-Manual/Operator-and-Expression.md index 5e410d2..f3bc5e4 100644 --- a/src/UserGuide/latest/User-Manual/Operator-and-Expression.md +++ b/src/UserGuide/latest/User-Manual/Operator-and-Expression.md @@ -258,7 +258,7 @@ The functions in this function library are not built-in functions, and must be l 1. [Download](https://archive.apache.org/dist/iotdb/1.0.1/apache-iotdb-1.0.1-library-udf-bin.zip) the JAR with all dependencies and the script of registering UDF. 2. Copy the JAR package to `ext\udf` under the directory of IoTDB system (Please put JAR to this directory of all DataNodes if you use Cluster). -3. Run `sbin\start-server.bat` (for Windows) or `sbin\start-server.sh` (for Linux or MacOS) to start IoTDB server. +3. Run `sbin\start-confignode.bat` and then `sbin\start-datanode.bat` (for Windows) or `sbin\start-confignode.sh` and `sbin\start-datanode.sh` (for Linux or MacOS) to start IoTDB server. 4. Copy the script to the directory of IoTDB system (under the root directory, at the same level as `sbin`), modify the parameters in the script if needed and run it to register UDF. ### Implemented Functions @@ -341,7 +341,8 @@ Aggregate functions are many-to-one functions. They perform aggregate calculatio > select a, count(a) from root.sg group by ([10,100),10ms) > ``` -For the aggregation functions supported by IoTDB, see chapter 2.1 of this documentation. +For the aggregation functions supported by IoTDB, see the document [Aggregate Functions](../Reference/Function-and-Expression.md#aggregate-functions). + #### Time Series Generation Function diff --git a/src/zh/UserGuide/Master/FAQ/Frequently-asked-questions.md b/src/zh/UserGuide/Master/FAQ/Frequently-asked-questions.md index 8a6d93b..f569c40 100644 --- a/src/zh/UserGuide/Master/FAQ/Frequently-asked-questions.md +++ b/src/zh/UserGuide/Master/FAQ/Frequently-asked-questions.md @@ -98,7 +98,7 @@ Readme.md 使用 IoTDB 的命令行接口: ``` -IoTDB> show timeseries root +IoTDB> show timeseries ``` 在返回的结果里,会展示`Total timeseries number`,这个数据就是 IoTDB 中 timeseries 的数量。 @@ -106,7 +106,7 @@ IoTDB> show timeseries root 在当前版本中,IoTDB 支持直接使用命令行接口查询时间序列的数量: ``` -IoTDB> count timeseries root +IoTDB> count timeseries ``` 如果您使用的是 Linux 操作系统,您可以使用以下的 Shell 命令: @@ -118,7 +118,7 @@ IoTDB> count timeseries root ### 5. 可以使用Hadoop和Spark读取IoTDB中的TsFile吗? -是的。IoTDB 与开源生态紧密结合。IoTDB 支持 [Hadoop](https://github.com/apache/iotdb/tree/master/hadoop), [Spark](https://github.com/apache/iotdb/tree/master/spark-tsfile) 和 [Grafana](https://github.com/apache/iotdb/tree/master/grafana) 可视化工具。 +是的。IoTDB 与开源生态紧密结合。IoTDB 支持 [Hadoop](https://github.com/apache/iotdb/tree/master/iotdb-connector/hadoop), [Spark](https://github.com/apache/iotdb/tree/master/iotdb-connector/spark-iotdb-connector) 和 [Grafana](https://github.com/apache/iotdb/tree/master/iotdb-connector/grafana-connector) 可视化工具。 ### 6. IoTDB如何处理重复的数据点? @@ -128,10 +128,10 @@ IoTDB> count timeseries root 在 IoTDB 的命令行接口中使用 SQL ```SHOW TIMESERIES <timeseries path>```: -例如:如果您想知道所有 timeseries 的类型 \<timeseries path> 应该为 `root`。上面的 SQL 应该修改为: +例如:如果您想知道所有 timeseries 的类型 \<timeseries path> 应该为 `root.**`。上面的 SQL 应该修改为: ``` -IoTDB> show timeseries root +IoTDB> show timeseries root.** ``` 如果您想查询一个指定的时间序列,您可以修改 \<timeseries path> 为时间序列的完整路径。比如: diff --git a/src/zh/UserGuide/Master/SQL-Manual/SQL-Manual.md b/src/zh/UserGuide/Master/SQL-Manual/SQL-Manual.md index 45ff773..bcdd9a8 100644 --- a/src/zh/UserGuide/Master/SQL-Manual/SQL-Manual.md +++ b/src/zh/UserGuide/Master/SQL-Manual/SQL-Manual.md @@ -8,9 +8,6 @@ ```sql CREATE DATABASE root.ln - -CREATE DATABASE root.ln.wf01 -> Msg: 300: root.ln has already been created as database. ``` #### 查看数据库 @@ -253,16 +250,9 @@ IoTDB> count devices root.ln.** ![img](https://alioss.timecho.com/docs/img/%E6%A8%A1%E6%9D%BF.png) +![img](https://alioss.timecho.com/docs/img/template.jpg) -Create template(s1 int, s2 float) on root.sg - -Create device root.sg.d1 - - - -![img](https://alioss.timecho.com/docs/img/%E6%A8%A1%E6%9D%BF%E6%B5%81%E7%A8%8B.png) - #### 创建设备模板 ```Go diff --git a/src/zh/UserGuide/Master/User-Manual/AINode_timecho.md b/src/zh/UserGuide/Master/User-Manual/AINode_timecho.md index 469adbd..22f9d89 100644 --- a/src/zh/UserGuide/Master/User-Manual/AINode_timecho.md +++ b/src/zh/UserGuide/Master/User-Manual/AINode_timecho.md @@ -436,12 +436,12 @@ Total line number = 4 ## 5. 权限管理 -使用AINode相关的功能时,可以使用IoTDB本身的鉴权去做一个权限管理,用户只有在具备USE_ML权限时,才可以使用模型管理的相关功能。当使用推理功能时,用户需要有访问输入模型的SQL对应的源序列的权限。 +使用AINode相关的功能时,可以使用IoTDB本身的鉴权去做一个权限管理,用户只有在具备 USE_MODEL 权限时,才可以使用模型管理的相关功能。当使用推理功能时,用户需要有访问输入模型的SQL对应的源序列的权限。 -| 权限名称 | 权限范围 | 管理员用户(默认ROOT) | 普通用户 | 路径相关 | +| 权限名称 | 权限范围 | 管理员用户(默认ROOT) | 普通用户 | 路径相关 | | --------- | --------------------------------- | ---------------------- | -------- | -------- | -| USE_MODEL | create model / show models / drop model | √ | √ | x | -| | call inference | | | | +| USE_MODEL | create model / show models / drop model | √ | √ | x | +| READ_DATA | call inference | √ | √ | √ | ## 6. 实际案例 diff --git a/src/zh/UserGuide/Master/User-Manual/Operate-Metadata.md b/src/zh/UserGuide/Master/User-Manual/Operate-Metadata.md index e08eeba..8e8b262 100644 --- a/src/zh/UserGuide/Master/User-Manual/Operate-Metadata.md +++ b/src/zh/UserGuide/Master/User-Manual/Operate-Metadata.md @@ -303,7 +303,10 @@ It costs 0.058s IoTDB 支持设备模板功能,实现同类型不同实体的物理量元数据共享,减少元数据内存占用,同时简化同类型实体的管理。 -注:以下语句中的 `device` 关键字可以省略。 + +![img](https://alioss.timecho.com/docs/img/%E6%A8%A1%E6%9D%BF.png) + +![img](https://alioss.timecho.com/docs/img/template.jpg) ### 创建设备模板 diff --git a/src/zh/UserGuide/Master/User-Manual/Syntax-Rule.md b/src/zh/UserGuide/Master/User-Manual/Syntax-Rule.md index 7b74d14..f131d73 100644 --- a/src/zh/UserGuide/Master/User-Manual/Syntax-Rule.md +++ b/src/zh/UserGuide/Master/User-Manual/Syntax-Rule.md @@ -278,7 +278,7 @@ create schema template `t1't"t` 关键字是在 SQL 具有特定含义的词,可以作为标识符。保留字是关键字的一个子集,保留字不能用于标识符。 -关于 IoTDB 的关键字列表,可以查看 [关键字](https://iotdb.apache.org/zh/UserGuide/Master/Reference/Keywords.html) 。 +关于 IoTDB 的关键字列表,可以查看 [关键字](../Reference/Keywords.md) 。 ## 词法与文法详细定义 diff --git a/src/zh/UserGuide/latest/Basic-Concept/Encoding-and-Compression.md b/src/zh/UserGuide/latest/Basic-Concept/Encoding-and-Compression.md index 5eff25a..8be0d4e 100644 --- a/src/zh/UserGuide/latest/Basic-Concept/Encoding-and-Compression.md +++ b/src/zh/UserGuide/latest/Basic-Concept/Encoding-and-Compression.md @@ -115,7 +115,7 @@ IoTDB 允许在创建一个时间序列的时候指定该列的压缩方式。 ### 压缩比统计信息 -压缩比统计信息文件:data/system/compression_ratio/Ratio-{ratio_sum}-{memtable_flush_time} +压缩比统计信息文件:data/datanode/system/compression_ratio/Ratio-{ratio_sum}-{memtable_flush_time} * ratio_sum: memtable压缩比的总和 * memtable_flush_time: memtable刷盘的总次数 diff --git a/src/zh/UserGuide/latest/FAQ/Frequently-asked-questions.md b/src/zh/UserGuide/latest/FAQ/Frequently-asked-questions.md index 8a6d93b..f569c40 100644 --- a/src/zh/UserGuide/latest/FAQ/Frequently-asked-questions.md +++ b/src/zh/UserGuide/latest/FAQ/Frequently-asked-questions.md @@ -98,7 +98,7 @@ Readme.md 使用 IoTDB 的命令行接口: ``` -IoTDB> show timeseries root +IoTDB> show timeseries ``` 在返回的结果里,会展示`Total timeseries number`,这个数据就是 IoTDB 中 timeseries 的数量。 @@ -106,7 +106,7 @@ IoTDB> show timeseries root 在当前版本中,IoTDB 支持直接使用命令行接口查询时间序列的数量: ``` -IoTDB> count timeseries root +IoTDB> count timeseries ``` 如果您使用的是 Linux 操作系统,您可以使用以下的 Shell 命令: @@ -118,7 +118,7 @@ IoTDB> count timeseries root ### 5. 可以使用Hadoop和Spark读取IoTDB中的TsFile吗? -是的。IoTDB 与开源生态紧密结合。IoTDB 支持 [Hadoop](https://github.com/apache/iotdb/tree/master/hadoop), [Spark](https://github.com/apache/iotdb/tree/master/spark-tsfile) 和 [Grafana](https://github.com/apache/iotdb/tree/master/grafana) 可视化工具。 +是的。IoTDB 与开源生态紧密结合。IoTDB 支持 [Hadoop](https://github.com/apache/iotdb/tree/master/iotdb-connector/hadoop), [Spark](https://github.com/apache/iotdb/tree/master/iotdb-connector/spark-iotdb-connector) 和 [Grafana](https://github.com/apache/iotdb/tree/master/iotdb-connector/grafana-connector) 可视化工具。 ### 6. IoTDB如何处理重复的数据点? @@ -128,10 +128,10 @@ IoTDB> count timeseries root 在 IoTDB 的命令行接口中使用 SQL ```SHOW TIMESERIES <timeseries path>```: -例如:如果您想知道所有 timeseries 的类型 \<timeseries path> 应该为 `root`。上面的 SQL 应该修改为: +例如:如果您想知道所有 timeseries 的类型 \<timeseries path> 应该为 `root.**`。上面的 SQL 应该修改为: ``` -IoTDB> show timeseries root +IoTDB> show timeseries root.** ``` 如果您想查询一个指定的时间序列,您可以修改 \<timeseries path> 为时间序列的完整路径。比如: diff --git a/src/zh/UserGuide/latest/SQL-Manual/SQL-Manual.md b/src/zh/UserGuide/latest/SQL-Manual/SQL-Manual.md index b77beee..9d81aba 100644 --- a/src/zh/UserGuide/latest/SQL-Manual/SQL-Manual.md +++ b/src/zh/UserGuide/latest/SQL-Manual/SQL-Manual.md @@ -8,9 +8,6 @@ ```sql CREATE DATABASE root.ln - -CREATE DATABASE root.ln.wf01 -> Msg: 300: root.ln has already been created as database. ``` #### 查看数据库 @@ -251,17 +248,11 @@ IoTDB> count devices root.ln.** ``` ### 4、设备模板管理 -![img](https://alioss.timecho.com/docs/img/%E6%A8%A1%E6%9D%BF.png) - - - -Create template(s1 int, s2 float) on root.sg - -Create device root.sg.d1 +![img](https://alioss.timecho.com/docs/img/%E6%A8%A1%E6%9D%BF.png) +![img](https://alioss.timecho.com/docs/img/template.jpg) -![img](https://alioss.timecho.com/docs/img/%E6%A8%A1%E6%9D%BF%E6%B5%81%E7%A8%8B.png) #### 创建设备模板 diff --git a/src/zh/UserGuide/latest/User-Manual/AINode_timecho.md b/src/zh/UserGuide/latest/User-Manual/AINode_timecho.md index 469adbd..22f9d89 100644 --- a/src/zh/UserGuide/latest/User-Manual/AINode_timecho.md +++ b/src/zh/UserGuide/latest/User-Manual/AINode_timecho.md @@ -436,12 +436,12 @@ Total line number = 4 ## 5. 权限管理 -使用AINode相关的功能时,可以使用IoTDB本身的鉴权去做一个权限管理,用户只有在具备USE_ML权限时,才可以使用模型管理的相关功能。当使用推理功能时,用户需要有访问输入模型的SQL对应的源序列的权限。 +使用AINode相关的功能时,可以使用IoTDB本身的鉴权去做一个权限管理,用户只有在具备 USE_MODEL 权限时,才可以使用模型管理的相关功能。当使用推理功能时,用户需要有访问输入模型的SQL对应的源序列的权限。 -| 权限名称 | 权限范围 | 管理员用户(默认ROOT) | 普通用户 | 路径相关 | +| 权限名称 | 权限范围 | 管理员用户(默认ROOT) | 普通用户 | 路径相关 | | --------- | --------------------------------- | ---------------------- | -------- | -------- | -| USE_MODEL | create model / show models / drop model | √ | √ | x | -| | call inference | | | | +| USE_MODEL | create model / show models / drop model | √ | √ | x | +| READ_DATA | call inference | √ | √ | √ | ## 6. 实际案例 diff --git a/src/zh/UserGuide/latest/User-Manual/Operate-Metadata.md b/src/zh/UserGuide/latest/User-Manual/Operate-Metadata.md index e08eeba..8e8b262 100644 --- a/src/zh/UserGuide/latest/User-Manual/Operate-Metadata.md +++ b/src/zh/UserGuide/latest/User-Manual/Operate-Metadata.md @@ -303,7 +303,10 @@ It costs 0.058s IoTDB 支持设备模板功能,实现同类型不同实体的物理量元数据共享,减少元数据内存占用,同时简化同类型实体的管理。 -注:以下语句中的 `device` 关键字可以省略。 + +![img](https://alioss.timecho.com/docs/img/%E6%A8%A1%E6%9D%BF.png) + +![img](https://alioss.timecho.com/docs/img/template.jpg) ### 创建设备模板 diff --git a/src/zh/UserGuide/latest/User-Manual/Syntax-Rule.md b/src/zh/UserGuide/latest/User-Manual/Syntax-Rule.md index 7b74d14..f131d73 100644 --- a/src/zh/UserGuide/latest/User-Manual/Syntax-Rule.md +++ b/src/zh/UserGuide/latest/User-Manual/Syntax-Rule.md @@ -278,7 +278,7 @@ create schema template `t1't"t` 关键字是在 SQL 具有特定含义的词,可以作为标识符。保留字是关键字的一个子集,保留字不能用于标识符。 -关于 IoTDB 的关键字列表,可以查看 [关键字](https://iotdb.apache.org/zh/UserGuide/Master/Reference/Keywords.html) 。 +关于 IoTDB 的关键字列表,可以查看 [关键字](../Reference/Keywords.md) 。 ## 词法与文法详细定义