You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iotdb.apache.org by ha...@apache.org on 2023/02/24 05:55:50 UTC
[iotdb] branch rel/1.0 updated: fix-badurl-of-1.0 (#9128)
This is an automated email from the ASF dual-hosted git repository.
haonan pushed a commit to branch rel/1.0
in repository https://gitbox.apache.org/repos/asf/iotdb.git
The following commit(s) were added to refs/heads/rel/1.0 by this push:
new fb4d8b6391 fix-badurl-of-1.0 (#9128)
fb4d8b6391 is described below
commit fb4d8b63919c4f58d244f4434867421237e9100e
Author: wanghui42 <10...@users.noreply.github.com>
AuthorDate: Fri Feb 24 13:55:43 2023 +0800
fix-badurl-of-1.0 (#9128)
---
docs/UserGuide/API/Programming-Java-Native-API.md | 2 +-
docs/UserGuide/Data-Concept/Data-Model-and-Terminology.md | 2 +-
docs/UserGuide/Monitor-Alert/Alerting.md | 4 ++--
docs/UserGuide/Operate-Metadata/Timeseries.md | 2 +-
docs/UserGuide/Query-Data/Select-Expression.md | 3 +--
docs/UserGuide/Write-Data/Batch-Load-Tool.md | 2 +-
docs/zh/UserGuide/API/Programming-Java-Native-API.md | 2 +-
docs/zh/UserGuide/Data-Concept/Data-Model-and-Terminology.md | 2 +-
docs/zh/UserGuide/Monitor-Alert/Alerting.md | 4 ++--
docs/zh/UserGuide/Operate-Metadata/Timeseries.md | 2 +-
docs/zh/UserGuide/Query-Data/Select-Expression.md | 2 +-
docs/zh/UserGuide/Write-Data/Batch-Load-Tool.md | 2 +-
site/src/main/.vuepress/config.js | 2 ++
13 files changed, 16 insertions(+), 15 deletions(-)
diff --git a/docs/UserGuide/API/Programming-Java-Native-API.md b/docs/UserGuide/API/Programming-Java-Native-API.md
index 8e42fb7be5..0de45ff23e 100644
--- a/docs/UserGuide/API/Programming-Java-Native-API.md
+++ b/docs/UserGuide/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](../Reference/Syntax-Conventions.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](../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.)
- **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/docs/UserGuide/Data-Concept/Data-Model-and-Terminology.md b/docs/UserGuide/Data-Concept/Data-Model-and-Terminology.md
index 393630fd03..b2068a2627 100644
--- a/docs/UserGuide/Data-Concept/Data-Model-and-Terminology.md
+++ b/docs/UserGuide/Data-Concept/Data-Model-and-Terminology.md
@@ -85,7 +85,7 @@ The following are the constraints on the `nodeName`:
* [ 0-9 a-z A-Z _ ] （letters, numbers, underscore)
* ['\u2E80'..'\u9FFF'] （Chinese characters）
* In particular, if the system is deployed on a Windows machine, the database layer name will be case-insensitive. For example, creating both `root.ln` and `root.LN` at the same time is not allowed.
-* If you want to use special characters in `nodeName`, you can quote it with back quote, detailed information can be found here: [Syntax-Conventions](https://iotdb.apache.org/UserGuide/Master/Reference/Syntax-Conventions.html).
+* If you want to use special characters in `nodeName`, you can quote it with back quote, detailed information can be found here: [Syntax-Conventions](../Syntax-Conventions/Literal-Values.md).
### Path Pattern
diff --git a/docs/UserGuide/Monitor-Alert/Alerting.md b/docs/UserGuide/Monitor-Alert/Alerting.md
index e94b3f35a2..6f81bfede4 100644
--- a/docs/UserGuide/Monitor-Alert/Alerting.md
+++ b/docs/UserGuide/Monitor-Alert/Alerting.md
@@ -39,7 +39,7 @@ The data sink then forwards the alert to the external terminal.
* It is Suitable for scenarios where the original data needs to be down-sampled and persisted.
* Since the timing query hardly affects the writing of the original time series, it is suitable for scenarios that are sensitive to the performance of the original data writing performance.
-With the introduction of the [Trigger](../Triggers/Triggers.md) into IoTDB,
+With the introduction of the [Trigger](../Trigger/Instructions.md) into IoTDB,
at present, users can use these two modules with `AlertManager` to realize the writing triggered alerting mode.
@@ -248,7 +248,7 @@ or `/alertmanager/api/v2/alerts`.
### Writing the trigger class
The user defines a trigger by creating a Java class and writing the logic in the hook.
-Please refer to [Triggers](Triggers.md) for the specific configuration process.
+Please refer to [Triggers](../Trigger/Implement-Trigger.md) for the specific configuration process.
The following example creates the `org.apache.iotdb.trigger.ClusterAlertingExample` class,
Its alertManagerHandler member variables can send alerts to the AlertManager instance
diff --git a/docs/UserGuide/Operate-Metadata/Timeseries.md b/docs/UserGuide/Operate-Metadata/Timeseries.md
index 13510bc21b..07ee8d6fb6 100644
--- a/docs/UserGuide/Operate-Metadata/Timeseries.md
+++ b/docs/UserGuide/Operate-Metadata/Timeseries.md
@@ -240,7 +240,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/DML-Data-Manipulation-Language.md) 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](../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.
> Notice that the size of the extra tag and attribute information shouldn't exceed the `tag_attribute_total_size`.
diff --git a/docs/UserGuide/Query-Data/Select-Expression.md b/docs/UserGuide/Query-Data/Select-Expression.md
index bcfd32dff8..608f3a1da4 100644
--- a/docs/UserGuide/Query-Data/Select-Expression.md
+++ b/docs/UserGuide/Query-Data/Select-Expression.md
@@ -85,8 +85,7 @@ See the documentation [Operators and Functions](../Operators-Functions/Overview.
#### User-Defined time series generation function
-IoTDB supports function extension through [User-Defined Function](./User-Defined-Function.md) capability.
-
+IoTDB supports function extension through User Defined Function (click for [User-Defined Function](../Operators-Functions/User-Defined-Function.md)) capability.
## Nested Expressions
IoTDB supports the calculation of arbitrary nested expressions. Since time series query and aggregation query can not be used in a query statement at the same time, we divide nested expressions into two types, which are nested expressions with time series query and nested expressions with aggregation query.
diff --git a/docs/UserGuide/Write-Data/Batch-Load-Tool.md b/docs/UserGuide/Write-Data/Batch-Load-Tool.md
index d6aa73854f..912c2bb0cc 100644
--- a/docs/UserGuide/Write-Data/Batch-Load-Tool.md
+++ b/docs/UserGuide/Write-Data/Batch-Load-Tool.md
@@ -25,7 +25,7 @@ In different scenarios, the IoTDB provides a variety of methods for importing da
## TsFile Batch Load
-TsFile is the file format of time series used in IoTDB. You can directly import one or more TsFile files with time series into another running IoTDB instance through tools such as CLI. For details, see [TsFile Load Tool](../Maintenance-Tools/Load-TsFile.md) [TsFile Export Tools](../Maintenance-Tools/TsFile-Load-Export-Tool.md).
+TsFile is the file format of time series used in IoTDB. You can directly import one or more TsFile files with time series into another running IoTDB instance through tools such as CLI. For details, see [TsFile Load Tool](../Maintenance-Tools/Load-Tsfile.md) [TsFile Export Tools](../Maintenance-Tools/TsFile-Load-Export-Tool.md).
## CSV Batch Load
diff --git a/docs/zh/UserGuide/API/Programming-Java-Native-API.md b/docs/zh/UserGuide/API/Programming-Java-Native-API.md
index fe774b3145..86ae52f9ca 100644
--- a/docs/zh/UserGuide/API/Programming-Java-Native-API.md
+++ b/docs/zh/UserGuide/API/Programming-Java-Native-API.md
@@ -50,7 +50,7 @@ mvn clean install -pl session -am -Dmaven.test.skip=true
## 语法说明
- - 对于 IoTDB-SQL 接口：传入的 SQL 参数需要符合 [语法规范](../Reference/Syntax-Conventions.md) ，并且针对 JAVA 字符串进行反转义，如双引号前需要加反斜杠。（即：经 JAVA 转义之后与命令行执行的 SQL 语句一致。）
+ - 对于 IoTDB-SQL 接口：传入的 SQL 参数需要符合 [语法规范](../Syntax-Conventions/Literal-Values.md) ，并且针对 JAVA 字符串进行反转义，如双引号前需要加反斜杠。（即：经 JAVA 转义之后与命令行执行的 SQL 语句一致。）
- 对于其他接口：
- 经参数传入的路径或路径前缀中的节点： 在 SQL 语句中需要使用反引号（`）进行转义的，此处均需要进行转义。
- 经参数传入的标识符（如模板名）：在 SQL 语句中需要使用反引号（`）进行转义的，均可以不用进行转义。
diff --git a/docs/zh/UserGuide/Data-Concept/Data-Model-and-Terminology.md b/docs/zh/UserGuide/Data-Concept/Data-Model-and-Terminology.md
index e559251312..59f313ad1b 100644
--- a/docs/zh/UserGuide/Data-Concept/Data-Model-and-Terminology.md
+++ b/docs/zh/UserGuide/Data-Concept/Data-Model-and-Terminology.md
@@ -88,7 +88,7 @@ wildcard
* [ 0-9 a-z A-Z _ ] （字母，数字，下划线）
* ['\u2E80'..'\u9FFF'] （UNICODE 中文字符）
* 特别地，如果系统在 Windows 系统上部署，那么 database 路径结点名是大小写不敏感的。例如，同时创建`root.ln` 和 `root.LN` 是不被允许的。
-* 如果需要在路径结点名中用特殊字符，可以用反引号引用路径结点名，具体使用方法可以参考[语法约定](../Reference/Syntax-Conventions.md)。
+* 如果需要在路径结点名中用特殊字符，可以用反引号引用路径结点名，具体使用方法可以参考[语法约定](../Syntax-Conventions/Literal-Values.md)。
### 路径模式（Path Pattern）
diff --git a/docs/zh/UserGuide/Monitor-Alert/Alerting.md b/docs/zh/UserGuide/Monitor-Alert/Alerting.md
index 7ac10eb7e2..9aa5de937d 100644
--- a/docs/zh/UserGuide/Monitor-Alert/Alerting.md
+++ b/docs/zh/UserGuide/Monitor-Alert/Alerting.md
@@ -39,7 +39,7 @@ IoTDB 告警功能预计支持两种模式：
* 适合需要将原始数据降采样并持久化的场景。
* 由于定时查询几乎不影响原始时间序列的写入，适合对原始数据写入性能敏感的场景。
-随着 [Trigger](../Trigger/Triggers.md) 模块的引入，可以实现写入触发模式的告警。
+随着 [Trigger](../Trigger/Instructions.md) 模块的引入，可以实现写入触发模式的告警。
## 部署 AlertManager
@@ -243,7 +243,7 @@ inhibit_rules:
### 编写 trigger 类
用户通过自行创建 Java 类、编写钩子中的逻辑来定义一个触发器。
-具体配置流程参见 [Triggers](Triggers.md)。
+具体配置流程参见 [Triggers](../Trigger/Implement-Trigger.md)。
下面的示例创建了 `org.apache.iotdb.trigger.ClusterAlertingExample` 类，
其 `alertManagerHandler`
diff --git a/docs/zh/UserGuide/Operate-Metadata/Timeseries.md b/docs/zh/UserGuide/Operate-Metadata/Timeseries.md
index f2a06c360b..6417c1f3d2 100644
--- a/docs/zh/UserGuide/Operate-Metadata/Timeseries.md
+++ b/docs/zh/UserGuide/Operate-Metadata/Timeseries.md
@@ -238,7 +238,7 @@ create timeseries root.turbine.d1.s1(temprature) with datatype=FLOAT, encoding=R
括号里的`temprature`是`s1`这个传感器的别名。
我们可以在任何用到`s1`的地方，将其用`temprature`代替，这两者是等价的。
-> IoTDB 同时支持在查询语句中 [使用 AS 函数](../Reference/DML-Data-Manipulation%20Language.md) 设置别名。二者的区别在于：AS 函数设置的别名用于替代整条时间序列名，且是临时的，不与时间序列绑定；而上文中的别名只作为传感器的别名，与其绑定且可与原传感器名等价使用。
+> IoTDB 同时支持在查询语句中 [使用 AS 函数](../Reference/SQL-Reference.md#数据管理语句) 设置别名。二者的区别在于：AS 函数设置的别名用于替代整条时间序列名，且是临时的，不与时间序列绑定；而上文中的别名只作为传感器的别名，与其绑定且可与原传感器名等价使用。
> 注意：额外的标签和属性信息总的大小不能超过`tag_attribute_total_size`.
diff --git a/docs/zh/UserGuide/Query-Data/Select-Expression.md b/docs/zh/UserGuide/Query-Data/Select-Expression.md
index b95be40eee..34ac7e3c3c 100644
--- a/docs/zh/UserGuide/Query-Data/Select-Expression.md
+++ b/docs/zh/UserGuide/Query-Data/Select-Expression.md
@@ -86,7 +86,7 @@ IoTDB 中支持的内置函数列表见文档 [运算符和函数](../Operators-
#### 自定义时间序列生成函数
-IoTDB 支持通过 [用户自定义函数](./User-Defined-Function.md) 能力进行函数功能扩展。
+IoTDB 支持支持通过用户自定义函数（点击查看： [用户自定义函数](../Operators-Functions/User-Defined-Function.md) ） 能力进行函数功能扩展。
## 嵌套表达式举例
diff --git a/docs/zh/UserGuide/Write-Data/Batch-Load-Tool.md b/docs/zh/UserGuide/Write-Data/Batch-Load-Tool.md
index 617305a5e4..ce767979bd 100644
--- a/docs/zh/UserGuide/Write-Data/Batch-Load-Tool.md
+++ b/docs/zh/UserGuide/Write-Data/Batch-Load-Tool.md
@@ -25,7 +25,7 @@
## TsFile批量导入
-TsFile 是在 IoTDB 中使用的时间序列的文件格式，您可以通过CLI等工具直接将存有时间序列的一个或多个 TsFile 文件导入到另外一个正在运行的IoTDB实例中。具体操作方式请参考[TsFile 导入工具](../Maintenance-Tools/Load-TsFile.md)，[TsFile 导出工具](../Maintenance-Tools/TsFile-Load-Export-Tool.md)。
+TsFile 是在 IoTDB 中使用的时间序列的文件格式，您可以通过CLI等工具直接将存有时间序列的一个或多个 TsFile 文件导入到另外一个正在运行的IoTDB实例中。具体操作方式请参考[TsFile 导入工具](../Maintenance-Tools/Load-Tsfile.md)，[TsFile 导出工具](../Maintenance-Tools/TsFile-Load-Export-Tool.md)。
## CSV批量导入
diff --git a/site/src/main/.vuepress/config.js b/site/src/main/.vuepress/config.js
index c2bb69613b..950521d5f9 100644
--- a/site/src/main/.vuepress/config.js
+++ b/site/src/main/.vuepress/config.js
@@ -1049,6 +1049,7 @@ var config = {
['Reference/Common-Config-Manual','Common Config Manual'],
['Reference/ConfigNode-Config-Manual','ConfigNode Config Manual'],
['Reference/DataNode-Config-Manual','DataNode Config Manual'],
+ ['Reference/SQL-Reference','SQL Reference'],
['Reference/Status-Codes','Status Codes'],
['Reference/Keywords','Keywords'],
['Reference/TSDB-Comparison','TSDB Comparison']
@@ -2257,6 +2258,7 @@ var config = {
['Reference/Common-Config-Manual','公共配置参数'],
['Reference/ConfigNode-Config-Manual','ConfigNode配置参数'],
['Reference/DataNode-Config-Manual','DataNode配置参数'],
+ ['Reference/SQL-Reference','SQL参考文档'],
['Reference/Status-Codes','状态码'],
['Reference/Keywords','关键字'],
['Reference/TSDB-Comparison','时间序列数据库比较']