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 fcc9d43 Fix the doc of English version (#177)
fcc9d43 is described below
commit fcc9d43c28461ef7c2e17ea4a4f3791b51554cab
Author: wanghui42 <[email protected]>
AuthorDate: Wed Feb 7 12:43:32 2024 +0800
Fix the doc of English version (#177)
---
.../Master/API/Programming-Java-Native-API.md | 167 ++++++++++-----------
.../Basic-Concept/Encoding-and-Compression.md | 2 +-
.../Deployment-Guide_timecho.md | 4 +-
.../Master/User-Manual/Operate-Metadata.md | 4 +-
.../Master/User-Manual/Operator-and-Expression.md | 4 +-
src/UserGuide/Master/User-Manual/Query-Data.md | 2 +-
.../latest/API/Programming-Java-Native-API.md | 2 +-
.../Basic-Concept/Encoding-and-Compression.md | 2 +-
.../Deployment-Guide_timecho.md | 4 +-
.../latest/User-Manual/Operate-Metadata.md | 4 +-
.../latest/User-Manual/Operator-and-Expression.md | 4 +-
src/UserGuide/latest/User-Manual/Query-Data.md | 2 +-
.../Master/User-Manual/Operate-Metadata.md | 2 +-
.../latest/User-Manual/Operate-Metadata.md | 2 +-
14 files changed, 95 insertions(+), 110 deletions(-)
diff --git a/src/UserGuide/Master/API/Programming-Java-Native-API.md
b/src/UserGuide/Master/API/Programming-Java-Native-API.md
index 4b55318..4fe0bee 100644
--- a/src/UserGuide/Master/API/Programming-Java-Native-API.md
+++ b/src/UserGuide/Master/API/Programming-Java-Native-API.md
@@ -25,8 +25,8 @@
### Dependencies
-* JDK >= 1.8+
-* Maven >= 3.9+
+* JDK >= 1.8
+* Maven >= 3.6
### How to install
@@ -47,15 +47,15 @@ In root directory:
## Syntax Convention
-- **IoTDB-SQL interface:** The input SQL parameter needs to conform to the
[syntax conventions](../stage/Syntax-Conventions/Literal-Values.md) and be
escaped for JAVA strings. For example, you need to add a backslash before the
double-quotes. (That is: after JAVA escaping, it is consistent with the SQL
statement executed on the command line.)
+- **IoTDB-SQL interface:** The input SQL parameter needs to conform to the
[syntax conventions](../User-Manual/Syntax-Rule.md#Literal-Values) and be
escaped for JAVA strings. For example, you need to add a backslash before the
double-quotes. (That is: after JAVA escaping, it is consistent with the SQL
statement executed on the command line.)
- **Other interfaces:**
- - The node names in path or path prefix: The node names are required to be
escaped by backticks (`) in the SQL statement.
- - Identifiers (such as template names): The identifiers are required to be
escaped by backticks (`) in the SQL statement.
+ - The node names in path or path prefix as parameter: The node names which
should be escaped by backticks (`) in the SQL statement, escaping is required
here.
+ - Identifiers (such as template names) as parameters: The identifiers which
should be escaped by backticks (`) in the SQL statement, and escaping is not
required here.
- **Code example for syntax convention could be found at:**
`example/session/src/main/java/org/apache/iotdb/SyntaxConventionRelatedExample.java`
## Native APIs
-In this section we will demonstrate the commonly used interfaces and their
parameters in the Native API:
+Here we show the commonly used interfaces and their parameters in the Native
API:
### Initialization
@@ -91,7 +91,7 @@ session =
.build();
```
-`Version` represents the SQL semantic version used by the client, which is
used to be compatible with the SQL semantics of `0.12` when upgrading `0.13`.
The possible values are: `V_0_12`, `V_0_13`, `V_1_0`.
+Version represents the SQL semantic version used by the client, which is used
to be compatible with the SQL semantics of 0.12 when upgrading 0.13. The
possible values are: `V_0_12`, `V_0_13`, `V_1_0`.
* Open a Session
@@ -99,13 +99,13 @@ session =
void open()
```
-* Open a session, with a parameter specifying whether to enable RPC compression
+* Open a session, with a parameter to specify whether to enable RPC compression
``` java
void open(boolean enableRPCCompression)
```
-Notice: The RPC compression setting of the client is required to match that of
the IoTDB server
+Notice: this RPC compression status of client must comply with that of IoTDB
server
* Close a Session
@@ -113,11 +113,11 @@ Notice: The RPC compression setting of the client is
required to match that of t
void close()
```
-### Data Definition Interface (DDI)
+### Data Definition Interface (DDL Interface)
#### Database Management
-* Create database
+* CREATE DATABASE
``` java
void setStorageGroup(String storageGroupId)
@@ -169,8 +169,8 @@ boolean checkTimeseriesExists(String path)
#### Schema Template
-Creation of a schema-templates will help to improve performance when ingesting
data of a large number of identical devices.
-You can use Template, InternalNode and MeasurementNode types to describe the
structure of the template, and use `createSchemaTemplate` to create it inside
the current session.
+
+Create a schema template for massive identical devices will help to improve
memory performance. You can use Template, InternalNode and MeasurementNode to
depict the structure of the template, and use belowed interface to create it
inside session.
``` java
public void createSchemaTemplate(Template template);
@@ -203,7 +203,7 @@ Class MeasurementNode extends Node {
}
```
-> We strongly recommend you create only flat templates and don't make use of
the ability to create hierarchical structures as tree-structured templates may
not be supported in further version of IoTDB.
+We strongly suggest you implement templates only with flat-measurement (like
object 'flatTemplate' in belowed snippet), since tree-structured template may
not be a long-term supported feature in further version of IoTDB.
A snippet of using above Method and Class：
@@ -221,47 +221,46 @@ template.addToTemplate(nodeSpeed);
createSchemaTemplate(flatTemplate);
```
-You can query measurements inside templates with these APIS:
+You can query measurement inside templates with these APIS:
```java
// Return the amount of measurements inside a template
-int countMeasurementsInTemplate(String templateName);
+public int countMeasurementsInTemplate(String templateName);
-// Returns true if path points to a measurement, otherwise it returns false
-boolean isMeasurementInTemplate(String templateName, String path);
+// Return true if path points to a measurement, otherwise returne false
+public boolean isMeasurementInTemplate(String templateName, String path);
-// Returns true if path exists in template, otherwise it returns false
-boolean isPathExistInTemplate(String templateName, String path);
+// Return true if path exists in template, otherwise return false
+public boolean isPathExistInTemplate(String templateName, String path);
-// Return all measurement paths inside a given template
-List<String> showMeasurementsInTemplate(String templateName);
+// Return all measurements paths inside template
+public List<String> showMeasurementsInTemplate(String templateName);
-// Return all measurement paths matching the designated pattern inside a given
template
-List<String> showMeasurementsInTemplate(String templateName, String pattern);
+// Return all measurements paths under the designated patter inside template
+public List<String> showMeasurementsInTemplate(String templateName, String
pattern);
```
-To use a schema template, you can set the measurement template named
`templateName` at path `prefixPath`.
+To implement schema template, you can set the measurement template named
'templateName' at path 'prefixPath'.
-> **Please notice that, we strongly recommend not setting templates on the
nodes above the database to accommodate future updates and collaboration
between modules.**
+**Please notice that, we strongly recommend not setting templates on the nodes
above the database to accommodate future updates and collaboration between
modules.**
``` java
void setSchemaTemplate(String templateName, String prefixPath)
```
-Before using a template, you should first create the template using the
following example:
+Before setting template, you should firstly create the template using
``` java
void createSchemaTemplate(Template template)
```
-After assigning template to a certain path, you can use the template to create
a timeseries for given device paths using the following call:
+After setting template to a certain path, you can use the template to create
timeseries on given device paths through the following interface, or you can
write data directly to trigger timeseries auto creation using schema template
under target devices.
``` java
void createTimeseriesUsingSchemaTemplate(List<String> devicePathList)
```
-Alternatively you can write data directly without creating the timeseies firs
hereby triggering the timeseries auto-creation, which automatically uses the
template assigned to the provided path.
-After setting template to a certain path, you can query for info about
template using the interface in the following example:
+After setting template to a certain path, you can query for info about
template using belowed interface in session:
``` java
/** @return All template names. */
@@ -274,26 +273,25 @@ public List<String> showPathsTemplateSetOn(String
templateName);
public List<String> showPathsTemplateUsingOn(String templateName)
```
-If you to remove a schema template, you can drop it with following interface.
-Make sure the template you are trying to remove has been unset from MTree and
is no longer used.
+If you are ready to get rid of schema template, you can drop it with belowed
interface. Make sure the template to drop has been unset from MTree.
``` java
void unsetSchemaTemplate(String prefixPath, String templateName);
public void dropSchemaTemplate(String templateName);
```
-Unset the schema template named `templateName` from path `prefixPath`.
-When you issue this interface, you should assure that there is a template
named `templateName` set at the path `prefixPath`.
+Unset the measurement template named 'templateName' from path 'prefixPath'.
When you issue this interface, you should assure that there is a template named
'templateName' set at the path 'prefixPath'.
+
+Attention: Unsetting the template named 'templateName' from node at path
'prefixPath' or descendant nodes which have already inserted records using
template is **not supported**.
-> Attention: Unsetting a template from node a path or descendant nodes which
already contain data referencing this template is **not supported**
-### Data Manipulation Interface (DMI)
+### Data Manipulation Interface (DML Interface)
#### Insert
It is recommended to use insertTablet to help improve write efficiency.
-* Insert a Tablet，which contains multiple rows for a device. Each row has the
same measurements:
+* Insert a Tablet，which is multiple rows of a device, each row has the same
measurements
* **Better Write Performance**
* **Support batch write**
* **Support null values**: fill the null value with any value, and then mark
the null value via BitMap
@@ -327,7 +325,7 @@ public class Tablet {
void insertTablets(Map<String, Tablet> tablet)
```
-* Insert a Record, which contains multiple measurement values for a device at
a given time.
+* Insert a Record, which contains multiple measurement value of a device at a
timestamp. This method is equivalent to providing a common interface for
multiple data types of values. Later, the value can be cast to the original
type through TSDataType.
The correspondence between the Object type and the TSDataType type is shown
in the following table.
@@ -341,56 +339,44 @@ void insertTablets(Map<String, Tablet> tablet)
| TEXT | String, Binary |
``` java
-void insertRecord(String deviceId,
- long time,
- List<String> measurements,
- List<TSDataType> types,
- List<Object> values)
+void insertRecord(String deviceId, long time, List<String> measurements,
+ List<TSDataType> types, List<Object> values)
```
* Insert multiple Records
``` java
-void insertRecords(List<String> deviceIds,
- List<Long> times,
- List<List<String>> measurementsList,
- List<List<TSDataType>> typesList,
+void insertRecords(List<String> deviceIds, List<Long> times,
+ List<List<String>> measurementsList, List<List<TSDataType>> typesList,
List<List<Object>> valuesList)
```
-
-* Insert multiple Records that belong to the same device.
+* Insert multiple Records that belong to the same device.
+ With type info the server has no need to do type inference, which leads a
better performance
``` java
-void insertRecordsOfOneDevice(String deviceId,
- List<Long> times,
- List<List<String>> measurementsList,
- List<List<TSDataType>> typesList,
+void insertRecordsOfOneDevice(String deviceId, List<Long> times,
+ List<List<String>> measurementsList, List<List<TSDataType>> typesList,
List<List<Object>> valuesList)
```
#### Insert with type inference
-If type-information is not present, all values will be converted to their
`String` representation.
-The server then performs type inference to guess the datatype, based on this
string-representation.
-For example, if value string equals "true", it can be automatically inferred
to be a `Boolean` type. If string value is "3.2", it can be automatically
inferred as a `Float` type.
-However, please keep in mind, that this process of guessing the type for a
given value comes at a performance cost.
+When the data is of String type, we can use the following interface to perform
type inference based on the value of the value itself. For example, if value is
"true" , it can be automatically inferred to be a boolean type. If value is
"3.2" , it can be automatically inferred as a flout type. Without type
information, server has to do type inference, which may cost some time.
-The following variants demonstrate the insertion of data, using type
inference:
-
-* Insert a Record, which contains multiple measurement values for a device at
given times:
+* Insert a Record, which contains multiple measurement value of a device at a
timestamp
``` java
void insertRecord(String prefixPath, long time, List<String> measurements,
List<String> values)
```
-* Insert multiple Records:
+* Insert multiple Records
``` java
void insertRecords(List<String> deviceIds, List<Long> times,
List<List<String>> measurementsList, List<List<String>> valuesList)
```
-* Insert multiple Records that belong to the same device:
+* Insert multiple Records that belong to the same device.
``` java
void insertStringRecordsOfOneDevice(String deviceId, List<Long> times,
@@ -399,7 +385,7 @@ void insertStringRecordsOfOneDevice(String deviceId,
List<Long> times,
#### Insert of Aligned Timeseries
-The insertion of aligned timeseries uses interfaces like `insertAlignedXXX`,
and others similar to the above interfaces:
+The Insert of aligned timeseries uses interfaces like insertAlignedXXX, and
others are similar to the above interfaces:
* insertAlignedRecord
* insertAlignedRecords
@@ -410,7 +396,7 @@ The insertion of aligned timeseries uses interfaces like
`insertAlignedXXX`, and
#### Delete
-* Delete data with timestamps before or equal to a given timestamp of one or
several timeseries:
+* Delete data before or equal to a timestamp of one or several timeseries
``` java
void deleteData(String path, long time)
@@ -420,16 +406,16 @@ void deleteData(List<String> paths, long time)
#### Query
* Time-series raw data query with time range:
- - The specified query time-range is a left-closed right-open interval,
including the start time but excluding the end time.
+ - The specified query time range is a left-closed right-open interval,
including the start time but excluding the end time.
``` java
SessionDataSet executeRawDataQuery(List<String> paths, long startTime, long
endTime);
```
* Last query:
- - Query the last data, whose timestamp is greater than or equal lastTime.
+ - Query the last data, whose timestamp is greater than or equal LastTime.
``` java
- SessionDataSet executeLastDataQuery(List<String> paths, long lastTime);
+ SessionDataSet executeLastDataQuery(List<String> paths, long LastTime);
```
- Query the latest point of the specified series of single device quickly,
and support redirection;
If you are sure that the query path is valid, set 'isLegalPathNodes' to
true to avoid performance penalties from path verification.
@@ -468,24 +454,19 @@ SessionDataSet executeAggregationQuery(
* Execute query statement
-Query statements return data.
-
``` java
SessionDataSet executeQueryStatement(String sql)
```
* Execute non query statement
-Non-Query statements don't return data (Delete, Create, ... statements)
-
``` java
void executeNonQueryStatement(String sql)
```
### Write Test Interface (to profile network cost)
-These methods **don't** insert data into database.
-The server just return after accepting the request.
+These methods **don't** insert data into database and server just return after
accept the request.
* Test the network and client cost of insertRecord
@@ -521,40 +502,44 @@ void testInsertTablets(Map<String, Tablet> tablets)
### Coding Examples
-To get more information about the following methods, please have a look at
[Session.java](https://github.com/apache/iotdb/blob/master/iotdb-client/session/src/main/java/org/apache/iotdb/session/Session.java).
+To get more information of the following interfaces, please view
session/src/main/java/org/apache/iotdb/session/Session.java
+
+The sample code of using these interfaces is in
example/session/src/main/java/org/apache/iotdb/SessionExample.java，which
provides an example of how to open an IoTDB session, execute a batch insertion.
-The sample code for using these methods is located in
[SessionExample.java](https://github.com/apache/iotdb/blob/master/example/session/src/main/java/org/apache/iotdb/SessionExample.java)，which
provides an example of how to open an IoTDB session and execute a batch
insertion.
+For examples of aligned timeseries and measurement template, you can refer to
`example/session/src/main/java/org/apache/iotdb/AlignedTimeseriesSessionExample.java`
-For examples of aligned timeseries and schema template, you can refer to
[AlignedTimeseriesSessionExample.java](https://github.com/apache/iotdb/blob/master/example/session/src/main/java/org/apache/iotdb/AlignedTimeseriesSessionExample.java).
## Session Pool for Native API
-We provide a connection pool (`SessionPool`) for Native API.
-When creating such a SessionPool, you need to define the pool size.
+We provide a connection pool (`SessionPool) for Native API.
+Using the interface, you need to define the pool size.
-If you can not get a session connection within 60 seconds, a warning will be
logged but the program will hang.
+If you can not get a session connection in 60 seconds, there is a warning log
but the program will hang.
If a session has finished an operation, it will be put back to the pool
automatically.
-
-If a session connection is broken, the session will be removed automatically
and the pool will try to create a new session and redo the operation.
-
-You can also specify an url list of multiple reachable nodes when creating a
SessionPool, just as you would, when creating a Session to ensure high
availability of clients in distributed cluster environments.
+If a session connection is broken, the session will be removed automatically
and the pool will try
+to create a new session and redo the operation.
+You can also specify an url list of multiple reachable nodes when creating a
SessionPool, just as you would when creating a Session. To ensure high
availability of clients in distributed cluster.
For query operations:
-1. When using SessionPool to query data, the result set is
`SessionDataSetWrapper`.
-2. Given a `SessionDataSetWrapper`, if you have not scanned all the data in it
and stop to use it, you have to call `SessionPool.closeResultSet(wrapper)`
manually.
-3. When you call `hasNext()` and `next()` of a `SessionDataSetWrapper` and
there is an exception, then you have to call
`SessionPool.closeResultSet(wrapper)` manually.
-4. You can call `getColumnNames()` of `SessionDataSetWrapper` to get the
column names of query result.
+1. When using SessionPool to query data, the result set is
`SessionDataSetWrapper`;
+2. Given a `SessionDataSetWrapper`, if you have not scanned all the data in it
and stop to use it,
+you have to call `SessionPool.closeResultSet(wrapper)` manually;
+3. When you call `hasNext()` and `next()` of a `SessionDataSetWrapper` and
there is an exception, then
+you have to call `SessionPool.closeResultSet(wrapper)` manually;
+4. You can call `getColumnNames()` of `SessionDataSetWrapper` to get the
column names of query result;
+
+Examples:
```session/src/test/java/org/apache/iotdb/session/pool/SessionPoolTest.java```
-Examples:
[SessionPoolTest.java](https://github.com/apache/iotdb/blob/master/iotdb-client/session/src/test/java/org/apache/iotdb/session/pool/SessionPoolTest.java)
-Or:
[SessionPoolExample.java](https://github.com/apache/iotdb/blob/master/example/session/src/main/java/org/apache/iotdb/SessionPoolExample.java)
+Or `example/session/src/main/java/org/apache/iotdb/SessionPoolExample.java`
## Cluster information related APIs (only works in the cluster mode)
-Cluster information related APIs allow users to retrieve information about the
cluster like where a database will be persisted to or the status of each node
in the cluster.
+Cluster information related APIs allow users get the cluster info like where a
database will be
+partitioned to, the status of each node in the cluster.
-To use the APIs, please add the following dependency in your pom file:
+To use the APIs, add dependency in your pom file:
```xml
<dependencies>
diff --git a/src/UserGuide/Master/Basic-Concept/Encoding-and-Compression.md
b/src/UserGuide/Master/Basic-Concept/Encoding-and-Compression.md
index 5116b84..36a5b6e 100644
--- a/src/UserGuide/Master/Basic-Concept/Encoding-and-Compression.md
+++ b/src/UserGuide/Master/Basic-Concept/Encoding-and-Compression.md
@@ -116,7 +116,7 @@ IoTDB allows you to specify the compression method of the
column when creating a
* LZMA2
-The specified syntax for compression is detailed in [Create Timeseries
Statement](../Reference/SQL-Reference.md).
+The specified syntax for compression is detailed in [Create Timeseries
Statement](../SQL-Manual/SQL-Manual.md).
### Compression Ratio Statistics
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 7c4191f..d74bf39 100644
---
a/src/UserGuide/Master/Deployment-and-Maintenance/Deployment-Guide_timecho.md
+++
b/src/UserGuide/Master/Deployment-and-Maintenance/Deployment-Guide_timecho.md
@@ -830,7 +830,7 @@ and DataNode configuration (see Chap 5.2.3).
Open the common configuration file ./conf/iotdb-common.properties,
and set the following parameters base on the
-[Deployment
Recommendation](https://iotdb.apache.org/UserGuide/Master/Cluster/Deployment-Recommendation.html):
+[Deployment Recommendation](./Deployment-Recommendation.md):
| **Configuration** | **Description**
| **Default** |
| ------------------------------------------ |
------------------------------------------------------------ |
----------------------------------------------- |
@@ -905,7 +905,7 @@ Before start the Seed-ConfigNode, please open the common
configuration file ./co
| data\_replication\_factor | Is set to the expected data
replication count |
| data\_region\_consensus\_protocol\_class | Is set to the expected
consensus protocol |
-**Notice:** Please set these parameters carefully based on the [Deployment
Recommendation](https://iotdb.apache.org/UserGuide/Master/Cluster/Deployment-Recommendation.html).
+**Notice:** Please set these parameters carefully based on the [Deployment
Recommendation](./Deployment-Recommendation.md).
These parameters are not modifiable after the Node first startup.
Then open its configuration file ./conf/iotdb-confignode.properties and check
the following parameters:
diff --git a/src/UserGuide/Master/User-Manual/Operate-Metadata.md
b/src/UserGuide/Master/User-Manual/Operate-Metadata.md
index 15b078c..5590341 100644
--- a/src/UserGuide/Master/User-Manual/Operate-Metadata.md
+++ b/src/UserGuide/Master/User-Manual/Operate-Metadata.md
@@ -292,7 +292,7 @@ To Show TTL, we can use following SQL statement:
```
IoTDB> SHOW ALL TTL
-IoTDB> SHOW TTL ON StorageGroupNames
+IoTDB> SHOW TTL ON DataBaseNames
```
The SHOW ALL TTL example gives the TTL for all databases.
@@ -813,7 +813,7 @@ create timeseries root.turbine.d1.s1(temprature) with
datatype=FLOAT, encoding=R
The `temprature` in the brackets is an alias for the sensor `s1`. So we can
use `temprature` to replace `s1` anywhere.
-> IoTDB also supports [using AS
function](../Reference/SQL-Reference.md#data-management-statement) to set
alias. The difference between the two is: the alias set by the AS function is
used to replace the whole time series name, temporary and not bound with the
time series; while the alias mentioned above is only used as the alias of the
sensor, which is bound with it and can be used equivalent to the original
sensor name.
+> IoTDB also supports using AS function to set alias. The difference between
the two is: the alias set by the AS function is used to replace the whole time
series name, temporary and not bound with the time series; while the alias
mentioned above is only used as the alias of the sensor, which is bound with it
and can be used equivalent to the original sensor name.
> Notice that the size of the extra tag and attribute information shouldn't
> exceed the `tag_attribute_total_size`.
diff --git a/src/UserGuide/Master/User-Manual/Operator-and-Expression.md
b/src/UserGuide/Master/User-Manual/Operator-and-Expression.md
index 1dea32b..5d14be3 100644
--- a/src/UserGuide/Master/User-Manual/Operator-and-Expression.md
+++ b/src/UserGuide/Master/User-Manual/Operator-and-Expression.md
@@ -321,7 +321,7 @@ The result set is：
### Operator
-See chapter 1 of this documentation for a list of operators supported in IoTDB.
+See this documentation for a list of operators supported in IoTDB.
### Function
@@ -349,7 +349,7 @@ All time series generation functions accept * as input, and
all can be mixed wit
##### Built-in Time Series Generation Functions
-See chapter 2 of this documentation for a list of built-in functions supported
in IoTDB.
+See this documentation for a list of built-in functions supported in IoTDB.
##### User-Defined Time Series Generation Functions
diff --git a/src/UserGuide/Master/User-Manual/Query-Data.md
b/src/UserGuide/Master/User-Manual/Query-Data.md
index b9d443a..7c2f5f0 100644
--- a/src/UserGuide/Master/User-Manual/Query-Data.md
+++ b/src/UserGuide/Master/User-Manual/Query-Data.md
@@ -275,7 +275,7 @@ In IoTDB, there are two ways to execute data query:
Data query statements can be used in SQL command-line terminals, JDBC, JAVA /
C++ / Python / Go and other native APIs, and RESTful APIs.
-- Execute the query statement in the SQL command line terminal: start the SQL
command line terminal, and directly enter the query statement to execute, see
[SQL command line terminal](../QuickStart/Command-Line-Interface.md).
+- Execute the query statement in the SQL command line terminal: start the SQL
command line terminal, and directly enter the query statement to execute, see
[SQL command line terminal](../Tools-System/CLI.md).
- Execute query statements in JDBC, see [JDBC](../API/Programming-JDBC.md) for
details.
diff --git a/src/UserGuide/latest/API/Programming-Java-Native-API.md
b/src/UserGuide/latest/API/Programming-Java-Native-API.md
index 921d3ea..4fe0bee 100644
--- a/src/UserGuide/latest/API/Programming-Java-Native-API.md
+++ b/src/UserGuide/latest/API/Programming-Java-Native-API.md
@@ -47,7 +47,7 @@ In root directory:
## Syntax Convention
-- **IoTDB-SQL interface:** The input SQL parameter needs to conform to the
[syntax conventions](../Syntax-Conventions/Literal-Values.md) and be escaped
for JAVA strings. For example, you need to add a backslash before the
double-quotes. (That is: after JAVA escaping, it is consistent with the SQL
statement executed on the command line.)
+- **IoTDB-SQL interface:** The input SQL parameter needs to conform to the
[syntax conventions](../User-Manual/Syntax-Rule.md#Literal-Values) and be
escaped for JAVA strings. For example, you need to add a backslash before the
double-quotes. (That is: after JAVA escaping, it is consistent with the SQL
statement executed on the command line.)
- **Other interfaces:**
- The node names in path or path prefix as parameter: The node names which
should be escaped by backticks (`) in the SQL statement, escaping is required
here.
- Identifiers (such as template names) as parameters: The identifiers which
should be escaped by backticks (`) in the SQL statement, and escaping is not
required here.
diff --git a/src/UserGuide/latest/Basic-Concept/Encoding-and-Compression.md
b/src/UserGuide/latest/Basic-Concept/Encoding-and-Compression.md
index 5116b84..36a5b6e 100644
--- a/src/UserGuide/latest/Basic-Concept/Encoding-and-Compression.md
+++ b/src/UserGuide/latest/Basic-Concept/Encoding-and-Compression.md
@@ -116,7 +116,7 @@ IoTDB allows you to specify the compression method of the
column when creating a
* LZMA2
-The specified syntax for compression is detailed in [Create Timeseries
Statement](../Reference/SQL-Reference.md).
+The specified syntax for compression is detailed in [Create Timeseries
Statement](../SQL-Manual/SQL-Manual.md).
### Compression Ratio Statistics
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 7c4191f..d74bf39 100644
---
a/src/UserGuide/latest/Deployment-and-Maintenance/Deployment-Guide_timecho.md
+++
b/src/UserGuide/latest/Deployment-and-Maintenance/Deployment-Guide_timecho.md
@@ -830,7 +830,7 @@ and DataNode configuration (see Chap 5.2.3).
Open the common configuration file ./conf/iotdb-common.properties,
and set the following parameters base on the
-[Deployment
Recommendation](https://iotdb.apache.org/UserGuide/Master/Cluster/Deployment-Recommendation.html):
+[Deployment Recommendation](./Deployment-Recommendation.md):
| **Configuration** | **Description**
| **Default** |
| ------------------------------------------ |
------------------------------------------------------------ |
----------------------------------------------- |
@@ -905,7 +905,7 @@ Before start the Seed-ConfigNode, please open the common
configuration file ./co
| data\_replication\_factor | Is set to the expected data
replication count |
| data\_region\_consensus\_protocol\_class | Is set to the expected
consensus protocol |
-**Notice:** Please set these parameters carefully based on the [Deployment
Recommendation](https://iotdb.apache.org/UserGuide/Master/Cluster/Deployment-Recommendation.html).
+**Notice:** Please set these parameters carefully based on the [Deployment
Recommendation](./Deployment-Recommendation.md).
These parameters are not modifiable after the Node first startup.
Then open its configuration file ./conf/iotdb-confignode.properties and check
the following parameters:
diff --git a/src/UserGuide/latest/User-Manual/Operate-Metadata.md
b/src/UserGuide/latest/User-Manual/Operate-Metadata.md
index 15b078c..5590341 100644
--- a/src/UserGuide/latest/User-Manual/Operate-Metadata.md
+++ b/src/UserGuide/latest/User-Manual/Operate-Metadata.md
@@ -292,7 +292,7 @@ To Show TTL, we can use following SQL statement:
```
IoTDB> SHOW ALL TTL
-IoTDB> SHOW TTL ON StorageGroupNames
+IoTDB> SHOW TTL ON DataBaseNames
```
The SHOW ALL TTL example gives the TTL for all databases.
@@ -813,7 +813,7 @@ create timeseries root.turbine.d1.s1(temprature) with
datatype=FLOAT, encoding=R
The `temprature` in the brackets is an alias for the sensor `s1`. So we can
use `temprature` to replace `s1` anywhere.
-> IoTDB also supports [using AS
function](../Reference/SQL-Reference.md#data-management-statement) to set
alias. The difference between the two is: the alias set by the AS function is
used to replace the whole time series name, temporary and not bound with the
time series; while the alias mentioned above is only used as the alias of the
sensor, which is bound with it and can be used equivalent to the original
sensor name.
+> IoTDB also supports using AS function to set alias. The difference between
the two is: the alias set by the AS function is used to replace the whole time
series name, temporary and not bound with the time series; while the alias
mentioned above is only used as the alias of the sensor, which is bound with it
and can be used equivalent to the original sensor name.
> Notice that the size of the extra tag and attribute information shouldn't
> exceed the `tag_attribute_total_size`.
diff --git a/src/UserGuide/latest/User-Manual/Operator-and-Expression.md
b/src/UserGuide/latest/User-Manual/Operator-and-Expression.md
index 1dea32b..5d14be3 100644
--- a/src/UserGuide/latest/User-Manual/Operator-and-Expression.md
+++ b/src/UserGuide/latest/User-Manual/Operator-and-Expression.md
@@ -321,7 +321,7 @@ The result set is：
### Operator
-See chapter 1 of this documentation for a list of operators supported in IoTDB.
+See this documentation for a list of operators supported in IoTDB.
### Function
@@ -349,7 +349,7 @@ All time series generation functions accept * as input, and
all can be mixed wit
##### Built-in Time Series Generation Functions
-See chapter 2 of this documentation for a list of built-in functions supported
in IoTDB.
+See this documentation for a list of built-in functions supported in IoTDB.
##### User-Defined Time Series Generation Functions
diff --git a/src/UserGuide/latest/User-Manual/Query-Data.md
b/src/UserGuide/latest/User-Manual/Query-Data.md
index b9d443a..7c2f5f0 100644
--- a/src/UserGuide/latest/User-Manual/Query-Data.md
+++ b/src/UserGuide/latest/User-Manual/Query-Data.md
@@ -275,7 +275,7 @@ In IoTDB, there are two ways to execute data query:
Data query statements can be used in SQL command-line terminals, JDBC, JAVA /
C++ / Python / Go and other native APIs, and RESTful APIs.
-- Execute the query statement in the SQL command line terminal: start the SQL
command line terminal, and directly enter the query statement to execute, see
[SQL command line terminal](../QuickStart/Command-Line-Interface.md).
+- Execute the query statement in the SQL command line terminal: start the SQL
command line terminal, and directly enter the query statement to execute, see
[SQL command line terminal](../Tools-System/CLI.md).
- Execute query statements in JDBC, see [JDBC](../API/Programming-JDBC.md) for
details.
diff --git a/src/zh/UserGuide/Master/User-Manual/Operate-Metadata.md
b/src/zh/UserGuide/Master/User-Manual/Operate-Metadata.md
index 2ff1c45..e08eeba 100644
--- a/src/zh/UserGuide/Master/User-Manual/Operate-Metadata.md
+++ b/src/zh/UserGuide/Master/User-Manual/Operate-Metadata.md
@@ -188,7 +188,7 @@ IoTDB> unset ttl to root.**
```
IoTDB> SHOW ALL TTL
-IoTDB> SHOW TTL ON StorageGroupNames
+IoTDB> SHOW TTL ON DataBaseNames
```
SHOW ALL TTL 这个例子会给出所有 database 的 TTL。
diff --git a/src/zh/UserGuide/latest/User-Manual/Operate-Metadata.md
b/src/zh/UserGuide/latest/User-Manual/Operate-Metadata.md
index 2ff1c45..e08eeba 100644
--- a/src/zh/UserGuide/latest/User-Manual/Operate-Metadata.md
+++ b/src/zh/UserGuide/latest/User-Manual/Operate-Metadata.md
@@ -188,7 +188,7 @@ IoTDB> unset ttl to root.**
```
IoTDB> SHOW ALL TTL
-IoTDB> SHOW TTL ON StorageGroupNames
+IoTDB> SHOW TTL ON DataBaseNames
```
SHOW ALL TTL 这个例子会给出所有 database 的 TTL。
