Skip to content

Commit

Permalink
Fix the doc of English version (#177)
Browse files Browse the repository at this point in the history
  • Loading branch information
wanghui42 authored Feb 7, 2024
1 parent 3364ac0 commit fcc9d43
Show file tree
Hide file tree
Showing 14 changed files with 95 additions and 110 deletions.
167 changes: 76 additions & 91 deletions src/UserGuide/Master/API/Programming-Java-Native-API.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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** |
| ------------------------------------------ | ------------------------------------------------------------ | ----------------------------------------------- |
Expand Down Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions src/UserGuide/Master/User-Manual/Operate-Metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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`.
Expand Down
4 changes: 2 additions & 2 deletions src/UserGuide/Master/User-Manual/Operator-and-Expression.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/UserGuide/Master/User-Manual/Query-Data.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion src/UserGuide/latest/API/Programming-Java-Native-API.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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** |
| ------------------------------------------ | ------------------------------------------------------------ | ----------------------------------------------- |
Expand Down Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions src/UserGuide/latest/User-Manual/Operate-Metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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`.
Expand Down
4 changes: 2 additions & 2 deletions src/UserGuide/latest/User-Manual/Operator-and-Expression.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/UserGuide/latest/User-Manual/Query-Data.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion src/zh/UserGuide/Master/User-Manual/Operate-Metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -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。
Expand Down
2 changes: 1 addition & 1 deletion src/zh/UserGuide/latest/User-Manual/Operate-Metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -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。
Expand Down

0 comments on commit fcc9d43

Please sign in to comment.