Skip to content

Commit 3b99758

Browse files
authored
docs: standardize download (#478)
* docs: standardize download * chore: tweaks
1 parent ed4b3d0 commit 3b99758

File tree

2 files changed

+118
-116
lines changed

2 files changed

+118
-116
lines changed

src/Download/README.md

Lines changed: 31 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,19 @@
11
<!--
2-
3-
Licensed to the Apache Software Foundation (ASF) under one
4-
or more contributor license agreements. See the NOTICE file
5-
distributed with this work for additional information
6-
regarding copyright ownership. The ASF licenses this file
7-
to you under the Apache License, Version 2.0 (the
8-
"License"); you may not use this file except in compliance
9-
with the License. You may obtain a copy of the License at
10-
11-
http://www.apache.org/licenses/LICENSE-2.0
12-
13-
Unless required by applicable law or agreed to in writing,
14-
software distributed under the License is distributed on an
15-
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16-
KIND, either express or implied. See the License for the
17-
specific language governing permissions and limitations
18-
under the License.
19-
2+
* Licensed to the Apache Software Foundation (ASF) under one
3+
* or more contributor license agreements. See the NOTICE file
4+
* distributed with this work for additional information
5+
* regarding copyright ownership. The ASF licenses this file
6+
* to you under the Apache License, Version 2.0 (the
7+
* "License"); you may not use this file except in compliance
8+
* with the License. You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
2017
-->
2118

2219
# Release version
@@ -233,7 +230,7 @@ Legacy version are available here: [https://archive.apache.org/dist/iotdb/](http
233230

234231
- Set the somaxconn as 65535 to avoid "connection reset" error when the system is under high load.
235232

236-
```
233+
```bash
237234
# Linux
238235
> sudo sysctl -w net.core.somaxconn=65535
239236

@@ -264,7 +261,7 @@ In previous versions of syntax conventions, when do you need to add quotation ma
264261

265262
In previous versions of syntax conventions, path node names were defined as identifiers, but when the path separator . was required in the path node name, single or double quotes were required. This goes against the rule that identifiers are quoted using backquotes.
266263

267-
```SQL
264+
```sql
268265
# In the previous syntax convention, if you need to create a time series root.sg.`www.baidu.com`, you need to use the following statement:
269266
create root.sg.'www.baidu.com' with datatype=BOOLEAN, encoding=PLAIN
270267
@@ -276,7 +273,7 @@ select 'www.baidu.com' from root.sg;
276273
277274
**In the 1.0 syntax conventions, special node names are uniformly quoted using backquotes:**
278275
279-
```SQL
276+
```sql
280277
# In the new syntax convention, if you need to create a time series root.sg.`www.baidu.com`, the syntax is as follows:
281278
create root.sg.`www.baidu.com` with 'datatype' = 'BOOLEAN', 'encoding' = 'PLAIN'
282279
@@ -288,7 +285,7 @@ select `www.baidu.com` from root.sg;
288285
289286
In previous versions of syntax conventions, when single quotes ' and double quotes " are used in path node names, they need to be escaped with a backslash \, and the backslashes will be stored as part of the path node name. Other identifiers do not have this restriction, causing inconsistency.
290287
291-
```SQL
288+
```sql
292289
# Create time series root.sg.\"a
293290
create timeseries root.sg.`\"a` with datatype=TEXT,encoding=PLAIN;
294291
@@ -356,7 +353,7 @@ Query the data of root.sg.a, you can see that there is no unescaping:
356353
357354
Instead use SQL to insert data into root.sg.a:
358355
359-
```SQL
356+
```sql
360357
# SQL insert
361358
insert into root.sg(time, a) values(1, "\\")
362359
insert into root.sg(time, a) values(2, "\t")
@@ -391,27 +388,27 @@ Query the data of root.sg.a, you can see that the string is unescaped:
391388
392389
- The data format (i.e., TsFile data) of v0.12.x and v0.13.x are compatible, but the WAL file is
393390
incompatible. So, you can follow the steps:
394-
- **<font color=red> Execute `SET SYSTEM TO READONLY` command in CLI. </font>**
395-
- **<font color=red> Stop writing new data.</font>**
391+
- **<span style="color:red"> Execute `SET SYSTEM TO READONLY` command in CLI. </span>**
392+
- **<span style="color:red"> Stop writing new data.</span>**
396393
- Execute `flush` command to close all TsFiles.
397394
- We recommend to back up all data files before upgrading for rolling back.
398-
- Just download, unzip v0.13.x.zip, and modify conf/iotdb-engine.properties, **<font color=red> especially the unchangeable configurations like timestamp precision</font>**. Let all the
395+
- Just download, unzip v0.13.x.zip, and modify conf/iotdb-engine.properties, **<span style="color:red"> especially the unchangeable configurations like timestamp precision</span>**. Let all the
399396
directories point to the data folder set in v0.12.x (or the backup folder). You can also modify
400397
other settings if you want.
401398
- Stop IoTDB v0.12.x instance, and then start v0.13.x.
402-
- **<font color=red>After the steps above, please make sure the `iotdb_version` in `data/system/schema/system.properties` file is `0.13.x`.
403-
If not, please change it to `0.13.x` manually.</font>**
399+
- **<span style="color:red">After the steps above, please make sure the `iotdb_version` in `data/system/schema/system.properties` file is `0.13.x`.
400+
If not, please change it to `0.13.x` manually.</span>**
404401
- **NOTICE: V0.13 changes many settings in conf/iotdb-engine.properties, so do not use v0.12's
405402
configuration file directly.**
406403
- **In 0.13, the SQL syntax has been changed. The identifiers not enclosed in backquotes can only contain the following characters, otherwise they need to be enclosed in backquotes.**
407-
- **[0-9 a-z A-Z _ : @ # $ { }] (letters, digits, some special characters)**
408-
- **['\u2E80'..'\u9FFF'] (UNICODE Chinese characters)**
404+
- **\[0-9 a-z A-Z _ : @ # $ { }] (letters, digits, some special characters)**
405+
- **\['\u2E80'..'\u9FFF'] (UNICODE Chinese characters)**
409406
- **In 0.13, if the path node name in the `SELECT` clause consists of pure numbers, it needs to be enclosed in backquotes to distinguish it from the constant in the expression. For example, in the statement "select 123 + \`123\` from root.sg", the former 123 represents a constant, and the latter \`123\` will be spliced with root.sg, indicating the path root.sg.\`123\`.**
410407
411408
- How to upgrade from v0.11.x or v0.10.x to v0.12.x?
412409
413410
- Upgrading from v0.11 or v0.10 to v0.12 is similar as v0.9 to v0.10. The upgrade tool will rewrite the data files automatically.
414-
- **<font color=red>Stop writing new data.</font>**
411+
- **<span style="color:red">Stop writing new data.</span>**
415412
- Call `flush` command using sbin/start-cli.sh in original version to close all TsFiles.
416413
- We recommend to backup the data file (also the wal files and mlog.txt) before upgrading for rolling back.
417414
- Just download, unzip v0.12.x.zip, and modify conf/iotdb-engine.proeprties to let all the
@@ -428,7 +425,7 @@ Query the data of root.sg.a, you can see that the string is unescaped:
428425
429426
- The data format (i.e., TsFile data) of v0.10.x and v0.11 are compatible, but the WAL file is
430427
incompatible. So, you can follow the steps:
431-
- **<font color=red>Stop writing new data.</font>**
428+
- **<span style="color:red">Stop writing new data.</span>**
432429
- Call `flush` command using `sbin/start-cli.sh` in v0.10.x to close all TsFiles.
433430
- We recommend to backup the wal files and mlog.txt before upgrading for rolling back.
434431
- Just download, unzip v0.11.x.zip, and modify conf/iotdb-engine.properties to let all the
@@ -442,7 +439,7 @@ Query the data of root.sg.a, you can see that the string is unescaped:
442439
- How to upgrade from v0.9.x to v0.10.x?
443440
444441
- Upgrading from v0.9 to v0.10 is more complex than v0.8 to v0.9.
445-
- **<font color=red>Stop writing new data.</font>**
442+
- **<span style="color:red">Stop writing new data.</span>**
446443
- Call `flush` command using sbin/start-client.sh in v0.9 to close all TsFiles.
447444
- We recommend to backup the data file (also the wal files and mlog.txt) before upgrading for rolling back.
448445
- Just download, unzip v0.10.x.zip, and modify conf/iotdb-engine.proeprties to let all the
@@ -465,4 +462,4 @@ Find all releases in the [Archive repository](https://archive.apache.org/dist/io
465462
466463
# Verifying Hashes and Signatures
467464
468-
Along with our releases, we also provide sha512 hashes in _.sha512 files and cryptographic signatures in _.asc files. The Apache Software Foundation has an extensive tutorial to [verify hashes and signatures ](http://www.apache.org/info/verification.html)which you can follow by using any of these release-signing [KEYS ](https://downloads.apache.org/iotdb/KEYS).
465+
Along with our releases, we also provide sha512 hashes in `*.sha512` files and cryptographic signatures in `*.asc` files. The Apache Software Foundation has an extensive tutorial to [verify hashes and signatures](http://www.apache.org/info/verification.html)which you can follow by using any of these release-signing [KEYS](https://downloads.apache.org/iotdb/KEYS).

0 commit comments

Comments
 (0)