From 98ac536c9d8cf0de584cef0f4d905db82d5332d2 Mon Sep 17 00:00:00 2001 From: SailVR <16231015@bjtu.edu.cn> Date: Sun, 29 Mar 2020 17:52:36 +0800 Subject: [PATCH] modify master docs --- docs/UserGuide/0-Get Started/1-QuickStart.md | 8 ++-- docs/UserGuide/2-Concept/.~2-Data Type.md | 43 +++++++++++++++++++ .../2-Concept/1-Data Model and Terminology.md | 4 +- docs/UserGuide/2-Concept/2-Data Type.md | 2 +- docs/UserGuide/2-Concept/3-Encoding.md | 2 +- docs/UserGuide/2-Concept/4-Compression.md | 2 +- docs/UserGuide/3-Server/1-Download.md | 6 +-- .../4-Client/5-Programming - TsFile API.md | 2 +- .../1-DDL Data Definition Language.md | 4 +- .../2-DML Data Manipulation Language.md | 22 +++++----- .../3-Account Management Statements.md | 2 +- .../6-System Tools/7-Monitor and Log Tools.md | 4 +- .../7-Ecosystem Integration/3-Spark TsFile.md | 2 +- .../7-Ecosystem Integration/4-Spark IoTDB.md | 2 +- docs/UserGuide/8-Architecture/1-Files.md | 8 ++-- .../UserGuide/0-Get Started/1-QuickStart.md | 8 ++-- .../2-Concept/1-Data Model and Terminology.md | 6 ++- docs/zh/UserGuide/2-Concept/2-Data Type.md | 2 +- docs/zh/UserGuide/2-Concept/4-Compression.md | 2 +- docs/zh/UserGuide/3-Server/1-Download.md | 6 +-- .../4-Client/5-Programming - TsFile API.md | 2 +- .../1-DDL Data Definition Language.md | 4 +- .../2-DML Data Manipulation Language.md | 18 ++++---- .../3-Account Management Statements.md | 4 +- .../6-System Tools/7-Monitor and Log Tools.md | 6 +-- .../7-Ecosystem Integration/3-Spark TsFile.md | 2 +- .../7-Ecosystem Integration/4-Spark IoTDB.md | 2 +- docs/zh/UserGuide/8-Architecture/1-Files.md | 8 ++-- 28 files changed, 114 insertions(+), 69 deletions(-) create mode 100644 docs/UserGuide/2-Concept/.~2-Data Type.md diff --git a/docs/UserGuide/0-Get Started/1-QuickStart.md b/docs/UserGuide/0-Get Started/1-QuickStart.md index a1c2f0e450c8..4786bde332f2 100755 --- a/docs/UserGuide/0-Get Started/1-QuickStart.md +++ b/docs/UserGuide/0-Get Started/1-QuickStart.md @@ -39,7 +39,7 @@ -This short guide will walk you through the basic process of using IoTDB. For a more-complete guide, please visit our website's [User Guide](/document/master/UserGuide/1-Overview/1-What%20is%20IoTDB.html). +This short guide will walk you through the basic process of using IoTDB. For a more-complete guide, please visit our website's [User Guide](../1-Overview/1-What%20is%20IoTDB.html). ## Prerequisites @@ -62,7 +62,7 @@ Here in the Quick Start, we give a brief introduction to install IoTDB. For furt ## Download You can download the binary file from: -[Here](/download/) +[Here](/Download/) ## Configurations @@ -72,7 +72,7 @@ configuration files are under "conf" folder * system config module (`tsfile-format.properties`, `iotdb-engine.properties`) * log config module (`logback.xml`). -For more, see [Chapter3: Server](/document/master/UserGuide/3-Server/1-Download.html) in detail. +For more, see [Chapter3: Server](../3-Server/1-Download.html) in detail. ## Start @@ -230,7 +230,7 @@ or IoTDB> exit ``` -For more on what commands are supported by IoTDB SQL, see [SQL Reference](/document/master/UserGuide/5-Operation%20Manual/4-SQL%20Reference.html). +For more on what commands are supported by IoTDB SQL, see [SQL Reference](../5-Operation%20Manual/4-SQL%20Reference.html). ### Stop IoTDB diff --git a/docs/UserGuide/2-Concept/.~2-Data Type.md b/docs/UserGuide/2-Concept/.~2-Data Type.md new file mode 100644 index 000000000000..ebfece96a9b0 --- /dev/null +++ b/docs/UserGuide/2-Concept/.~2-Data Type.md @@ -0,0 +1,43 @@ + + +# Data Type + +IoTDB supports six data types in total: +* BOOLEAN (Boolean) +* INT32 (Integer) +* INT64 (Long Integer) +* FLOAT (Single Precision Floating Point) +* DOUBLE (Double Precision Floating Point) +* TEXT (String). + + +The time series of **FLOAT** and **DOUBLE** type can specify (MAX\_POINT\_NUMBER, see [this page](../5-Operation%20Manual/4-SQL%20Reference.html) for more information on how to specify), which is the number of digits after the decimal point of the floating point number, if the encoding method is [RLE](../2-Concept/3-Encoding.html) or [TS\_2DIFF](../2-Concept/3-Encoding.html) (Refer to [Create Timeseries Statement](../5-Operation%20Manual/4-SQL%20Reference.html) for more information on how to specify). If MAX\_POINT\_NUMBER is not specified, the system will use [float\_precision](../3-Server/4-Config%20Manual.html) in the configuration file `tsfile-format.properties`. + +* For Float data value, The data range is (-Integer.MAX_VALUE, Integer.MAX_VALUE), rather than Float.MAX_VALUE, and the max_point_number is 19, it is because of the limition of function Math.round(float) in Java. +* For Double data value, The data range is (-Long.MAX_VALUE, Long.MAX_VALUE), rather than Double.MAX_VALUE, and the max_point_number is 19, it is because of the limition of function Math.round(double) in Java (Long.MAX_VALUE=9.22E18). + +When the data type of data input by the user in the system does not correspond to the data type of the time series, the system will report type errors. As shown below, the second-order difference encoding does not support the Boolean type: + +``` +IoTDB> create timeseries root.ln.wf02.wt02.status WITH DATATYPE=BOOLEAN, ENCODING=TS_2DIFF +error: encoding TS_2DIFF does not support BOOLEAN +``` diff --git a/docs/UserGuide/2-Concept/1-Data Model and Terminology.md b/docs/UserGuide/2-Concept/1-Data Model and Terminology.md index 6242fe57055d..268264b259b6 100644 --- a/docs/UserGuide/2-Concept/1-Data Model and Terminology.md +++ b/docs/UserGuide/2-Concept/1-Data Model and Terminology.md @@ -23,9 +23,9 @@ To make this manual more practical, we will use a specific scenario example to illustrate how to operate IoTDB databases at all stages of use. See [this page](https://github.com/apache/incubator-iotdb/blob/master/docs/Documentation/OtherMaterial-Sample%20Data.txt) for a look. For convenience, we also provide you with a sample data file in real scenario to import into the IoTDB system for trial and operation. -Download file: [SampleData.txt](https://github.com/apache/incubator-iotdb/tree/master/docs/SampleData.txt). +Download file: [IoTDB-SampleData.txt](https://raw.githubusercontent.com/apache/incubator-iotdb/master/docs/Documentation/OtherMaterial-Sample%20Data.txt). -According to the data attribute layers described in the SampleData, we can express it as an attribute hierarchy structure based on the coverage of attributes and the subordinate relationship between them, as shown in Figure 2.1 below. Its hierarchical relationship is: power group layer - power plant layer - device layer - sensor layer. ROOT is the root node, and each node of sensor layer is called a leaf node. In the process of using IoTDB, you can directly connect the attributes on the path from ROOT node to each leaf node with ".", thus forming the name of a timeseries in IoTDB. For example, The left-most path in Figure 2.1 can generate a timeseries named `ROOT.ln.wf01.wt01.status`. +According to the data attribute layers described in [sample data](https://raw.githubusercontent.com/apache/incubator-iotdb/master/docs/Documentation/OtherMaterial-Sample%20Data.txt), we can express it as an attribute hierarchy structure based on the coverage of attributes and the subordinate relationship between them, as shown in Figure 2.1 below. Its hierarchical relationship is: power group layer - power plant layer - device layer - sensor layer. ROOT is the root node, and each node of sensor layer is called a leaf node. In the process of using IoTDB, you can directly connect the attributes on the path from ROOT node to each leaf node with ".", thus forming the name of a timeseries in IoTDB. For example, The left-most path in Figure 2.1 can generate a timeseries named `ROOT.ln.wf01.wt01.status`.
diff --git a/docs/UserGuide/2-Concept/2-Data Type.md b/docs/UserGuide/2-Concept/2-Data Type.md index 2a0262ed5366..ebfece96a9b0 100644 --- a/docs/UserGuide/2-Concept/2-Data Type.md +++ b/docs/UserGuide/2-Concept/2-Data Type.md @@ -30,7 +30,7 @@ IoTDB supports six data types in total: * TEXT (String). -The time series of **FLOAT** and **DOUBLE** type can specify (MAX\_POINT\_NUMBER, see [this page](/document/master/UserGuide/5-Operation%20Manual/4-SQL%20Reference.html) for more information on how to specify), which is the number of digits after the decimal point of the floating point number, if the encoding method is [RLE](/document/master/UserGuide/2-Concept/3-Encoding.html) or [TS\_2DIFF](/#/Documents/progress/chap2/sec3) (Refer to [Create Timeseries Statement](/document/master/UserGuide/5-Operation%20Manual/4-SQL%20Reference.html) for more information on how to specify). If MAX\_POINT\_NUMBER is not specified, the system will use [float\_precision](/document/master/UserGuide/3-Server/4-Config%20Manual.html) in the configuration file `tsfile-format.properties`. +The time series of **FLOAT** and **DOUBLE** type can specify (MAX\_POINT\_NUMBER, see [this page](../5-Operation%20Manual/4-SQL%20Reference.html) for more information on how to specify), which is the number of digits after the decimal point of the floating point number, if the encoding method is [RLE](../2-Concept/3-Encoding.html) or [TS\_2DIFF](../2-Concept/3-Encoding.html) (Refer to [Create Timeseries Statement](../5-Operation%20Manual/4-SQL%20Reference.html) for more information on how to specify). If MAX\_POINT\_NUMBER is not specified, the system will use [float\_precision](../3-Server/4-Config%20Manual.html) in the configuration file `tsfile-format.properties`. * For Float data value, The data range is (-Integer.MAX_VALUE, Integer.MAX_VALUE), rather than Float.MAX_VALUE, and the max_point_number is 19, it is because of the limition of function Math.round(float) in Java. * For Double data value, The data range is (-Long.MAX_VALUE, Long.MAX_VALUE), rather than Double.MAX_VALUE, and the max_point_number is 19, it is because of the limition of function Math.round(double) in Java (Long.MAX_VALUE=9.22E18). diff --git a/docs/UserGuide/2-Concept/3-Encoding.md b/docs/UserGuide/2-Concept/3-Encoding.md index a1f403cfd6ef..c715fb2afcde 100644 --- a/docs/UserGuide/2-Concept/3-Encoding.md +++ b/docs/UserGuide/2-Concept/3-Encoding.md @@ -35,7 +35,7 @@ Second-order differential encoding is more suitable for encoding monotonically i Run-length encoding is more suitable for storing sequence with continuous integer values, and is not recommended for sequence data with most of the time different values. -Run-length encoding can also be used to encode floating-point numbers, but it is necessary to specify reserved decimal digits (MAX\_POINT\_NUMBER, see [this page](/document/master/UserGuide/5-Operation%20Manual/4-SQL%20Reference.html) for more information on how to specify) when creating time series. It is more suitable for storing sequence data where floating-point values appear continuously, monotonously increasing or decreasing, and it is not suitable for storing sequence data with high precision requirements after the decimal point or with large fluctuations. +Run-length encoding can also be used to encode floating-point numbers, but it is necessary to specify reserved decimal digits (MAX\_POINT\_NUMBER, see [this page](../5-Operation%20Manual/4-SQL%20Reference.html) for more information on how to specify) when creating time series. It is more suitable for storing sequence data where floating-point values appear continuously, monotonously increasing or decreasing, and it is not suitable for storing sequence data with high precision requirements after the decimal point or with large fluctuations. * GORILLA diff --git a/docs/UserGuide/2-Concept/4-Compression.md b/docs/UserGuide/2-Concept/4-Compression.md index 1a45352ec27f..7a1c3dd6a15a 100644 --- a/docs/UserGuide/2-Concept/4-Compression.md +++ b/docs/UserGuide/2-Concept/4-Compression.md @@ -29,4 +29,4 @@ IoTDB allows you to specify the compression method of the column when creating a * SNAPPY -The specified syntax for compression is detailed in [Create Timeseries Statement](/document/master/UserGuide/5-Operation%20Manual/4-SQL%20Reference.html). +The specified syntax for compression is detailed in [Create Timeseries Statement](../5-Operation%20Manual/4-SQL%20Reference.html). diff --git a/docs/UserGuide/3-Server/1-Download.md b/docs/UserGuide/3-Server/1-Download.md index d548c5992151..a2bd30a82896 100644 --- a/docs/UserGuide/3-Server/1-Download.md +++ b/docs/UserGuide/3-Server/1-Download.md @@ -40,11 +40,11 @@ To use IoTDB, you need to have: >### Installation from binary files You can download the binary file from: -[Here](/download/) +[Here](/Download/) ## Installation from source code -You can get the released source code from https://iotdb.apache.org/#/Download, or from the git repository https://github.com/apache/incubator-iotdb/tree/master +You can get the released source code from https://iotdb.apache.org/Download/, or from the git repository https://github.com/apache/incubator-iotdb/tree/master You can download the source code from: ``` @@ -71,4 +71,4 @@ After build, the IoTDB server will be at the folder "server/target/iotdb-server- ## Installation by Docker (Dockerfile) -You can build and run a IoTDB docker image by following the guide of [Deployment by Docker](/document/master/UserGuide/3-Server/5-Docker%20Image.html) +You can build and run a IoTDB docker image by following the guide of [Deployment by Docker](../3-Server/5-Docker%20Image.html) diff --git a/docs/UserGuide/4-Client/5-Programming - TsFile API.md b/docs/UserGuide/4-Client/5-Programming - TsFile API.md index 69378ea63da3..27cb396d9262 100644 --- a/docs/UserGuide/4-Client/5-Programming - TsFile API.md +++ b/docs/UserGuide/4-Client/5-Programming - TsFile API.md @@ -226,7 +226,7 @@ A TsFile can be generated by following three steps and the complete code will be * type: The data type, now support six types: `BOOLEAN`, `INT32`, `INT64`, `FLOAT`, `DOUBLE`, `TEXT`; - * encoding: The data encoding. See [Chapter 2-3](/document/master/UserGuide/2-Concept/3-Encoding.html). + * encoding: The data encoding. See [Chapter 2-3](../2-Concept/3-Encoding.html). * compression: The data compression. Now supports `UNCOMPRESSED` and `SNAPPY`. diff --git a/docs/UserGuide/5-Operation Manual/1-DDL Data Definition Language.md b/docs/UserGuide/5-Operation Manual/1-DDL Data Definition Language.md index ba6ec988f7f5..6c2d4fe19885 100644 --- a/docs/UserGuide/5-Operation Manual/1-DDL Data Definition Language.md +++ b/docs/UserGuide/5-Operation Manual/1-DDL Data Definition Language.md @@ -41,7 +41,7 @@ Msg: org.apache.iotdb.exception.MetadataErrorException: org.apache.iotdb.excepti ## Show Storage Group -After the storage group is created, we can use the [SHOW STORAGE GROUP](/document/master/UserGuide/5-Operation%20Manual/4-SQL%20Reference.html) statement to view all the storage groups. The SQL statement is as follows: +After the storage group is created, we can use the [SHOW STORAGE GROUP](../5-Operation%20Manual/4-SQL%20Reference.html) statement to view all the storage groups. The SQL statement is as follows: ``` IoTDB> show storage group @@ -70,7 +70,7 @@ IoTDB> create timeseries root.ln.wf02.wt02.status WITH DATATYPE=BOOLEAN, ENCODIN error: encoding TS_2DIFF does not support BOOLEAN ``` -Please refer to [Encoding](/document/master/UserGuide/2-Concept/3-Encoding.html) for correspondence between data type and encoding. +Please refer to [Encoding](../2-Concept/3-Encoding.html) for correspondence between data type and encoding. ## Show Timeseries diff --git a/docs/UserGuide/5-Operation Manual/2-DML Data Manipulation Language.md b/docs/UserGuide/5-Operation Manual/2-DML Data Manipulation Language.md index 09e921cebdc4..50ea02d0b6c3 100644 --- a/docs/UserGuide/5-Operation Manual/2-DML Data Manipulation Language.md +++ b/docs/UserGuide/5-Operation Manual/2-DML Data Manipulation Language.md @@ -24,12 +24,12 @@ ## INSERT ### Insert Real-time Data -IoTDB provides users with a variety of ways to insert real-time data, such as directly inputting [INSERT SQL statement](/document/master/UserGuide/5-Operation%20Manual/4-SQL%20Reference.html) in [Client/Shell tools](/document/master/UserGuide/4-Client/1-Command%20Line%20Interface.html), or using [Java JDBC](/document/master/UserGuide/4-Client/3-Programming%20-%20JDBC.html) to perform single or batch execution of [INSERT SQL statement](/#/Documents/progress/chap5/sec4). +IoTDB provides users with a variety of ways to insert real-time data, such as directly inputting [INSERT SQL statement](../5-Operation%20Manual/4-SQL%20Reference.html) in [Client/Shell tools](../4-Client/1-Command%20Line%20Interface.html), or using [Java JDBC](../4-Client/3-Programming%20-%20JDBC.html) to perform single or batch execution of [INSERT SQL statement](/#/Documents/progress/chap5/sec4). -This section mainly introduces the use of [INSERT SQL statement](/#/Documents/progress/chap5/sec4) for real-time data import in the scenario. See Section 5.4 for a detailed syntax of [INSERT SQL statement](/document/master/UserGuide/5-Operation%20Manual/4-SQL%20Reference.html). +This section mainly introduces the use of [INSERT SQL statement](/#/Documents/progress/chap5/sec4) for real-time data import in the scenario. See Section 5.4 for a detailed syntax of [INSERT SQL statement](../5-Operation%20Manual/4-SQL%20Reference.html). #### Use of INSERT Statements -The [INSERT SQL statement](/document/master/UserGuide/5-Operation%20Manual/4-SQL%20Reference.html) statement can be used to insert data into one or more specified timeseries that have been created. For each point of data inserted, it consists of a [timestamp](/document/master/UserGuide/2-Concept/1-Data%20Model%20and%20Terminology.html) and a sensor acquisition value (see [Data Type](/document/master/UserGuide/2-Concept/2-Data%20Type.html)). +The [INSERT SQL statement](../5-Operation%20Manual/4-SQL%20Reference.html) statement can be used to insert data into one or more specified timeseries that have been created. For each point of data inserted, it consists of a [timestamp](../2-Concept/1-Data%20Model%20and%20Terminology.html) and a sensor acquisition value (see [Data Type](../2-Concept/2-Data%20Type.html)). In the scenario of this section, take two timeseries `root.ln.wf02.wt02.status` and `root.ln.wf02.wt02.hardware` as an example, and their data types are BOOLEAN and TEXT, respectively. @@ -86,7 +86,7 @@ error: The TEXT data type should be covered by " or ' ### Time Slice Query -This chapter mainly introduces the relevant examples of time slice query using IoTDB SELECT statements. Detailed SQL syntax and usage specifications can be found in [SQL Documentation](/document/master/UserGuide/5-Operation%20Manual/4-SQL%20Reference.html). You can also use the [Java JDBC](/document/master/UserGuide/4-Client/3-Programming%20-%20JDBC.html) standard interface to execute related queries. +This chapter mainly introduces the relevant examples of time slice query using IoTDB SELECT statements. Detailed SQL syntax and usage specifications can be found in [SQL Documentation](../5-Operation%20Manual/4-SQL%20Reference.html). You can also use the [Java JDBC](../4-Client/3-Programming%20-%20JDBC.html) standard interface to execute related queries. #### Select a Column of Data Based on a Time Interval @@ -149,10 +149,10 @@ The execution result of this SQL statement is as follows: ### Down-Frequency Aggregate Query This section mainly introduces the related examples of down-frequency aggregation query, -using the [GROUP BY clause](/document/master/UserGuide/5-Operation%20Manual/4-SQL%20Reference.html), +using the [GROUP BY clause](../5-Operation%20Manual/4-SQL%20Reference.html), which is used to partition the result set according to the user's given partitioning conditions and aggregate the partitioned result set. IoTDB supports partitioning result sets according to time interval and customized sliding step which should not be smaller than the time interval and defaults to equal the time interval if not set. And by default results are sorted by time in ascending order. -You can also use the [Java JDBC](/document/master/UserGuide/4-Client/2-Programming%20-%20Native%20API.html) standard interface to execute related queries. +You can also use the [Java JDBC](../4-Client/2-Programming%20-%20Native%20API.html) standard interface to execute related queries. The GROUP BY statement provides users with three types of specified parameters: @@ -393,14 +393,14 @@ When the fill method is not specified, each data type bears its own default fill ### Row and Column Control over Query Results -IoTDB provides [LIMIT/SLIMIT](/document/master/UserGuide/5-Operation%20Manual/4-SQL%20Reference.html) clause and [OFFSET/SOFFSET](/document/master/UserGuide/5-Operation%20Manual/4-SQL%20Reference.html) +IoTDB provides [LIMIT/SLIMIT](../5-Operation%20Manual/4-SQL%20Reference.html) clause and [OFFSET/SOFFSET](../5-Operation%20Manual/4-SQL%20Reference.html) clause in order to make users have more control over query results. The use of LIMIT and SLIMIT clauses allows users to control the number of rows and columns of query results, and the use of OFFSET and SOFSET clauses allows users to set the starting position of the results for display. Note that the LIMIT and OFFSET are not supported in group by query. -This chapter mainly introduces related examples of row and column control of query results. You can also use the [Java JDBC](/document/master/UserGuide/4-Client/3-Programming%20-%20JDBC.html) standard interface to execute queries. +This chapter mainly introduces related examples of row and column control of query results. You can also use the [Java JDBC](../4-Client/3-Programming%20-%20JDBC.html) standard interface to execute queries. #### Row Control over Query Results @@ -629,9 +629,9 @@ The SQL statement will not be executed and the corresponding error prompt is giv ## DELETE -Users can delete data that meet the deletion condition in the specified timeseries by using the [DELETE statement](/document/master/UserGuide/5-Operation%20Manual/4-SQL%20Reference.html). When deleting data, users can select one or more timeseries paths, prefix paths, or paths with star to delete data before a certain time (current version does not support the deletion of data within a closed time interval). +Users can delete data that meet the deletion condition in the specified timeseries by using the [DELETE statement](../5-Operation%20Manual/4-SQL%20Reference.html). When deleting data, users can select one or more timeseries paths, prefix paths, or paths with star to delete data before a certain time (current version does not support the deletion of data within a closed time interval). -In a JAVA programming environment, you can use the [Java JDBC](/document/master/UserGuide/4-Client/3-Programming%20-%20JDBC.html) to execute single or batch UPDATE statements. +In a JAVA programming environment, you can use the [Java JDBC](../4-Client/3-Programming%20-%20JDBC.html) to execute single or batch UPDATE statements. ### Delete Single Timeseries Taking ln Group as an example, there exists such a usage scenario: @@ -643,7 +643,7 @@ delete from root.ln.wf02.wt02.status where time<=2017-11-01T16:26:00; ``` ### Delete Multiple Timeseries -When both the power supply status and hardware version of the ln group wf02 plant wt02 device before 2017-11-01 16:26:00 need to be deleted, [the prefix path with broader meaning or the path with star](/document/master/UserGuide/2-Concept/1-Data%20Model%20and%20Terminology.html) can be used to delete the data. The SQL statement for this operation is: +When both the power supply status and hardware version of the ln group wf02 plant wt02 device before 2017-11-01 16:26:00 need to be deleted, [the prefix path with broader meaning or the path with star](../2-Concept/1-Data%20Model%20and%20Terminology.html) can be used to delete the data. The SQL statement for this operation is: ``` delete from root.ln.wf02.wt02 where time <= 2017-11-01T16:26:00; diff --git a/docs/UserGuide/5-Operation Manual/3-Account Management Statements.md b/docs/UserGuide/5-Operation Manual/3-Account Management Statements.md index 12d2e1a3eb66..f83e1882e10a 100644 --- a/docs/UserGuide/5-Operation Manual/3-Account Management Statements.md +++ b/docs/UserGuide/5-Operation Manual/3-Account Management Statements.md @@ -23,7 +23,7 @@ IoTDB provides users with account privilege management operations, so as to ensure data security. -We will show you basic user privilege management operations through the following specific examples. Detailed SQL syntax and usage details can be found in [SQL Documentation](/document/master/UserGuide/5-Operation%20Manual/4-SQL%20Reference.html). At the same time, in the JAVA programming environment, you can use the [Java JDBC](/document/master/UserGuide/4-Client/3-Programming%20-%20JDBC.html) to execute privilege management statements in a single or batch mode. +We will show you basic user privilege management operations through the following specific examples. Detailed SQL syntax and usage details can be found in [SQL Documentation](../5-Operation%20Manual/4-SQL%20Reference.html). At the same time, in the JAVA programming environment, you can use the [Java JDBC](../4-Client/3-Programming%20-%20JDBC.html) to execute privilege management statements in a single or batch mode. ## Basic Concepts diff --git a/docs/UserGuide/6-System Tools/7-Monitor and Log Tools.md b/docs/UserGuide/6-System Tools/7-Monitor and Log Tools.md index 7ebbafbceb56..9fd130a4cd71 100644 --- a/docs/UserGuide/6-System Tools/7-Monitor and Log Tools.md +++ b/docs/UserGuide/6-System Tools/7-Monitor and Log Tools.md @@ -156,9 +156,9 @@ The user can choose to enable or disable the data statistics monitoring function The current statistics of writing data by the system can be divided into two major modules: **Global Writing Data Statistics** and **Storage Group Writing Data Statistics**. **Global Writing Data Statistics** records the point number written by the user and the number of requests. **Storage Group Writing Data Statistics** records data of a certain storage group. -The system defaults to collect data every 5 seconds, and writes the statistics to the IoTDB and stores them in a system-specified locate. (If you need to change the statistic frequency, you can set The `back_loop_period_in_second entry` in the configuration file, see Section [Engine Layer](/document/master/UserGuide/3-Server/2-Single%20Node%20Setup.html) for details). After the system is refreshed or restarted, IoTDB does not recover the statistics, and the statistics data will restart from zero. +The system defaults to collect data every 5 seconds, and writes the statistics to the IoTDB and stores them in a system-specified locate. (If you need to change the statistic frequency, you can set The `back_loop_period_in_second entry` in the configuration file, see Section [Engine Layer](../3-Server/2-Single%20Node%20Setup.html) for details). After the system is refreshed or restarted, IoTDB does not recover the statistics, and the statistics data will restart from zero. -In order to avoid the excessive use of statistical information, we add a mechanism to periodically clear invalid data for statistical information. The system will delete invalid data at regular intervals. The user can set the trigger frequency (`stat_monitor_retain_interval_in_second`, default is 600s, see section [Engine Layer](/document/master/UserGuide/3-Server/2-Single%20Node%20Setup.html) for details) to set the frequency of deleting data. By setting the valid data duration (`stat_monitor_detect_freq_in_second entry`, the default is 600s, see section [Engine Layer](/document/master/UserGuide/3-Server/2-Single%20Node%20Setup.html) for details) to set the time period of valid data, that is, the data within the time of the clear operation trigger time is stat_monitor_detect_freq_in_second is valid data. In order to ensure the stability of the system, it is not allowed to delete the statistics frequently. Therefore, if the configuration parameter time is less than the default value (600s), the system will abort the configuration parameter and uses the default parameter. +In order to avoid the excessive use of statistical information, we add a mechanism to periodically clear invalid data for statistical information. The system will delete invalid data at regular intervals. The user can set the trigger frequency (`stat_monitor_retain_interval_in_second`, default is 600s, see section [Engine Layer](../3-Server/2-Single%20Node%20Setup.html) for details) to set the frequency of deleting data. By setting the valid data duration (`stat_monitor_detect_freq_in_second entry`, the default is 600s, see section [Engine Layer](../3-Server/2-Single%20Node%20Setup.html) for details) to set the time period of valid data, that is, the data within the time of the clear operation trigger time is stat_monitor_detect_freq_in_second is valid data. In order to ensure the stability of the system, it is not allowed to delete the statistics frequently. Therefore, if the configuration parameter time is less than the default value (600s), the system will abort the configuration parameter and uses the default parameter. It's convenient for you to use `select` clause to get the writing data statistics the same as other timeseires. diff --git a/docs/UserGuide/7-Ecosystem Integration/3-Spark TsFile.md b/docs/UserGuide/7-Ecosystem Integration/3-Spark TsFile.md index 9c2c348cf476..29023233e09f 100644 --- a/docs/UserGuide/7-Ecosystem Integration/3-Spark TsFile.md +++ b/docs/UserGuide/7-Ecosystem Integration/3-Spark TsFile.md @@ -34,7 +34,7 @@ With this connector, you can |Spark Version | Scala Version | Java Version | TsFile | |------------- | ------------- | ------------ |------------ | -| `>= 2.2` | `2.11` | `1.8` | `0.10.0`| +| `2.4.3` | `2.11.8` | `1.8` | `0.10.0`| > Note: For more information about how to download and use TsFile, please see the following link: https://github.com/apache/incubator-iotdb/tree/master/tsfile. diff --git a/docs/UserGuide/7-Ecosystem Integration/4-Spark IoTDB.md b/docs/UserGuide/7-Ecosystem Integration/4-Spark IoTDB.md index 598f9e9df8b1..e7047ae9b0da 100644 --- a/docs/UserGuide/7-Ecosystem Integration/4-Spark IoTDB.md +++ b/docs/UserGuide/7-Ecosystem Integration/4-Spark IoTDB.md @@ -25,7 +25,7 @@ The versions required for Spark and Java are as follow: | Spark Version | Scala Version | Java Version | TsFile | | ------------- | ------------- | ------------ |------------ | -| `>= 2.2` | `2.11` | `1.8` | `0.10.0`| +| `2.4.3` | `2.11` | `1.8` | `0.10.0`| ## install diff --git a/docs/UserGuide/8-Architecture/1-Files.md b/docs/UserGuide/8-Architecture/1-Files.md index 4058a0db8baa..d5044bd55eb9 100644 --- a/docs/UserGuide/8-Architecture/1-Files.md +++ b/docs/UserGuide/8-Architecture/1-Files.md @@ -27,17 +27,17 @@ The data that IoTDB stores is divided into three categories, namely data files, ## Data Files -Data files store all the data that the user wrote to IoTDB, which contains TsFile and other files. TsFile storage directory can be configured with the `data_dirs` configuration item (see [file layer](/document/master/UserGuide/3-Server/4-Config%20Manual.html) for details). Other files can be configured through [data_dirs](/document/master/UserGuide/3-Server/4-Config%20Manual.html) configuration item (see [Engine Layer](/document/master/UserGuide/3-Server/4-Config%20Manual.html) for details). +Data files store all the data that the user wrote to IoTDB, which contains TsFile and other files. TsFile storage directory can be configured with the `data_dirs` configuration item (see [file layer](../3-Server/4-Config%20Manual.html) for details). Other files can be configured through [data_dirs](../3-Server/4-Config%20Manual.html) configuration item (see [Engine Layer](../3-Server/4-Config%20Manual.html) for details). -In order to better support users' storage requirements such as disk space expansion, IoTDB supports multiple file directories storage methods for TsFile storage configuration. Users can set multiple storage paths as data storage locations( see [data_dirs](/document/master/UserGuide/3-Server/4-Config%20Manual.html) configuration item), and you can specify or customize the directory selection policy (see [multi_dir_strategy](/document/master/UserGuide/3-Server/4-Config%20Manual.html) configuration item for details). +In order to better support users' storage requirements such as disk space expansion, IoTDB supports multiple file directories storage methods for TsFile storage configuration. Users can set multiple storage paths as data storage locations( see [data_dirs](../3-Server/4-Config%20Manual.html) configuration item), and you can specify or customize the directory selection policy (see [multi_dir_strategy](../3-Server/4-Config%20Manual.html) configuration item for details). ## System files -System files include schema files, which store metadata information of data in IoTDB. It can be configured through the `base_dir` configuration item (see [System Layer](/document/master/UserGuide/3-Server/4-Config%20Manual.html) for details). +System files include schema files, which store metadata information of data in IoTDB. It can be configured through the `base_dir` configuration item (see [System Layer](../3-Server/4-Config%20Manual.html) for details). ## Pre-write Log Files -Pre-write log files store WAL files. It can be configured through the `wal_dir` configuration item (see [System Layer](/document/master/UserGuide/3-Server/2-Single%20Node%20Setup.html) for details). +Pre-write log files store WAL files. It can be configured through the `wal_dir` configuration item (see [System Layer](../3-Server/2-Single%20Node%20Setup.html) for details). ## Example of Setting Data storage Directory diff --git a/docs/zh/UserGuide/0-Get Started/1-QuickStart.md b/docs/zh/UserGuide/0-Get Started/1-QuickStart.md index 37f7e9d6ecef..c77998004693 100755 --- a/docs/zh/UserGuide/0-Get Started/1-QuickStart.md +++ b/docs/zh/UserGuide/0-Get Started/1-QuickStart.md @@ -41,7 +41,7 @@ -本文将介绍关于IoTDB使用的基本流程，如果需要更多信息，请浏览我们官网的[指引](/zh/document/master/UserGuide/1-Overview/1-What%20is%20IoTDB.html). +本文将介绍关于IoTDB使用的基本流程，如果需要更多信息，请浏览我们官网的[指引](../1-Overview/1-What%20is%20IoTDB.html). ## 安装环境 @@ -61,7 +61,7 @@ IoTDB支持多种安装途径。用户可以使用三种方式对IoTDB进行安 ### IoTDB下载 -您可以从这里下载程序：[下载](/download/) +您可以从这里下载程序：[下载](/Download/) ### 配置文件 @@ -71,7 +71,7 @@ IoTDB支持多种安装途径。用户可以使用三种方式对IoTDB进行安 * 系统配置模块 (`tsfile-format.properties`, `iotdb-engine.properties`) * 日志配置模块 (`logback.xml`). -想要了解更多，请浏览[Chapter3: Server](/zh/document/master/UserGuide/3-Server/1-Download.html) +想要了解更多，请浏览[Chapter3: Server](../3-Server/1-Download.html) ​ ## IoTDB试用 @@ -264,7 +264,7 @@ IoTDB> quit IoTDB> exit ``` -想要浏览更多IoTDB数据库支持的命令，请浏览[SQL Reference](/zh/document/master/UserGuide/5-Operation%20Manual/4-SQL%20Reference.html). +想要浏览更多IoTDB数据库支持的命令，请浏览[SQL Reference](../5-Operation%20Manual/4-SQL%20Reference.html). ### 停止IoTDB diff --git a/docs/zh/UserGuide/2-Concept/1-Data Model and Terminology.md b/docs/zh/UserGuide/2-Concept/1-Data Model and Terminology.md index c082089e8d07..e111ae6c4ff0 100644 --- a/docs/zh/UserGuide/2-Concept/1-Data Model and Terminology.md +++ b/docs/zh/UserGuide/2-Concept/1-Data Model and Terminology.md @@ -21,9 +21,11 @@ # 数据模型与技术 -我们为您提供一份简化的[样例数据](https://github.com/apache/incubator-iotdb/tree/master/docs/SampleData.txt)。 +我们为您提供一份简化的[样例数据](https://github.com/apache/incubator-iotdb/blob/master/docs/Documentation/OtherMaterial-Sample%20Data.txt)。 -下载样例数据，按照属性涵盖范围以及它们之间的从属关系，我们可将其表示为如下图2.1的属性层级组织结构，其层级关系为：集团层-电场层-设备层-传感器层。其中ROOT为根节点，传感器层的每一个节点称为叶子节点。在使用IoTDB的过程中，您可以直接将由ROOT节点到每一个叶子节点路径上的属性用“.”连接，将其作为一个IoTDB的时间序列的名称。图2.1中最左侧的路径可以生成一个名为`ROOT.ln.wf01.wt01.status`的时间序列。 +下载文件: [IoTDB-SampleData.txt](https://raw.githubusercontent.com/apache/incubator-iotdb/master/docs/Documentation/OtherMaterial-Sample%20Data.txt). + +根据本文描述的[数据](https://github.com/apache/incubator-iotdb/blob/master/docs/Documentation/OtherMaterial-Sample%20Data.txt)属性层级，按照属性涵盖范围以及它们之间的从属关系，我们可将其表示为如下图2.1的属性层级组织结构，其层级关系为：集团层-电场层-设备层-传感器层。其中ROOT为根节点，传感器层的每一个节点称为叶子节点。在使用IoTDB的过程中，您可以直接将由ROOT节点到每一个叶子节点路径上的属性用“.”连接，将其作为一个IoTDB的时间序列的名称。图2.1中最左侧的路径可以生成一个名为`ROOT.ln.wf01.wt01.status`的时间序列。
diff --git a/docs/zh/UserGuide/2-Concept/2-Data Type.md b/docs/zh/UserGuide/2-Concept/2-Data Type.md index 77f61be2b8fc..b343dfc52053 100644 --- a/docs/zh/UserGuide/2-Concept/2-Data Type.md +++ b/docs/zh/UserGuide/2-Concept/2-Data Type.md @@ -31,7 +31,7 @@ IoTDB支持: 一共六种数据类型。 -其中**FLOAT**与**DOUBLE**类型的序列，如果编码方式采用[RLE](/zh/document/master/UserGuide/2-Concept/3-Encoding.html)或[TS_2DIFF](/zh/document/master/UserGuide/2-Concept/3-Encoding.html)可以指定MAX_POINT_NUMBER，该项为浮点数的小数点后位数，具体指定方式请参见本文[第5.4节](/zh/document/master/UserGuide/5-Operation%20Manual/4-SQL%20Reference.html)，若不指定则系统会根据配置文件`tsfile-format.properties`文件中的[float_precision项](/zh/document/master/UserGuide/3-Server/4-Config%20Manual.html)配置。 +其中**FLOAT**与**DOUBLE**类型的序列，如果编码方式采用[RLE](../2-Concept/3-Encoding.html)或[TS_2DIFF](../2-Concept/3-Encoding.html)可以指定MAX_POINT_NUMBER，该项为浮点数的小数点后位数，具体指定方式请参见本文[第5.4节](../5-Operation%20Manual/4-SQL%20Reference.html)，若不指定则系统会根据配置文件`tsfile-format.properties`文件中的[float_precision项](../3-Server/4-Config%20Manual.html)配置。 当系统中用户输入的数据类型与该时间序列的数据类型不对应时，系统会提醒类型错误，如下所示，二阶差分不支持布尔类型的编码： diff --git a/docs/zh/UserGuide/2-Concept/4-Compression.md b/docs/zh/UserGuide/2-Concept/4-Compression.md index 2a96487be59f..65844d29631c 100644 --- a/docs/zh/UserGuide/2-Concept/4-Compression.md +++ b/docs/zh/UserGuide/2-Concept/4-Compression.md @@ -28,4 +28,4 @@ IoTDB允许在创建一个时间序列的时候指定该列的压缩方式。现 * UNCOMPRESSED（不压缩） * SNAPPY压缩 -压缩方式的指定语法详见本文[5.4节](/zh/document/master/UserGuide/5-Operation%20Manual/4-SQL%20Reference.html)。 +压缩方式的指定语法详见本文[5.4节](../5-Operation%20Manual/4-SQL%20Reference.html)。 diff --git a/docs/zh/UserGuide/3-Server/1-Download.md b/docs/zh/UserGuide/3-Server/1-Download.md index 36082912d239..641a18794f8c 100644 --- a/docs/zh/UserGuide/3-Server/1-Download.md +++ b/docs/zh/UserGuide/3-Server/1-Download.md @@ -39,7 +39,7 @@ IoTDB为您提供了两种安装方式，您可以参考下面的建议，任选 ## 从官网下载二进制可执行文件 -您可以从[http://iotdb.apache.org/#/Download](http://iotdb.apache.org/#/Download)上下载已经编译好的可执行程序iotdb-xxx.tar.gz或者iotdb-xxx.zip，该压缩包包含了IoTDB系统运行所需的所有必要组件。 +您可以从[http://iotdb.apache.org/Download/](http://iotdb.apache.org/Download/)上下载已经编译好的可执行程序iotdb-xxx.tar.gz或者iotdb-xxx.zip，该压缩包包含了IoTDB系统运行所需的所有必要组件。 ``` NOTE: @@ -77,7 +77,7 @@ server/ <-- root path ## 使用源码编译 -您可以获取已发布的源码https://iotdb.apache.org/#/Download，或者从git仓库获取https://github.com/apache/incubator-iotdb/tree/master +您可以获取已发布的源码https://iotdb.apache.org/Download/，或者从git仓库获取https://github.com/apache/incubator-iotdb/tree/master 源码克隆后，进入到源码文件夹目录下，使用以下命令进行编译： @@ -117,4 +117,4 @@ $IOTDB_HOME/ ## 通过Docker安装 (Dockerfile) -你可以通过[这份指南](/zh/document/master/UserGuide/3-Server/5-Docker%20Image.html)编译并运行一个IoTDB docker image。 +你可以通过[这份指南](../3-Server/5-Docker%20Image.html)编译并运行一个IoTDB docker image。 diff --git a/docs/zh/UserGuide/4-Client/5-Programming - TsFile API.md b/docs/zh/UserGuide/4-Client/5-Programming - TsFile API.md index 440ddf7c13de..e5be6197324f 100644 --- a/docs/zh/UserGuide/4-Client/5-Programming - TsFile API.md +++ b/docs/zh/UserGuide/4-Client/5-Programming - TsFile API.md @@ -226,7 +226,7 @@ TsFile可以通过以下三个步骤生成，完整的代码参见"写入 TsFile * type: 数据类型，现在支持六种类型: `BOOLEAN`, `INT32`, `INT64`, `FLOAT`, `DOUBLE`, `TEXT`; - * encoding: 编码类型. 参见 [Chapter 2-3](/zh/document/master/UserGuide/2-Concept/3-Encoding.html). + * encoding: 编码类型. 参见 [Chapter 2-3](../2-Concept/3-Encoding.html). * compression: 压缩方式. 现在支持 `UNCOMPRESSED` 和 `SNAPPY`. diff --git a/docs/zh/UserGuide/5-Operation Manual/1-DDL Data Definition Language.md b/docs/zh/UserGuide/5-Operation Manual/1-DDL Data Definition Language.md index a5753850deda..44aa21ce6afa 100644 --- a/docs/zh/UserGuide/5-Operation Manual/1-DDL Data Definition Language.md +++ b/docs/zh/UserGuide/5-Operation Manual/1-DDL Data Definition Language.md @@ -41,7 +41,7 @@ Msg: org.apache.iotdb.exception.MetadataErrorException: org.apache.iotdb.excepti ## 查看存储组 -在存储组创建后，我们可以使用[SHOW STORAGE GROUP](/zh/document/master/UserGuide/5-Operation%20Manual/4-SQL%20Reference.html)语句来查看所有的存储组，SQL语句如下所示： +在存储组创建后，我们可以使用[SHOW STORAGE GROUP](../5-Operation%20Manual/4-SQL%20Reference.html)语句来查看所有的存储组，SQL语句如下所示： ``` IoTDB> show storage group @@ -69,7 +69,7 @@ IoTDB> create timeseries root.ln.wf02.wt02.status WITH DATATYPE=BOOLEAN, ENCODIN error: encoding TS_2DIFF does not support BOOLEAN ``` -详细的数据类型与编码方式的对应列表请参见[编码方式](/zh/document/master/UserGuide/2-Concept/3-Encoding.html)。 +详细的数据类型与编码方式的对应列表请参见[编码方式](../2-Concept/3-Encoding.html)。 ## 查看时间序列 diff --git a/docs/zh/UserGuide/5-Operation Manual/2-DML Data Manipulation Language.md b/docs/zh/UserGuide/5-Operation Manual/2-DML Data Manipulation Language.md index 55bd13aa61c0..dc4e97e7a8e1 100644 --- a/docs/zh/UserGuide/5-Operation Manual/2-DML Data Manipulation Language.md +++ b/docs/zh/UserGuide/5-Operation Manual/2-DML Data Manipulation Language.md @@ -23,9 +23,9 @@ ## 数据接入 -IoTDB为用户提供多种插入实时数据的方式，例如在[Cli/Shell工具](/zh/document/master/UserGuide/4-Client/1-Command%20Line%20Interface.html)中直接输入插入数据的INSERT语句，或使用Java API（标准[Java JDBC](/zh/document/master/UserGuide/4-Client/3-Programming%20-%20JDBC.html)接口）单条或批量执行插入数据的INSERT语句。 +IoTDB为用户提供多种插入实时数据的方式，例如在[Cli/Shell工具](../4-Client/1-Command%20Line%20Interface.html)中直接输入插入数据的INSERT语句，或使用Java API（标准[Java JDBC](../4-Client/3-Programming%20-%20JDBC.html)接口）单条或批量执行插入数据的INSERT语句。 -本节主要为您介绍实时数据接入的INSERT语句在场景中的实际使用示例，有关INSERT SQL语句的详细语法请参见本文[INSERT语句](/zh/document/master/UserGuide/5-Operation%20Manual/4-SQL%20Reference.html)节。 +本节主要为您介绍实时数据接入的INSERT语句在场景中的实际使用示例，有关INSERT SQL语句的详细语法请参见本文[INSERT语句](../5-Operation%20Manual/4-SQL%20Reference.html)节。 ### 使用INSERT语句 @@ -89,7 +89,7 @@ error: The TEXT data type should be covered by " or ' ### 时间切片查询 -本节主要介绍时间切片查询的相关示例，主要使用的是[IoTDB SELECT语句](/zh/document/master/UserGuide/5-Operation%20Manual/4-SQL%20Reference.html)。同时，您也可以使用[Java JDBC](/zh/document/master/UserGuide/4-Client/3-Programming%20-%20JDBC.html)标准接口来执行相关的查询语句。 +本节主要介绍时间切片查询的相关示例，主要使用的是[IoTDB SELECT语句](../5-Operation%20Manual/4-SQL%20Reference.html)。同时，您也可以使用[Java JDBC](../4-Client/3-Programming%20-%20JDBC.html)标准接口来执行相关的查询语句。 #### 根据一个时间区间选择一列数据 @@ -101,7 +101,7 @@ select temperature from root.ln.wf01.wt01 where time < 2017-11-01T00:08:00.000 其含义为： -被选择的设备为ln集团wf01子站wt01设备；被选择的时间序列为温度传感器（temperature）；该语句要求选择出该设备在“2017-11-01T00:08:00.000”（此处可以使用多种时间格式，详情可参看[2.1节](/zh/document/master/UserGuide/2-Concept/1-Data%20Model%20and%20Terminology.html)）时间点以前的所有温度传感器的值。 +被选择的设备为ln集团wf01子站wt01设备；被选择的时间序列为温度传感器（temperature）；该语句要求选择出该设备在“2017-11-01T00:08:00.000”（此处可以使用多种时间格式，详情可参看[2.1节](../2-Concept/1-Data%20Model%20and%20Terminology.html)）时间点以前的所有温度传感器的值。 该SQL语句的执行结果如下： @@ -174,7 +174,7 @@ select s1,s2 from root.sg1.* GROUP BY DEVICE ### 降频聚合查询 本章节主要介绍降频聚合查询的相关示例， -主要使用的是IoTDB SELECT语句的[GROUP BY子句](/zh/document/master/UserGuide/5-Operation%20Manual/4-SQL%20Reference.html)， +主要使用的是IoTDB SELECT语句的[GROUP BY子句](../5-Operation%20Manual/4-SQL%20Reference.html)， 该子句是IoTDB中用于根据用户给定划分条件对结果集进行划分，并对已划分的结果集进行聚合计算的语句。 IoTDB支持根据时间间隔和自定义的滑动步长（默认值与时间间隔相同，自定义的值必须大于等于时间间隔）对结果集进行划分，默认结果按照时间升序排列。 同时，您也可以使用Java JDBC标准接口来执行相关的查询语句。 @@ -432,12 +432,12 @@ select temperature from root.sgcc.wf03.wt01 where time = 2017-11-01T16:37:50.000 ### 对查询结果的行和列控制 -IoTDB提供 [LIMIT/SLIMIT](/zh/document/master/UserGuide/5-Operation%20Manual/4-SQL%20Reference.html) 子句和 [OFFSET/SOFFSET](/zh/document/master/UserGuide/5-Operation%20Manual/4-SQL%20Reference.html) 子句，以使用户可以更好地控制查询结果。使用LIMIT和SLIMIT子句可让用户控制查询结果的行数和列数， +IoTDB提供 [LIMIT/SLIMIT](../5-Operation%20Manual/4-SQL%20Reference.html) 子句和 [OFFSET/SOFFSET](../5-Operation%20Manual/4-SQL%20Reference.html) 子句，以使用户可以更好地控制查询结果。使用LIMIT和SLIMIT子句可让用户控制查询结果的行数和列数， 并且使用OFFSET和SOFSET子句允许用户设置结果显示的起始位置。 请注意，按组查询不支持LIMIT和OFFSET。 -本章主要介绍查询结果的行和列控制的相关示例。你还可以使用 [Java JDBC](/zh/document/master/UserGuide/4-Client/3-Programming%20-%20JDBC.html) 标准接口执行查询。 +本章主要介绍查询结果的行和列控制的相关示例。你还可以使用 [Java JDBC](../4-Client/3-Programming%20-%20JDBC.html) 标准接口执行查询。 #### 查询结果的行控制 @@ -687,7 +687,7 @@ SQL语句将不会执行，并且相应的错误提示如下： ### 数据删除 -用户使用[DELETE语句](/zh/document/master/UserGuide/5-Operation%20Manual/4-SQL%20Reference.html)可以删除指定的时间序列中符合时间删除条件的数据。在删除数据时，用户可以选择需要删除的一个或多个时间序列、时间序列的前缀、时间序列带\*路径对某时间之前的数据进行删除（当前版本暂不支持删除某一闭时间区间范围内的数据）。 +用户使用[DELETE语句](../5-Operation%20Manual/4-SQL%20Reference.html)可以删除指定的时间序列中符合时间删除条件的数据。在删除数据时，用户可以选择需要删除的一个或多个时间序列、时间序列的前缀、时间序列带\*路径对某时间之前的数据进行删除（当前版本暂不支持删除某一闭时间区间范围内的数据）。 在JAVA编程环境中，您可以使用JDBC API单条或批量执行DELETE语句。 @@ -703,7 +703,7 @@ delete from root.ln.wf02.wt02.status where time<=2017-11-01T16:26:00; #### 多传感器时间序列值删除 -当ln集团wf02子站的wt02设备在2017-11-01 16:26:00之前的供电状态和设备硬件版本都需要删除，此时可以使用含义更广的[前缀路径或带`*`路径](/zh/document/master/UserGuide/2-Concept/1-Data%20Model%20and%20Terminology.html)进行删除操作，进行此操作的SQL语句为： +当ln集团wf02子站的wt02设备在2017-11-01 16:26:00之前的供电状态和设备硬件版本都需要删除，此时可以使用含义更广的[前缀路径或带`*`路径](../2-Concept/1-Data%20Model%20and%20Terminology.html)进行删除操作，进行此操作的SQL语句为： ``` delete from root.ln.wf02.wt02 where time <= 2017-11-01T16:26:00; diff --git a/docs/zh/UserGuide/5-Operation Manual/3-Account Management Statements.md b/docs/zh/UserGuide/5-Operation Manual/3-Account Management Statements.md index d63924404354..d31aa9d8eedc 100644 --- a/docs/zh/UserGuide/5-Operation Manual/3-Account Management Statements.md +++ b/docs/zh/UserGuide/5-Operation Manual/3-Account Management Statements.md @@ -23,7 +23,7 @@ IoTDB为用户提供了权限管理操作，从而为用户提供对于数据的权限管理功能，保障数据的安全。 -我们将通过以下几个具体的例子为您示范基本的用户权限操作，详细的SQL语句及使用方式详情请参见本文[第5.4节](/zh/document/master/UserGuide/2-Concept/1-Data%20Model%20and%20Terminology.html)。同时，在JAVA编程环境中，您可以使用[JDBC API](/zh/document/master/UserGuide/4-Client/3-Programming%20-%20JDBC.html)单条或批量执行权限管理类语句。 +我们将通过以下几个具体的例子为您示范基本的用户权限操作，详细的SQL语句及使用方式详情请参见本文[第5.4节](../2-Concept/1-Data%20Model%20and%20Terminology.html)。同时，在JAVA编程环境中，您可以使用[JDBC API](../4-Client/3-Programming%20-%20JDBC.html)单条或批量执行权限管理类语句。 ## 基本概念 @@ -45,7 +45,7 @@ IoTDB为用户提供了权限管理操作，从而为用户提供对于数据的 ## 权限操作示例 -根据本文中描述的[样例数据](/zh/document/master/UserGuide/5-Operation%20Manual/1-DDL%20Data%20Definition%20Language.html)内容，IoTDB的样例数据可能同时属于ln, sgcc等不同发电集团，不同的发电集团不希望其他发电集团获取自己的数据库数据，因此我们需要将不同的数据在集团层进行权限隔离。 +根据本文中描述的[样例数据](../5-Operation%20Manual/1-DDL%20Data%20Definition%20Language.html)内容，IoTDB的样例数据可能同时属于ln, sgcc等不同发电集团，不同的发电集团不希望其他发电集团获取自己的数据库数据，因此我们需要将不同的数据在集团层进行权限隔离。 ### 创建用户 diff --git a/docs/zh/UserGuide/6-System Tools/7-Monitor and Log Tools.md b/docs/zh/UserGuide/6-System Tools/7-Monitor and Log Tools.md index b29f93df8973..6e2e3bc81c8d 100644 --- a/docs/zh/UserGuide/6-System Tools/7-Monitor and Log Tools.md +++ b/docs/zh/UserGuide/6-System Tools/7-Monitor and Log Tools.md @@ -151,13 +151,13 @@ Monitor下有几个属性，包括在不同文件夹中打开的文件数，数 本模块是IoTDB为用户提供的对其中存储数据信息的数据统计监控方式，我们会在系统中为您记录各个模块的数据统计信息，并将其汇总存入数据库中。当前版本的IoTDB提供IoTDB写入数据的统计功能。 -用户可以选择开启或关闭数据统计监控功能（您可以设定配置文件中的`enable_stat_monitor`项，详细信息参见[第3.4节](/zh/document/master/UserGuide/3-Server/4-Config%20Manual.html)）。 +用户可以选择开启或关闭数据统计监控功能（您可以设定配置文件中的`enable_stat_monitor`项，详细信息参见[第3.4节](../3-Server/4-Config%20Manual.html)）。 #### 写入数据统计 -系统目前对写入数据的统计可分为两大模块： 全局（Global） 写入数据统计和存储组（Storage Group） 写入数据统计。 全局统计量记录了所有写入数据的点数、请求数统计，存储组统计量对某一个存储组的写入数据进行了统计，系统默认设定每 5 秒 （若需更改统计频率，您可以设定配置文件中的`back_loop_period_in_second`项，详细信息参见本文[3.4节](/zh/document/master/UserGuide/3-Server/4-Config%20Manual.html)） 将统计量写入 IoTDB 中，并以系统指定的命名方式存储。系统刷新或者重启后， IoTDB 不对统计量做恢复处理，统计量从零值重新开始计算。 +系统目前对写入数据的统计可分为两大模块： 全局（Global） 写入数据统计和存储组（Storage Group） 写入数据统计。 全局统计量记录了所有写入数据的点数、请求数统计，存储组统计量对某一个存储组的写入数据进行了统计，系统默认设定每 5 秒 （若需更改统计频率，您可以设定配置文件中的`back_loop_period_in_second`项，详细信息参见本文[3.4节](../3-Server/4-Config%20Manual.html)） 将统计量写入 IoTDB 中，并以系统指定的命名方式存储。系统刷新或者重启后， IoTDB 不对统计量做恢复处理，统计量从零值重新开始计算。 -为了避免统计信息占用过多空间，我们为统计信息加入定期清除无效数据的机制。系统将每隔一段时间删除无效数据。用户可以通过设置删除机制触发频率（`stat_monitor_retain_interval_in_second`项，默认为600s，详细信息参见本文[3.4节](/zh/document/master/UserGuide/3-Server/4-Config%20Manual.html)）配置删除数据的频率，通过设置有效数据的期限（`stat_monitor_detect_freq_in_second`项，默认为600s，详细信息参见本文[3.4节](/zh/document/master/UserGuide/3-Server/4-Config%20Manual.html)）设置有效数据的范围，即距离清除操作触发时间为`stat_monitor_detect_freq_in_second`以内的数据为有效数据。为了保证系统的稳定，不允许频繁地删除统计量，因此如果配置参数的时间小于默认值，系统不采用配置参数而使用默认参数。 +为了避免统计信息占用过多空间，我们为统计信息加入定期清除无效数据的机制。系统将每隔一段时间删除无效数据。用户可以通过设置删除机制触发频率（`stat_monitor_retain_interval_in_second`项，默认为600s，详细信息参见本文[3.4节](../3-Server/4-Config%20Manual.html)）配置删除数据的频率，通过设置有效数据的期限（`stat_monitor_detect_freq_in_second`项，默认为600s，详细信息参见本文[3.4节](../3-Server/4-Config%20Manual.html)）设置有效数据的范围，即距离清除操作触发时间为`stat_monitor_detect_freq_in_second`以内的数据为有效数据。为了保证系统的稳定，不允许频繁地删除统计量，因此如果配置参数的时间小于默认值，系统不采用配置参数而使用默认参数。 注：当前版本统计的写入数据统计信息会同时统计用户写入的数据与系统内部监控数据。 diff --git a/docs/zh/UserGuide/7-Ecosystem Integration/3-Spark TsFile.md b/docs/zh/UserGuide/7-Ecosystem Integration/3-Spark TsFile.md index 92d5a0e69feb..d2966d7f6e7d 100644 --- a/docs/zh/UserGuide/7-Ecosystem Integration/3-Spark TsFile.md +++ b/docs/zh/UserGuide/7-Ecosystem Integration/3-Spark TsFile.md @@ -35,7 +35,7 @@ TsFile-Spark-Connector对Tsfile类型的外部数据源实现Spark的支持。 | Spark Version | Scala Version | Java Version | TsFile | | ------------- | ------------- | ------------ | -------- | -| `>= 2.2` | `2.11` | `1.8` | `0.10.0` | +| `2.4.3` | `2.11.8` | `1.8` | `0.10.0` | > 注意：有关如何下载和使用TsFile的更多信息，请参见以下链接：https://github.com/apache/incubator-iotdb/tree/master/tsfile diff --git a/docs/zh/UserGuide/7-Ecosystem Integration/4-Spark IoTDB.md b/docs/zh/UserGuide/7-Ecosystem Integration/4-Spark IoTDB.md index b2e29e0f1d6e..08433ae5f0ce 100644 --- a/docs/zh/UserGuide/7-Ecosystem Integration/4-Spark IoTDB.md +++ b/docs/zh/UserGuide/7-Ecosystem Integration/4-Spark IoTDB.md @@ -27,7 +27,7 @@ Spark和Java所需的版本如下： | Spark Version | Scala Version | Java Version | TsFile | | ------------- | ------------- | ------------ | -------- | -| `>= 2.2` | `2.11` | `1.8` | `0.10.0` | +| `2.4.3` | `2.11` | `1.8` | `0.10.0` | ## 安装 diff --git a/docs/zh/UserGuide/8-Architecture/1-Files.md b/docs/zh/UserGuide/8-Architecture/1-Files.md index 7fe7255bc444..f35fb7ca4fd6 100644 --- a/docs/zh/UserGuide/8-Architecture/1-Files.md +++ b/docs/zh/UserGuide/8-Architecture/1-Files.md @@ -27,17 +27,17 @@ IoTDB需要存储的数据分为三类，分别为数据文件、系统文件以 ## 数据文件 -数据文件存储了用户写入IoTDB系统的所有数据。包含TsFile文件和其他文件，可通过[data_dirs配置项](/zh/document/master/UserGuide/3-Server/4-Config%20Manual.html)进行配置。 +数据文件存储了用户写入IoTDB系统的所有数据。包含TsFile文件和其他文件，可通过[data_dirs配置项](../3-Server/4-Config%20Manual.html)进行配置。 -为了更好的支持用户对于磁盘空间扩展等存储需求，IoTDB为TsFile的存储配置增加了多文件目录的存储方式，用户可自主配置多个存储路径作为数据的持久化位置（详情见[data_dirs配置项](/zh/document/master/UserGuide/3-Server/4-Config%20Manual.html)），并可以指定或自定义目录选择策略（详情见[mult_dir_strategy配置项](/zh/document/master/UserGuide/3-Server/4-Config%20Manual.html)）。 +为了更好的支持用户对于磁盘空间扩展等存储需求，IoTDB为TsFile的存储配置增加了多文件目录的存储方式，用户可自主配置多个存储路径作为数据的持久化位置（详情见[data_dirs配置项](../3-Server/4-Config%20Manual.html)），并可以指定或自定义目录选择策略（详情见[mult_dir_strategy配置项](../3-Server/4-Config%20Manual.html)）。 ## 系统文件 -系统Schema文件，存储了数据文件的元数据信息。可通过base_dir配置项进行配置（详情见[base_dir配置项](/zh/document/master/UserGuide/3-Server/4-Config%20Manual.html)）。 +系统Schema文件，存储了数据文件的元数据信息。可通过base_dir配置项进行配置（详情见[base_dir配置项](../3-Server/4-Config%20Manual.html)）。 ## 写前日志文件 -写前日志文件存储了系统的写前日志。可通过`wal_dir`配置项进行配置（详情见[wal_dir配置项](/zh/document/master/UserGuide/3-Server/4-Config%20Manual.html)）。 +写前日志文件存储了系统的写前日志。可通过`wal_dir`配置项进行配置（详情见[wal_dir配置项](../3-Server/4-Config%20Manual.html)）。 ## 数据存储目录设置举例