[Doc] fix links in 2.1 (#35226)

Signed-off-by: evelynzhaojie <[email protected]>
StarRocks · Nov 16, 2023 · af97a24 · af97a24
1 parent e98fa39
commit af97a24
Show file tree

Hide file tree

Showing 12 changed files with 303 additions and 18 deletions.
diff --git a/docs/en/loading/Loading_intro.md b/docs/en/loading/Loading_intro.md
@@ -13,7 +13,7 @@ Choose the import methods based on your data source.
 * Real-time data import. It is recommended to import log and binlog data to StarRocks via [Routine load](./RoutineLoad.md) after they are synchronized to Kafka. StarRocks has a standard [Flink-connector](./Flink-connector-starrocks.md) to facilitate the use of Flink jobs.
 * Write to StarRocks programmatically. It is recommended to use [Stream  Load](./StreamLoad.md).
 * Text file import. It is recommended to use `Stream  Load`.
-* Mysql data import. It is recommend to use [MySQL external table](../using_starrocks/External_table.md#MySQLExternalTables) to import (`insert into new_table select * from external_table`)
+* Mysql data import. It is recommend to use [MySQL external table](../using_starrocks/External_table.md#mysql-external-table) to import (`insert into new_table select * from external_table`)
 * Other data sources to import. It is recommended to use DataX import. StarRocks provides [DataX-StarRocks-writer](./DataX-starrocks-writer.md)
 *StarRocks internal import. It is recommended to use [insert into tablename select](./InsertInto.md) inside StarRocks, which can work with an external scheduler for simple ETL processing.
 

diff --git a/docs/zh/faq/Sql_faq.md b/docs/zh/faq/Sql_faq.md
@@ -160,7 +160,7 @@ MERGE:
 
 ## be/fe日志文件太多，怎么处理？
 
-调整日志级别和参数大小，详情参考文档中log相关的参数默认值和作用说明：[参数配置](/administration/Configuration.md)
+调整日志级别和参数大小，详情参考文档中log相关的参数默认值和作用说明：[参数配置](../administration/Configuration.md)
 
 ## 更改副本数失败：table lineorder is colocate table, cannot change replicationNum
 

diff --git a/docs/zh/quick_start/Create_table.md b/docs/zh/quick_start/Create_table.md
@@ -0,0 +1,248 @@
+# 创建表
+
+本文介绍如何在 StarRocks 中创建表以及进行相关操作。
+
+## 连接 StarRocks
+
+在成功 [部署 StarRocks 集群](../quick_start/Deploy.md) 后，您可以通过 MySQL 客户端连接任意一个 FE 节点的 `query_port`（默认为 `9030`）以连接 StarRocks。StarRocks 内置 `root` 用户，密码默认为空。
+
+```shell
+mysql -h <fe_host> -P9030 -u root
+```
+
+## 创建数据库
+
+创建 `example_db` 数据库。
+
+```sql
+CREATE DATABASE example_db;
+```
+
+您可以通过 `SHOW DATABASES;` 命令查看当前 StarRocks 集群中所有数据库。
+
+```Plain Text
+MySQL [(none)]> SHOW DATABASES;
+
++--------------------+
+| Database           |
++--------------------+
+| _statistics_       |
+| example_db         |
+| information_schema |
++--------------------+
+3 rows in set (0.00 sec)
+```
+
+> 说明：与 MySQL 的表结构类似，`information_schema` 包含当前 StarRocks 集群的元数据信息，但是部分统计信息还不完善。推荐您通过 `DESC table_name` 等命令来获取数据库元数据信息。
+
+## 创建表
+
+在新建的数据库中创建表。
+
+StarRocks 支持 [多种数据模型](../table_design/Data_model.md)，以适用不同的应用场景。以下示例基于 [明细表模型](../table_design/Data_model.md#明细模型) 编写建表语句。
+
+更多建表语法，参考 [CREATE TABLE](../sql-reference/sql-statements/data-definition/CREATE_TABLE.md) 。
+
+```sql
+use example_db;
+CREATE TABLE IF NOT EXISTS `detailDemo` (
+    `recruit_date`  DATE           NOT NULL COMMENT "YYYY-MM-DD",
+    `region_num`    TINYINT        COMMENT "range [-128, 127]",
+    `num_plate`     SMALLINT       COMMENT "range [-32768, 32767] ",
+    `tel`           INT            COMMENT "range [-2147483648, 2147483647]",
+    `id`            BIGINT         COMMENT "range [-2^63 + 1 ~ 2^63 - 1]",
+    `password`      LARGEINT       COMMENT "range [-2^127 + 1 ~ 2^127 - 1]",
+    `name`          CHAR(20)       NOT NULL COMMENT "range char(m),m in (1-255)",
+    `profile`       VARCHAR(500)   NOT NULL COMMENT "upper limit value 1048576 bytes",
+    `hobby`         STRING         NOT NULL COMMENT "upper limit value 65533 bytes",
+    `leave_time`    DATETIME       COMMENT "YYYY-MM-DD HH:MM:SS",
+    `channel`       FLOAT          COMMENT "4 bytes",
+    `income`        DOUBLE         COMMENT "8 bytes",
+    `account`       DECIMAL(12,4)  COMMENT "",
+    `ispass`        BOOLEAN        COMMENT "true/false"
+) ENGINE=OLAP
+DUPLICATE KEY(`recruit_date`, `region_num`)
+PARTITION BY RANGE(`recruit_date`)
+(
+    PARTITION p20220311 VALUES [('2022-03-11'), ('2022-03-12')),
+    PARTITION p20220312 VALUES [('2022-03-12'), ('2022-03-13')),
+    PARTITION p20220313 VALUES [('2022-03-13'), ('2022-03-14')),
+    PARTITION p20220314 VALUES [('2022-03-14'), ('2022-03-15')),
+    PARTITION p20220315 VALUES [('2022-03-15'), ('2022-03-16'))
+)
+DISTRIBUTED BY HASH(`recruit_date`, `region_num`);
+```
+
+> 注意
+>
+> * 在 StarRocks 中，字段名不区分大小写，表名区分大小写。
+
+### 建表语句说明
+
+#### 排序键
+
+StarRocks 表内部组织存储数据时会按照指定列排序，这些列为排序列（Sort Key）。明细模型中由 `DUPLICATE KEY` 指定排序列。以上示例中的 `recruit_date` 以及 `region_num` 两列为排序列。
+
+> 注意：排序列在建表时应定义在其他列之前。排序键详细描述以及不同数据模型的表的设置方法请参考 [排序键](../table_design/Sort_key.md)。
+
+#### 字段类型
+
+StarRocks 表中支持多种字段类型，除以上示例中已经列举的字段类型，还支持 [BITMAP 类型](../using_starrocks/Using_bitmap.md)，[HLL 类型](../using_starrocks/Using_HLL.md)，[ARRAY 类型](../using_starrocks/Array.md)，字段类型介绍详见 [数据类型章节](../sql-reference/sql-statements/data-types/BIGINT.md)。
+
+> 注意：在建表时，您应尽量使用精确的类型。例如，整型数据不应使用字符串类型，INT 类型即可满足的数据不应使用 BIGINT 类型。精确的数据类型能够更好的发挥数据库的性能。
+
+#### 分区分桶
+
+`PARTITION` 关键字用于给表 [创建分区](../sql-reference/sql-statements/data-definition/CREATE_TABLE.md)。
+
+`DISTRIBUTED` 关键字用于给表创建分桶，以上示例中使用 `recruit_date` 以及 `region_num` 两个字段作为分桶列。
+
+创建表时合理的分区和分桶设计可以优化表的查询性能。有关分区分桶列如何选择，详见 [数据分布](../table_design/Data_distribution.md)。
+
+#### 数据模型
+
+`DUPLICATE` 关键字表示当前表为明细模型，`KEY` 中的列表示当前表的排序列。StarRocks 支持多种数据模型，分别为 [明细模型](../table_design/Data_model.md#明细模型)，[聚合模型](../table_design/Data_model.md#聚合模型)，[更新模型](../table_design/Data_model.md#)，[主键模型](../table_design/Data_model.md#主键模型)。不同模型的适用于多种业务场景，合理选择可优化查询效率。
+
+#### 索引
+
+StarRocks 默认会给 Key 列创建稀疏索引加速查询，具体规则见 [排序键](../table_design/Sort_key.md)。支持的索引类型有 [Bitmap 索引](../using_starrocks/Bitmap_index.md) 等。
+
+> 注意：索引创建对表模型和列有要求，详细说明见对应索引介绍章节。
+
+#### ENGINE 类型
+
+默认 ENGINE 类型为 `olap`，对应 StarRocks 集群内部表。其他可选项包括 `mysql`，`elasticsearch`，`hive`，`jdbc`（2.3 及以后），`hudi`（2.2 及以后）以及 `iceberg`，分别代表所创建的表为相应类型的 [外部表](../data_source/External_table.md)。
+
+## 查看表信息
+
+您可以通过 SQL 命令查看表的相关信息。
+
+* 查看当前数据库中所有的表
+
+```sql
+SHOW TABLES;
+```
+
+* 查看表的结构
+
+```sql
+DESC table_name;
+```
+
+示例：
+
+```sql
+DESC detailDemo;
+```
+
+* 查看建表语句
+
+```sql
+SHOW CREATE TABLE table_name;
+```
+
+示例：
+
+```sql
+SHOW CREATE TABLE detailDemo;
+```
+
+<br/>
+
+## 修改表结构
+
+StarRocks 支持多种 DDL 操作。
+
+您可以通过 [ALTER TABLE](../sql-reference/sql-statements/data-definition/ALTER_TABLE.md) 命令可以修改表的 Schema，包括增加列，删除列，修改列类型（暂不支持修改列名称），改变列顺序。
+
+### 增加列
+
+例如，在以上创建的表中，在 `ispass` 列后新增一列 `uv`，类型为 BIGINT，默认值为 `0`。
+
+```sql
+ALTER TABLE detailDemo ADD COLUMN uv BIGINT DEFAULT '0' after ispass;
+```
+
+### 删除列
+
+删除以上步骤新增的列。
+
+> 注意
+>
+> 如果您通过上述步骤添加了 `uv`，请务必删除此列以保证后续 Quick Start 内容可以执行。
+
+```sql
+ALTER TABLE detailDemo DROP COLUMN uv;
+```
+
+### 查看修改表结构作业状态
+
+修改表结构为异步操作。提交成功后，您可以通过以下命令查看作业状态。
+
+```sql
+SHOW ALTER TABLE COLUMN\G;
+```
+
+当作业状态为 FINISHED，则表示作业完成，新的表结构修改已生效。
+
+修改 Schema 完成之后，您可以通过以下命令查看最新的表结构。
+
+```sql
+DESC table_name;
+```
+
+示例如下：
+
+```Plain Text
+MySQL [example_db]> desc detailDemo;
+
++--------------+-----------------+------+-------+---------+-------+
+| Field        | Type            | Null | Key   | Default | Extra |
++--------------+-----------------+------+-------+---------+-------+
+| recruit_date | DATE            | No   | true  | NULL    |       |
+| region_num   | TINYINT         | Yes  | true  | NULL    |       |
+| num_plate    | SMALLINT        | Yes  | false | NULL    |       |
+| tel          | INT             | Yes  | false | NULL    |       |
+| id           | BIGINT          | Yes  | false | NULL    |       |
+| password     | LARGEINT        | Yes  | false | NULL    |       |
+| name         | CHAR(20)        | No   | false | NULL    |       |
+| profile      | VARCHAR(500)    | No   | false | NULL    |       |
+| hobby        | VARCHAR(65533)  | No   | false | NULL    |       |
+| leave_time   | DATETIME        | Yes  | false | NULL    |       |
+| channel      | FLOAT           | Yes  | false | NULL    |       |
+| income       | DOUBLE          | Yes  | false | NULL    |       |
+| account      | DECIMAL64(12,4) | Yes  | false | NULL    |       |
+| ispass       | BOOLEAN         | Yes  | false | NULL    |       |
+| uv           | BIGINT          | Yes  | false | 0       |       |
++--------------+-----------------+------+-------+---------+-------+
+15 rows in set (0.00 sec)
+```
+
+### 取消修改表结构
+
+您可以通过以下命令取消当前正在执行的作业。
+
+```sql
+CANCEL ALTER TABLE COLUMN FROM table_name\G;
+```
+
+## 创建用户并授权
+
+`example_db` 数据库创建完成之后，您可以创建 `test` 用户，并授予其 `example_db` 的读写权限。
+
+```sql
+CREATE USER 'test' IDENTIFIED by '123456';
+GRANT ALL on example_db.* to test;
+```
+
+通过登录被授权的 `test` 账户，就可以操作 `example_db` 数据库。
+
+```bash
+mysql -h 127.0.0.1 -P9030 -utest -p123456
+```
+
+<br/>
+
+## 下一步
+
+表创建成功后，您可以 [导入并查询数据](../quick_start/Import_and_query.md)。
diff --git a/docs/zh/release_notes/release-1.19.md b/docs/zh/release_notes/release-1.19.md
@@ -7,9 +7,9 @@
 ### New Feature
 
 * 实现Global Runtime Filter，可以支持对shuffle join实现Runtime filter。
-* 默认开启CBO Planner，完善了colocated join / bucket shuffle / 统计信息等功能。[参考文档](/using_starrocks/Cost_based_optimizer.md)
-* [实验功能] 发布主键模型（Primary Key）：为更好地支持实时/频繁更新功能，StarRocks新增了一种表的类型: 主键模型。该模型支持Stream Load、Broker Load、Routine Load，同时提供了基于Flink-cdc的MySQL数据的秒级同步工具。[参考文档](/table_design/Data_model.md#主键模型)
-* [实验功能] 新增外表写入功能。支持将数据通过外表方式写入另一个StarRocks集群的表中，以解决读写分离需求，提供更好的资源隔离。[参考文档](/data_source/External_table.md)
+* 默认开启CBO Planner，完善了colocated join / bucket shuffle / 统计信息等功能。[参考文档](../using_starrocks/Cost_based_optimizer.md)
+* [实验功能] 发布主键模型（Primary Key）：为更好地支持实时/频繁更新功能，StarRocks新增了一种表的类型: 主键模型。该模型支持Stream Load、Broker Load、Routine Load，同时提供了基于Flink-cdc的MySQL数据的秒级同步工具。[参考文档](../table_design/Data_model.md#主键模型)
+* [实验功能] 新增外表写入功能。支持将数据通过外表方式写入另一个StarRocks集群的表中，以解决读写分离需求，提供更好的资源隔离。[参考文档](../data_source/External_table.md)
 
 ### Improvement
 
@@ -20,7 +20,7 @@
   * group by int 语句
   * or语句
 * 优化磁盘Balance算法，单机增加磁盘后可以自动进行数据均衡。
-* 支持部分列导出。 [参考文档](/unloading/Export.md)
+* 支持部分列导出。 [参考文档](../unloading/Export.md)
 * 优化show processlist，显示具体SQL。
 * SET_VAR支持多个变量设置。
 * 完善更多报错信息，包括table_sink、routine load、创建物化视图等。

diff --git a/docs/zh/release_notes/release-2.0.md b/docs/zh/release_notes/release-2.0.md
@@ -137,13 +137,13 @@ StarRocks支持使用Hive外表访问创建在Hive外表上的Amazon S3外表。
 ### 新功能
 
 - 外表
-  - [实验功能]支持S3上的Hive外表功能 [参考文档](/data_source/External_table.md#Hive外表)
+  - [实验功能]支持S3上的Hive外表功能 [参考文档](../data_source/External_table.md#hive外表)
   - DecimalV3支持外表查询 [#425](https://github.com/StarRocks/starrocks/pull/425)
 - 实现存储层复杂表达式下推计算，获得性能提升
 - Broker Load支持华为OBS [#1182](https://github.com/StarRocks/starrocks/pull/1182)
 - 支持国密算法sm3
 - 适配ARM类国产CPU：通过鲲鹏架构验证
-- 主键模型（Primary Key）正式发布，该模型支持Stream Load、Broker Load、Routine Load，同时提供了基于Flink-cdc的MySQL数据的秒级同步工具。[参考文档](/table_design/Data_model.md#主键模型)
+- 主键模型（Primary Key）正式发布，该模型支持Stream Load、Broker Load、Routine Load，同时提供了基于Flink-cdc的MySQL数据的秒级同步工具。[参考文档](../table_design/Data_model.md#主键模型)
 
 ### 功能优化
 

diff --git a/docs/zh/sql-reference/sql-functions/json-functions/json-operators.md b/docs/zh/sql-reference/sql-functions/json-functions/json-operators.md
@@ -0,0 +1,37 @@
+# JSON 运算符
+
+StarRocks 支持使用 `<`，`<=`，`>`，`>=`，`=`，`!=` 运算符查询 JSON 数据，不支持使用 `IN` 运算符。
+
+> - 运算符两边必须均为 JSON 类型的数据。
+> - 如果运算符一边是 JSON 类型的数据，另一边不是，则运算时会通过隐式类型转换，将不是 JSON 类型的数据转换为 JSON 类型的数据。
+## 运算规则
+
+JSON 运算符遵循以下规则：
+
+- 当运算符两边 JSON 数据的值属于相同的数据类型时
+  - 如果为基本的数据类型（数字类型、字符串类型、布尔类型)，则运算时，遵循基本类型的运算规则。
+
+   > 如果都是数值类型，但分别为 DOUBLE 和 INT 时，则会将 INT 转型成 DOUBLE 进行比较。
+
+  - 如果为复合数据类型（对象类型、数组类型 ），则运算时，按照元素逐个比较：按 key 的字典序排序，再逐个比较 key 对应的 value。
+
+    比如，对于 JSON 对象 `{"a": 1, "c": 2}` 和 `{"b": 1, "a": 2}`，按照运算符左侧 JSON 对象中键的字典序进行对比。对比节点 `a`，由于左边的值 `1` < 右边的值 `2` ，因此`{"a": 1, "c": 2}` < `{"b": 1, "a": 2}`。
+
+```Plain Text
+mysql> SELECT PARSE_JSON('{"a": 1, "c": 2}') < PARSE_JSON('{"b": 1, "a": 2} ');
+       -> 1
+```
+
+   对于 JSON 对象 `{"a": 1, "c": 2}` 和 `{"b": 1, "a": 1}`，按照运算符左侧 JSON 对象中键的字典序进行对比。首先对比节点 `a`， 左右的值均为 `1`。对比节点 `c`，由于右侧不存在该值，因此 `{"a": 1, "c": 2}` > `{"b": 1, "a": 1}`。
+
+```Plain Text
+mysql> SELECT PARSE_JSON('{"a": 1, "c": 2}') < PARSE_JSON('{"b": 1, "a": 1}');
+       -> 0
+```
+
+- 当运算符两边 JSON 数据的值为不同的数据类型时，运算时，按照类型排序，进行比较。目前类型排序为 NULL < BOOLEAN < ARRAY < OBJECT < DOUBLE < INT < STRING。
+
+```Plain Text
+mysql> SELECT PARSE_JSON('"a"') < PARSE_JSON('{"a": 1, "c": 2}');
+       -> 0
+```
diff --git a/docs/zh/sql-reference/sql-statements/data-definition/CREATE_RESOURCE.md b/docs/zh/sql-reference/sql-statements/data-definition/CREATE_RESOURCE.md
@@ -2,7 +2,7 @@
 
 ## description
 
-该语句用于创建资源。仅 root 或 admin 用户可以创建资源。目前仅支持 Spark 和 Hive 资源，可用于 [SPARK LOAD](/sql-reference/sql-statements/data-manipulation/SPARK_LOAD.md) 及 [Hive 外表](/data_source/External_table.md#hive外表) 功能。将来其他外部资源可能会加入到 StarRocks 中使用，如 Spark/GPU 用于查询，HDFS/S3 用于外部存储，MapReduce 用于 ETL 等。
+该语句用于创建资源。仅 root 或 admin 用户可以创建资源。目前仅支持 Spark 和 Hive 资源，可用于 [SPARK LOAD](../data-manipulation/SPARK_LOAD.md) 及 [Hive 外表](../../../data_source/External_table.md#hive外表) 功能。将来其他外部资源可能会加入到 StarRocks 中使用，如 Spark/GPU 用于查询，HDFS/S3 用于外部存储，MapReduce 用于 ETL 等。
 
 语法：
 

diff --git a/docs/zh/sql-reference/sql-statements/data-definition/CREATE_TABLE_AS_SELECT.md b/docs/zh/sql-reference/sql-statements/data-definition/CREATE_TABLE_AS_SELECT.md
@@ -25,9 +25,9 @@ AS SELECT query
 | ---------------- | ------------------------------------------------------------ |
 | column_name      | 列名。您无需传入列类型，StarRocks 会自动选择合适的类型，并将 FLOAT 或 DOUBLE 转换为 DECIMAL(38,9)，CHAR、VARCHAR、STRING 转换为 VARCHAR(65533)。 |
 | COMMENT          | 表注释。                                                     |
-| partition_desc   | 分区方式。更多说明，请参见 [partition_desc](./CREATE_TABLE.md#syntax)。如果不填写，则默认为无分区。 |
-| distribution_desc | 分桶方式。更多说明，请参见 [distribution_desc](./CREATE_TABLE.md#syntax)。如果不填写，则默认分桶键为CBO统计信息中最高基数的列，分桶数量为10。如果CBO中没有相关统计信息，则默认分桶键为第一列。 |
-| properties       | 新表的附带属性。更多说明，请参见 [PROPERTIES](./CREATE_TABLE.md#syntax)。目前CTA仅支持创建ENGINE类型为OLAP的表。 |
+| partition_desc   | 分区方式。更多说明，请参见 [partition_desc](./CREATE_TABLE.md#语法)。如果不填写，则默认为无分区。 |
+| distribution_desc | 分桶方式。更多说明，请参见 [distribution_desc](./CREATE_TABLE.md#语法)。如果不填写，则默认分桶键为CBO统计信息中最高基数的列，分桶数量为10。如果CBO中没有相关统计信息，则默认分桶键为第一列。 |
+| properties       | 新表的附带属性。更多说明，请参见 [PROPERTIES](./CREATE_TABLE.md#语法)。目前CTA仅支持创建ENGINE类型为OLAP的表。 |
 
 ### 查询部分
 

diff --git a/docs/zh/sql-reference/sql-statements/data-definition/RESTORE.md b/docs/zh/sql-reference/sql-statements/data-definition/RESTORE.md
@@ -2,7 +2,7 @@
 
 ## description
 
-将通过 [BACKUP](/sql-reference/sql-statements/data-definition/BACKUP.md) 命令备份的数据，恢复到指定数据库下。该命令为 **异步** 操作。提交成功后，需通过 `SHOW RESTORE;` 命令查看进度。当前，仅支持恢复 OLAP 类型表，且表的数据模型需为明细模型、聚合模型或更新模型，暂不支持恢复数据模型为主键模型的表。
+将通过 [BACKUP](./BACKUP.md) 命令备份的数据，恢复到指定数据库下。该命令为 **异步** 操作。提交成功后，需通过 `SHOW RESTORE;` 命令查看进度。当前，仅支持恢复 OLAP 类型表，且表的数据模型需为明细模型、聚合模型或更新模型，暂不支持恢复数据模型为主键模型的表。
 
 语法：
 

diff --git a/docs/zh/sql-reference/sql-statements/data-manipulation/SHOW_CREATE_VIEW.md b/docs/zh/sql-reference/sql-statements/data-manipulation/SHOW_CREATE_VIEW.md
@@ -72,4 +72,4 @@ SHOW CREATE VIEW example_db.example_view;
 
 ## 相关操作
 
-StarRocks 还支持创建物化视图，详细信息请参见[物化视图](/using_starrocks/Materialized_view.md)。
+StarRocks 还支持创建物化视图，详细信息请参见[物化视图](../../../using_starrocks/Materialized_view.md)。
Original file line number	Diff line number	Diff line change
Expand Up		@@ -72,4 +72,4 @@ SHOW CREATE VIEW example_db.example_view;

		## 相关操作

		StarRocks 还支持创建物化视图，详细信息请参见[物化视图](/using_starrocks/Materialized_view.md)。
		StarRocks 还支持创建物化视图，详细信息请参见[物化视图](../../../using_starrocks/Materialized_view.md)。