You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@doris.apache.org by di...@apache.org on 2022/04/16 12:02:23 UTC
[incubator-doris] branch master updated: Fix get-starting en and zh-CN docs. (#9059)
This is an automated email from the ASF dual-hosted git repository.
diwu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-doris.git
The following commit(s) were added to refs/heads/master by this push:
new a749f98e44 Fix get-starting en and zh-CN docs. (#9059)
a749f98e44 is described below
commit a749f98e448f6646068ec07230baa7c5e7d6d6a1
Author: smallhibiscus <84...@qq.com>
AuthorDate: Sat Apr 16 20:02:14 2022 +0800
Fix get-starting en and zh-CN docs. (#9059)
Co-authored-by: smallhibiscus <844981280>
---
new-docs/en/get-starting/get-starting.md | 97 ++++++++++++++++-------------
new-docs/zh-CN/get-starting/get-starting.md | 89 +++++++++++++++-----------
2 files changed, 107 insertions(+), 79 deletions(-)
diff --git a/new-docs/en/get-starting/get-starting.md b/new-docs/en/get-starting/get-starting.md
index c64624f992..52d5b51ffd 100644
--- a/new-docs/en/get-starting/get-starting.md
+++ b/new-docs/en/get-starting/get-starting.md
@@ -226,7 +226,7 @@ FE splits the query plan into fragments and sends them to BE for task execution.
- After executing the SQL statement, you can view the corresponding SQL statement execution report information on the FE's WEB-UI interface
-For a complete parameter comparison table, please go to [Profile parameter analysis](https://doris.apache.org/zh-CN/administrator-guide/running-profile.html#profile%E5%8F%82%E6 %95%B0%E8%A7%A3%E6%9E%90 ) View Details
+For a complete parameter comparison table, please go to [Profile parameter analysis](../admin-manual/query-profile.html) View Details
#### Library table operations
@@ -242,7 +242,7 @@ For a complete parameter comparison table, please go to [Profile parameter analy
CREATE DATABASE database name;
````
- > For more detailed syntax and best practices used by Create-DataBase, see [Create-DataBase](../../../sql-manual/sql-reference-v2/Data-Definition-Statements/Create /CREATE-DATABASE.html) command manual.
+ > For more detailed syntax and best practices used by Create-DataBase, see [Create-DataBase](../sql-manual/sql-reference-v2/Data-Definition-Statements/Create/CREATE-DATABASE.html) command manual.
>
> If you don't know the full name of the command, you can use "help command a field" for fuzzy query. If you type 'HELP CREATE', you can match `CREATE DATABASE`, `CREATE TABLE`, `CREATE USER` and other commands.
@@ -263,7 +263,7 @@ For a complete parameter comparison table, please go to [Profile parameter analy
- Create data table
- > For more detailed syntax and best practices used by Create-Table, see [Create-Table](../../../sql-manual/sql-reference-v2/Data-Definition-Statements/Create/ CREATE-TABLE.html) command manual.
+ > For more detailed syntax and best practices used by Create-Table, see [Create-Table](../sql-manual/sql-reference-v2/Data-Definition-Statements/Create/CREATE-TABLE.html) command manual.
Use the `CREATE TABLE` command to create a table (Table). More detailed parameters can be viewed:
@@ -277,7 +277,7 @@ For a complete parameter comparison table, please go to [Profile parameter analy
USE example_db;
````
- Doris supports two table creation methods, single partition and composite partition (for details, please refer to [Create-Table](../../../sql-manual/sql-reference-v2/Data-Definition-Statements/Create /CREATE-TABLE.html) command manual).
+ Doris supports two table creation methods, single partition and composite partition (for details, please refer to [Create-Table](../sql-manual/sql-reference-v2/Data-Definition-Statements/Create/CREATE-TABLE.html) command manual).
The following takes the aggregation model as an example to demonstrate the table building statements for two partitions.
@@ -402,7 +402,7 @@ For a complete parameter comparison table, please go to [Profile parameter analy
1. Insert Into
- > For more detailed syntax and best practices for Insert usage, see [Insert](../../../sql-manual/sql-reference-v2/Data-Manipulation-Statements/Manipulation/INSERT.html) Command Manual.
+ > For more detailed syntax and best practices for Insert usage, see [Insert](../sql-manual/sql-reference-v2/Data-Manipulation-Statements/Manipulation/INSERT.html) Command Manual.
The Insert Into statement is used in a similar way to the Insert Into statement in databases such as MySQL. But in Doris, all data writing is a separate import job. Therefore, Insert Into is also introduced as an import method here.
@@ -452,7 +452,7 @@ For a complete parameter comparison table, please go to [Profile parameter analy
- If `status` is `visible`, the data import is successful.
- If `warnings` is greater than 0, it means that data is filtered. You can get the url through the `show load` statement to view the filtered lines.
- For more detailed instructions, see the [Insert](../../../sql-manual/sql-reference-v2/Data-Manipulation-Statements/Manipulation/INSERT.html) command manual.
+ For more detailed instructions, see the [Insert](../sql-manual/sql-reference-v2/Data-Manipulation-Statements/Manipulation/INSERT.html) command manual.
2. Batch Import
@@ -460,7 +460,7 @@ For a complete parameter comparison table, please go to [Profile parameter analy
- Stream-Load
- > For more detailed syntax and best practices used by Stream-Load, see [Stream-Load](../../../sql-manual/sql-reference-v2/Data-Manipulation-Statements/Load/ STREAM-LOAD.html) command manual.
+ > For more detailed syntax and best practices used by Stream-Load, see [Stream-Load](../sql-manual/sql-reference-v2/Data-Manipulation-Statements/Load/STREAM-LOAD.html) command manual.
Streaming import transfers data to Doris through the HTTP protocol, and can directly import local data without relying on other systems or components. See `HELP STREAM LOAD;` for detailed syntax help.
@@ -509,7 +509,7 @@ For a complete parameter comparison table, please go to [Profile parameter analy
Broker import uses the deployed Broker process to read data on external storage for import.
- > For more detailed syntax and best practices used by Broker Load, see [Broker Load](../../../sql-manual/sql-reference-v2/Data-Manipulation-Statements/Load/BROKER- LOAD.html) command manual, you can also enter `HELP BROKER LOAD` in the MySql client command line for more help information.
+ > For more detailed syntax and best practices used by Broker Load, see [Broker Load](../sql-manual/sql-reference-v2/Data-Manipulation-Statements/Load/BROKER-LOAD.html) command manual, you can also enter `HELP BROKER LOAD` in the MySql client command line for more help information.
Example: With "table1_20170708" as the Label, import the files on HDFS into table1
@@ -601,7 +601,7 @@ For a complete parameter comparison table, please go to [Profile parameter analy
#### Update Data
-> For more detailed syntax and best practices used by Update, see [Update](../../../sql-manual/sql-reference-v2/Data-Manipulation-Statements/Manipulation/UPDATE.html) Command Manual.
+> For more detailed syntax and best practices used by Update, see [Update](../sql-manual/sql-reference-v2/Data-Manipulation-Statements/Manipulation/UPDATE.html) Command Manual.
The current UPDATE statement **only supports** row updates on the Unique model, and there may be data conflicts caused by concurrent updates. At present, Doris does not deal with such problems, and users need to avoid such problems from the business side.
@@ -634,56 +634,69 @@ The current UPDATE statement **only supports** row updates on the Unique model,
1. Update the v1 column in the 'test' table that satisfies the conditions k1 =1 , k2 =2 to 1
- ```text
+ ```sql
UPDATE test SET v1 = 1 WHERE k1=1 and k2=2;
```
2. Increment the v1 column of the column k1=1 in the 'test' table by 1
- ```text
+ ```sql
UPDATE test SET v1 = v1+1 WHERE k1=1;
```
#### Delete Data
-> For more detailed syntax and best practices for Delete use, see [Delete](../../../sql-manual/sql-reference-v2/Data-Manipulation-Statements/Manipulation/DELETE.html) Command Manual.
+> For more detailed syntax and best practices for Delete use, see [Delete](../sql-manual/sql-reference-v2/Data-Manipulation-Statements/Manipulation/DELETE.html) Command Manual.
-1. grammar rules
+1. Grammar rules
- ```mysql
This statement is used to conditionally delete data in the specified table (base index) partition.
+
This operation will also delete the data of the rollup index related to this base index.
grammar:
- DELETE FROM table_name [PARTITION partition_name | PARTITIONS (p1, p2)]
- WHERE
- column_name1 op { value | value_list } [ AND column_name2 op { value | value_list } ...];
-
+
+ ```sql
+ DELETE FROM table_name [PARTITION partition_name | PARTITIONS (p1, p2)]
+ WHERE
+ column_name1 op { value | value_list } [ AND column_name2 op { value | value_list } ...];
+ ````
+
illustrate:
- 1) The optional types of op include: =, >, <, >=, <=, !=, in, not in
- 2) Only conditions on the key column can be specified.
- 2) When the selected key column does not exist in a rollup, delete cannot be performed.
- 3) The relationship between conditions can only be "and".
- If you want to achieve an "or" relationship, you need to write the conditions in two DELETE statements.
- 4) If it is a partitioned table, you can specify a partition. If not specified, and the session variable delete_without_partition is true, it will be applied to all partitions. If it is a single-partition table, it can be left unspecified.
-
+
+ - Optional types of op include: =, >, <, >=, <=, !=, in, not in
+
+ - Only conditions on the key column can be specified.
+
+ - Cannot delete when the selected key column does not exist in a rollup.
+
+ - Conditions can only have an AND relationship.
+
+ If you want to achieve an "or" relationship, you need to write the conditions in two DELETE statements.
+
+ - If it is a partitioned table, you can specify a partition, if not specified and the session variable delete_without_partition is true, it will be applied to all partitions. If it is a single-partition table, it can be left unspecified.
+
Notice:
- This statement may reduce query efficiency for a period of time after execution.
- The degree of impact depends on the number of delete conditions specified in the statement.
- The more conditions you specify, the greater the impact.
- ```
+
+ - This statement may reduce query efficiency for a period of time after execution.
+ - The degree of impact depends on the number of delete conditions specified in the statement.
+ - The more conditions you specify, the greater the impact.
2. Example
- ```mysql
- 1. Delete the data row whose k1 column value is 3 in my_table partition p1
- DELETE FROM my_table PARTITION p1
- WHERE k1 = 3;
-
- 2. Delete the data rows where the value of column k1 is greater than or equal to 3 and the value of column k2 is "abc" in my_table partition p1
- DELETE FROM my_table PARTITION p1
- WHERE k1 >= 3 AND k2 = "abc";
-
- 3. Delete the data rows where the value of column k1 is greater than or equal to 3 and the value of column k2 is "abc" in my_table partition p1, p2
- DELETE FROM my_table PARTITIONS (p1, p2)
- WHERE k1 >= 3 AND k2 = "abc";
- ```
\ No newline at end of file
+ 1. Delete the data row whose k1 column value is 3 in my_table partition p1
+
+ ```sql
+ DELETE FROM my_table PARTITION p1 WHERE k1 = 3;
+ ````
+
+ 2. Delete the data rows where the value of column k1 is greater than or equal to 3 and the value of column k2 is "abc" in my_table partition p1
+
+ ```sql
+ DELETE FROM my_table PARTITION p1 WHERE k1 >= 3 AND k2 = "abc";
+ ````
+
+ 3. Delete the data rows where the value of column k1 is greater than or equal to 3 and the value of column k2 is "abc" in my_table partition p1, p2
+
+ ```sql
+ DELETE FROM my_table PARTITIONS (p1, p2) WHERE k1 >= 3 AND k2 = "abc";
+ ````
\ No newline at end of file
diff --git a/new-docs/zh-CN/get-starting/get-starting.md b/new-docs/zh-CN/get-starting/get-starting.md
index a4775154c8..23cd882664 100644
--- a/new-docs/zh-CN/get-starting/get-starting.md
+++ b/new-docs/zh-CN/get-starting/get-starting.md
@@ -226,7 +226,7 @@ FE 将查询计划拆分成为 Fragment 下发到 BE 进行任务执行。BE 在
- 执行 SQL 语句后，可在 FE 的 WEB-UI 界面查看对应的 SQL 语句执行 Report 信息
-如需获取完整的参数对照表，请至 [Profile 参数解析](https://doris.apache.org/zh-CN/administrator-guide/running-profile.html#profile%E5%8F%82%E6%95%B0%E8%A7%A3%E6%9E%90 ) 查看详情
+如需获取完整的参数对照表，请至 [Profile 参数解析](../admin-manual/query-profile.html) 查看详情
#### 库表操作
@@ -242,7 +242,7 @@ FE 将查询计划拆分成为 Fragment 下发到 BE 进行任务执行。BE 在
CREATE DATABASE 数据库名;
```
- > 关于 Create-DataBase 使用的更多详细语法及最佳实践，请参阅 [Create-DataBase](../../../sql-manual/sql-reference-v2/Data-Definition-Statements/Create/CREATE-DATABASE.html) 命令手册。
+ > 关于 Create-DataBase 使用的更多详细语法及最佳实践，请参阅 [Create-DataBase](../sql-manual/sql-reference-v2/Data-Definition-Statements/Create/CREATE-DATABASE.html) 命令手册。
>
> 如果不清楚命令的全名，可以使用 "help 命令某一字段" 进行模糊查询。如键入 'HELP CREATE'，可以匹配到 `CREATE DATABASE`, `CREATE TABLE`, `CREATE USER` 等命令。
@@ -263,7 +263,7 @@ FE 将查询计划拆分成为 Fragment 下发到 BE 进行任务执行。BE 在
- 创建数据表
- > 关于 Create-Table 使用的更多详细语法及最佳实践，请参阅 [Create-Table](../../../sql-manual/sql-reference-v2/Data-Definition-Statements/Create/CREATE-TABLE.html) 命令手册。
+ > 关于 Create-Table 使用的更多详细语法及最佳实践，请参阅 [Create-Table](../sql-manual/sql-reference-v2/Data-Definition-Statements/Create/CREATE-TABLE.html) 命令手册。
使用 `CREATE TABLE` 命令建立一个表(Table)。更多详细参数可以查看:
@@ -277,7 +277,7 @@ FE 将查询计划拆分成为 Fragment 下发到 BE 进行任务执行。BE 在
USE example_db;
```
- Doris 支持支持单分区和复合分区两种建表方式（详细区别请参阅 [Create-Table](../../../sql-manual/sql-reference-v2/Data-Definition-Statements/Create/CREATE-TABLE.html) 命令手册） 。
+ Doris 支持支持单分区和复合分区两种建表方式（详细区别请参阅 [Create-Table](../sql-manual/sql-reference-v2/Data-Definition-Statements/Create/CREATE-TABLE.html) 命令手册） 。
下面以聚合模型为例，演示两种分区的建表语句。
@@ -402,7 +402,7 @@ FE 将查询计划拆分成为 Fragment 下发到 BE 进行任务执行。BE 在
1. Insert Into 插入
- > 关于 Insert 使用的更多详细语法及最佳实践，请参阅 [Insert](../../../sql-manual/sql-reference-v2/Data-Manipulation-Statements/Manipulation/INSERT.html) 命令手册。
+ > 关于 Insert 使用的更多详细语法及最佳实践，请参阅 [Insert](../sql-manual/sql-reference-v2/Data-Manipulation-Statements/Manipulation/INSERT.html) 命令手册。
Insert Into 语句的使用方式和 MySQL 等数据库中 Insert Into 语句的使用方式类似。但在 Doris 中，所有的数据写入都是一个独立的导入作业。所以这里将 Insert Into 也作为一种导入方式介绍。
@@ -452,7 +452,7 @@ FE 将查询计划拆分成为 Fragment 下发到 BE 进行任务执行。BE 在
- 如果 `status` 为 `visible`，表示数据导入成功。
- 如果 `warnings` 大于 0，表示有数据被过滤，可以通过 `show load` 语句获取 url 查看被过滤的行。
- 更多详细说明，请参阅 [Insert](../../../sql-manual/sql-reference-v2/Data-Manipulation-Statements/Manipulation/INSERT.html) 命令手册。
+ 更多详细说明，请参阅 [Insert](../sql-manual/sql-reference-v2/Data-Manipulation-Statements/Manipulation/INSERT.html) 命令手册。
2. 批量导入
@@ -460,7 +460,7 @@ FE 将查询计划拆分成为 Fragment 下发到 BE 进行任务执行。BE 在
- Stream-Load
- > 关于 Stream-Load 使用的更多详细语法及最佳实践，请参阅 [Stream-Load](../../../sql-manual/sql-reference-v2/Data-Manipulation-Statements/Load/STREAM-LOAD.html) 命令手册。
+ > 关于 Stream-Load 使用的更多详细语法及最佳实践，请参阅 [Stream-Load](../sql-manual/sql-reference-v2/Data-Manipulation-Statements/Load/STREAM-LOAD.html) 命令手册。
流式导入通过 HTTP 协议向 Doris 传输数据，可以不依赖其他系统或组件直接导入本地数据。详细语法帮助可以参阅 `HELP STREAM LOAD;`。
@@ -509,7 +509,7 @@ FE 将查询计划拆分成为 Fragment 下发到 BE 进行任务执行。BE 在
Broker 导入通过部署的 Broker 进程，读取外部存储上的数据进行导入。
- > 关于 Broker Load 使用的更多详细语法及最佳实践，请参阅 [Broker Load](../../../sql-manual/sql-reference-v2/Data-Manipulation-Statements/Load/BROKER-LOAD.html) 命令手册，你也可以在 MySql 客户端命令行下输入 `HELP BROKER LOAD` 获取更多帮助信息。
+ > 关于 Broker Load 使用的更多详细语法及最佳实践，请参阅 [Broker Load](../sql-manual/sql-reference-v2/Data-Manipulation-Statements/Load/BROKER-LOAD.html) 命令手册，你也可以在 MySql 客户端命令行下输入 `HELP BROKER LOAD` 获取更多帮助信息。
示例：以 "table1_20170708" 为 Label，将 HDFS 上的文件导入 table1 表
@@ -601,7 +601,7 @@ FE 将查询计划拆分成为 Fragment 下发到 BE 进行任务执行。BE 在
#### 更新数据
-> 关于 Update 使用的更多详细语法及最佳实践，请参阅 [Update](../../../sql-manual/sql-reference-v2/Data-Manipulation-Statements/Manipulation/UPDATE.html) 命令手册。
+> 关于 Update 使用的更多详细语法及最佳实践，请参阅 [Update](../sql-manual/sql-reference-v2/Data-Manipulation-Statements/Manipulation/UPDATE.html) 命令手册。
当前 UPDATE 语句**仅支持**在 Unique 模型上的行更新，存在并发更新导致的数据冲突可能。 目前 Doris 并不处理这类问题，需要用户从业务侧规避这类问题。
@@ -634,56 +634,71 @@ FE 将查询计划拆分成为 Fragment 下发到 BE 进行任务执行。BE 在
1. 将 'test' 表中满足条件 k1 =1 , k2 =2 的 v1 列更新为 1
- ```text
+ ```sql
UPDATE test SET v1 = 1 WHERE k1=1 and k2=2;
```
2. 将 'test' 表中 k1=1 的列的 v1 列自增1
- ```text
+ ```sql
UPDATE test SET v1 = v1+1 WHERE k1=1;
```
#### 删除数据
-> 关于 Delete 使用的更多详细语法及最佳实践，请参阅 [Delete](../../../sql-manual/sql-reference-v2/Data-Manipulation-Statements/Manipulation/DELETE.html) 命令手册。
+> 关于 Delete 使用的更多详细语法及最佳实践，请参阅 [Delete](../sql-manual/sql-reference-v2/Data-Manipulation-Statements/Manipulation/DELETE.html) 命令手册。
1. 语法规则
- ```mysql
该语句用于按条件删除指定 table（base index） partition 中的数据。
+
该操作会同时删除和此 base index 相关的 rollup index 的数据。
语法：
- DELETE FROM table_name [PARTITION partition_name | PARTITIONS (p1, p2)]
- WHERE
- column_name1 op { value | value_list } [ AND column_name2 op { value | value_list } ...];
-
+
+ ```sql
+ DELETE FROM table_name [PARTITION partition_name | PARTITIONS (p1, p2)]
+ WHERE
+ column_name1 op { value | value_list } [ AND column_name2 op { value | value_list } ...];
+ ```
+
说明：
- 1) op 的可选类型包括：=, >, <, >=, <=, !=, in, not in
- 2) 只能指定 key 列上的条件。
- 2) 当选定的 key 列不存在于某个 rollup 中时，无法进行 delete。
- 3) 条件之间只能是“与”的关系。
- 若希望达成“或”的关系，需要将条件分写在两个 DELETE 语句中。
- 4) 如果为分区表，可以指定分区，如不指定，且会话变量 delete_without_partition 为 true，则会应用到所有分区。如果是单分区表，可以不指定。
-
+
+ - op 的可选类型包括：=, >, <, >=, <=, !=, in, not in
+
+ - 只能指定 key 列上的条件。
+
+ - 当选定的 key 列不存在于某个 rollup 中时，无法进行 delete。
+
+ - 条件之间只能是“与”的关系。
+
+ 若希望达成“或”的关系，需要将条件分写在两个 DELETE 语句中。
+
+ - 如果为分区表，可以指定分区，如不指定，且会话变量 delete_without_partition 为 true，则会应用到所有分区。如果是单分区表，可以不指定。
+
注意：
- 该语句可能会降低执行后一段时间内的查询效率。
- 影响程度取决于语句中指定的删除条件的数量。
- 指定的条件越多，影响越大。
- ```
+
+ - 该语句可能会降低执行后一段时间内的查询效率。
+ - 影响程度取决于语句中指定的删除条件的数量。
+ - 指定的条件越多，影响越大。
2. 示例
- ```mysql
1. 删除 my_table partition p1 中 k1 列值为 3 的数据行
- DELETE FROM my_table PARTITION p1
- WHERE k1 = 3;
-
+
+ ```sql
+ DELETE FROM my_table PARTITION p1 WHERE k1 = 3;
+ ```
+
2. 删除 my_table partition p1 中 k1 列值大于等于 3 且 k2 列值为 "abc" 的数据行
- DELETE FROM my_table PARTITION p1
- WHERE k1 >= 3 AND k2 = "abc";
+
+ ```sql
+ DELETE FROM my_table PARTITION p1 WHERE k1 >= 3 AND k2 = "abc";
+ ```
3. 删除 my_table partition p1, p2 中 k1 列值大于等于 3 且 k2 列值为 "abc" 的数据行
- DELETE FROM my_table PARTITIONS (p1, p2)
- WHERE k1 >= 3 AND k2 = "abc";
- ```
\ No newline at end of file
+
+ ```sql
+ DELETE FROM my_table PARTITIONS (p1, p2) WHERE k1 >= 3 AND k2 = "abc";
+ ```
+
+
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org