This is an automated email from the ASF dual-hosted git repository.
haonan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/iotdb.git
The following commit(s) were added to refs/heads/master by this push:
new 865a246cb9 Add 0.14.0-preview1 download UserGuide (#6573)
865a246cb9 is described below
commit 865a246cb9d2fa80afe5894a7a0acfb74573c963
Author: Jialin Qiao <[email protected]>
AuthorDate: Sun Jul 3 23:04:53 2022 +0800
Add 0.14.0-preview1 download UserGuide (#6573)
Co-authored-by: Haonan <[email protected]>
---
docs/Download/README.md | 44 +++++++++++++++++++++++++++++++-------------
docs/zh/Download/README.md | 34 ++++++++++++++++++++++++++--------
2 files changed, 57 insertions(+), 21 deletions(-)
diff --git a/docs/Download/README.md b/docs/Download/README.md
index 9dcbede313..0c35b44175 100644
--- a/docs/Download/README.md
+++ b/docs/Download/README.md
@@ -28,6 +28,16 @@
<th colspan="3">IoTDB Sources</th>
<th>release notes</th>
</tr>
+ <tr>
+ <td rowspan="1">0.14.0-preview1</td>
+ <td><a
href="https://www.apache.org/dyn/closer.cgi/iotdb/0.14.0-preview1/apache-iotdb-0.14.0-preview1-all-bin.zip";>Cluster</a></td>
+ <td><a
href="https://downloads.apache.org/iotdb/0.14.0-preview1/apache-iotdb-0.14.0-preview1-all-bin.zip.sha512";>SHA512</a></td>
+ <td><a
href="https://downloads.apache.org/iotdb/0.14.0-preview1/apache-iotdb-0.14.0-preview1-all-bin.zip.asc";>ASC</a></td>
+ <td rowspan="1"><a
href="https://www.apache.org/dyn/closer.cgi/iotdb/0.14.0-preview1/apache-iotdb-0.14.0-preview1-source-release.zip";>Sources</a></td>
+ <td rowspan="1"><a
href="https://downloads.apache.org/iotdb/0.14.0-preview1/apache-iotdb-0.14.0-preview1-source-release.zip.sha512";>SHA512</a></td>
+ <td rowspan="1"><a
href="https://downloads.apache.org/iotdb/0.14.0-preview1/apache-iotdb-0.14.0-preview1-source-release.zip.asc";>ASC</a></td>
+ <td rowspan="1"><a
href="https://raw.githubusercontent.com/apache/iotdb/master/RELEASE_NOTES.md";>release
notes</a></td>
+ </tr>
<tr>
<td rowspan="3">0.13.0</td>
<td><a
href="https://www.apache.org/dyn/closer.cgi/iotdb/0.13.0/apache-iotdb-0.13.0-all-bin.zip";>All-in-one</a></td>
@@ -78,7 +88,7 @@
Legacy version are available here:
[https://archive.apache.org/dist/iotdb/](https://archive.apache.org/dist/iotdb/)
-**<font color=red>Attention</font>**:
+## Configurations
- Recommended OS parameters
* Set the somaxconn as 65535 to avoid "connection reset" error when the
system is under high load.
@@ -90,20 +100,28 @@ Legacy version are available here:
[https://archive.apache.org/dist/iotdb/](http
> sudo sysctl -w kern.ipc.somaxconn=65535
```
-- How to upgrade a minor version (e.g., from v0.12.3 to v0.12.5)?
- * versions which have the same major version are compatible.
- * Just download and unzip the new version. Then modify the configuration
files to keep consistent
- with what you set in the old version.
- * stop the old vesion instance, and start the new one.
+## About 0.14.0-preview1
+
+- 0.14.0-preview1 is a preview release for the new IoTDB cluster, which you
could download and have a try.
+ We DO NOT recommend using preview release on-line, and DO NOT upgrade 0.13
to a preview release.
+ - The UserGuide of 0.14.0-preview is still in the **latest**.
-- **How to upgrade from v.13.x to v0.14.x?**
+- **After we release 0.14.0, how to upgrade from v.13.x to v0.14.x?**
- **Version 0.14 has changed the SQL syntax conventions (please refer to the
syntax conventions section of the user manual), the incompatibilities are as
follows:**
- **Identifiers that are not quoted with backquotes are not allowed to be
pure numbers and only allowed to contain letters, Chinese characters, and
underscores. If the above occurs in an identifier, use backquotes to enclose
the identifier.**
- **Identifiers no longer support quoting with single and double quotes,
please use backquotes instead.**
- **When using the path node name in the Session API, it needs to be
consistent with that in the SQL statement. If the path node is a pure number
111, it needs to be enclosed in backquotes in the SQL statement and written as
\`111\`, then when using the Session API, the corresponding parameter also
needs to be written as \`111\`.**
- - In order to ensure the stability of UDF-related APIs, in version 0.14,
UDF-related APIs are separated into an independent module and no longer depend
on the tsfile package. The implemented UDFs need to rewrite the code, replace
`TsDataType` with `Type`, and replace `org .apache.iotdb.tsfile.utils.Binary`
with `org.apache.iotdb.udf.api.type.Binary`, then redo the packaging and
loading process.
-
+ - In order to ensure the stability of UDF-related APIs, in version 0.14,
UDF-related APIs are seperated into an independent module and no longer depend
on the tsfile package. The implemented UDFs need to rewrite the code, replace
`TsDataType` with `Type`, and replace `org .apache.iotdb.tsfile.utils.Binary`
with `org.apache.iotdb.udf.api.type.Binary`, then redo the packaging and
loading process.
+
+## How to Upgrade
+
+- How to upgrade a minor version (e.g., from v0.12.3 to v0.12.5)?
+ * versions which have the same major version are compatible.
+ * Just download and unzip the new version. Then modify the configuration
files to keep consistent
+ with what you set in the old version.
+ * stop the old version instance, and start the new one.
+
- How to upgrade from v.12.x to v0.13.x?
* The data format (i.e., TsFile data) of v0.12.x and v0.13.x are compatible,
but the WAL file is
@@ -138,15 +156,15 @@ Legacy version are available here:
[https://archive.apache.org/dist/iotdb/](http
* __NOTICE 1: V0.12 changes many settings in conf/iotdb-engine.properties,
so do not use previous
configuration file directly.__
* __NOTICE 2: V0.12 doesn't support upgrade from v0.9 or lower version,
please upgrade to v0.10 first if needed.__
- * __NOTICE 3: We don't recommend to delete data before the upgrading
finished. The deletion will fail if you try to delete data in the storage group
with upgrading files.__
+ * __NOTICE 3: We don't recommend deleting data before the upgrading
finished. The deletion will fail if you try to delete data in the storage group
with upgrading files.__
- How to upgrade from v.10.x to v0.11.x?
* The data format (i.e., TsFile data) of v0.10.x and v0.11 are compatible,
but the WAL file is
incompatible. So, you can follow the steps:
* **<font color=red>Stop writing new data.</font>**
* Call `flush` command using `sbin/start-cli.sh` in v0.10.x to close all
TsFiles.
- * We recommend to backup the the wal files and mlog.txt before upgrading for
rolling back.
- * Just download, unzip v0.11.x.zip, and modify conf/iotdb-engine.proeprties
to let all the
+ * We recommend to backup the wal files and mlog.txt before upgrading for
rolling back.
+ * Just download, unzip v0.11.x.zip, and modify conf/iotdb-engine.properties
to let all the
directories point to the data folder set in v0.10.x (or the backup
folder). You can also modify
other settings if you want.
* Stop IoTDB v0.10.x instance, and start v0.11.x, then the IoTDB will
upgrade data file format
@@ -166,7 +184,7 @@ Legacy version are available here:
[https://archive.apache.org/dist/iotdb/](http
- How to upgrade from 0.8.x to v0.9.x?
* We recommend to backup the data file (also the wal files and mlog.txt)
before upgrading for rolling back.
- * Just download, unzip v0.9.x.zip, and modify conf/iotdb-engine.proeprties
to let all the
+ * Just download, unzip v0.9.x.zip, and modify conf/iotdb-engine.properties
to let all the
directories point to the folders set in v0.8.x (or the backup folder).
You can also modify other settings if you want.
* Stop IoTDB v0.8 instance, and start v0.9.x, then the IoTDB will upgrade
data file format automatically.
diff --git a/docs/zh/Download/README.md b/docs/zh/Download/README.md
index 330d212fb3..2759dcb2f7 100644
--- a/docs/zh/Download/README.md
+++ b/docs/zh/Download/README.md
@@ -21,12 +21,22 @@
# 发行版本
<table>
- <tr>
+ <tr>
<th>Version</th>
<th colspan="3">IoTDB Binaries</th>
<th colspan="3">IoTDB Sources</th>
<th>release notes</th>
- </tr>
+ </tr>
+ <tr>
+ <td rowspan="1">0.14.0-preview1</td>
+ <td><a
href="https://www.apache.org/dyn/closer.cgi/iotdb/0.14.0-preview1/apache-iotdb-0.14.0-preview1-all-bin.zip";>分布式</a></td>
+ <td><a
href="https://downloads.apache.org/iotdb/0.14.0-preview1/apache-iotdb-0.14.0-preview1-all-bin.zip.sha512";>SHA512</a></td>
+ <td><a
href="https://downloads.apache.org/iotdb/0.14.0-preview1/apache-iotdb-0.14.0-preview1-all-bin.zip.asc";>ASC</a></td>
+ <td rowspan="1"><a
href="https://www.apache.org/dyn/closer.cgi/iotdb/0.14.0-preview1/apache-iotdb-0.14.0-preview1-source-release.zip";>源代码</a></td>
+ <td rowspan="1"><a
href="https://downloads.apache.org/iotdb/0.14.0-preview1/apache-iotdb-0.14.0-preview1-source-release.zip.sha512";>SHA512</a></td>
+ <td rowspan="1"><a
href="https://downloads.apache.org/iotdb/0.14.0-preview1/apache-iotdb-0.14.0-preview1-source-release.zip.asc";>ASC</a></td>
+ <td rowspan="1"><a
href="https://raw.githubusercontent.com/apache/iotdb/master/RELEASE_NOTES.md";>release
notes</a></td>
+ </tr>
<tr>
<td rowspan="3">0.13.0</td>
<td><a
href="https://www.apache.org/dyn/closer.cgi/iotdb/0.13.0/apache-iotdb-0.13.0-all-bin.zip";>All-in-one</a></td>
@@ -76,7 +86,7 @@
历史版本下载：[https://archive.apache.org/dist/iotdb/](https://archive.apache.org/dist/iotdb/)
-**<font color=red>注意事项</font>**:
+## 环境配置
- 推荐修改的操作系统参数
* 将 somaxconn 设置为 65535 以避免系统在高负载时出现 "connection reset" 错误。
@@ -88,10 +98,11 @@
> sudo sysctl -w kern.ipc.somaxconn=65535
```
-- 如何升级小版本 （例如，从 v0.12.4 to v0.12.5)?
- * 同一个大版本下的多个小版本是互相兼容的。
- * 只需要下载新的小版本， 然后修改其配置文件，使其与原有版本的设置一致。
- * 停掉旧版本进程，启动新版本即可。
+## 关于 0.14.0-preview1
+
+- 0.14.0-preview1 仅包括分布式预览版，供测试及试用，不推荐从 0.13 升级到预览版。
+
+- 0.14.0-preview1 的用户手册在 latest 栏目，未单独新建栏目，正式版会新建栏目。
- 如何从 v0.13.x 升级到 v0.14.x?
@@ -100,7 +111,14 @@
- **标识符不再支持使用单引号和双引号进行引用，请统一改为使用反引号引用。**
- **Session 接口中使用路径结点名时，写法需要与 SQL 语句中的一致。如路径结点为纯数字111，在 SQL
语句中需要使用反引号括起，写作\`111\`, 那么使用 Session 接口时，相应参数也需要写作\`111\`。**
- 为了保证 UDF 相关 API 的稳定性，0.14 版本中 UDF 相关 API 被独立为一个单独的 module，不再依赖 tsfile
包，已经实现的 UDF 需要改写代码，将 `TsDataType` 替换为 `Type`，将
`org.apache.iotdb.tsfile.utils.Binary` 替换成
`org.apache.iotdb.udf.api.type.Binary`，并重新进行打包装载流程。
-
+
+# 如何升级
+
+- 如何升级小版本 （例如，从 v0.12.4 to v0.12.5)?
+ * 同一个大版本下的多个小版本是互相兼容的。
+ * 只需要下载新的小版本， 然后修改其配置文件，使其与原有版本的设置一致。
+ * 停掉旧版本进程，启动新版本即可。
+
- 如何从 v0.12.x 升级到 v0.13.x?
* 0.12 与 0.13 的数据文件格式兼容，但写前日志等格式不兼容，因此需要进行升级（但速度很快）：
* **<font color=red>在 0.12 的 CLI 中执行 `SET SYSTEM TO READONLY`
命令，并停止新数据的写入。</font>**
