diff --git a/docs/documentation/cn/index.rst b/docs/documentation/cn/index.rst new file mode 100644 index 00000000000000..710c4df1cd102c --- /dev/null +++ b/docs/documentation/cn/index.rst @@ -0,0 +1,14 @@ +============= +中文 +============= + +.. toctree:: + + administrator-guide/index + community/index + extending-doris/index + getting-started/index + installing/index + internal/index + sql-reference/index + diff --git a/docs/documentation/en/administrator-guide/index.rst b/docs/documentation/en/administrator-guide/index.rst index cb0f29fa9aff83..167504209a02e9 100644 --- a/docs/documentation/en/administrator-guide/index.rst +++ b/docs/documentation/en/administrator-guide/index.rst @@ -1,6 +1,6 @@ -============= -操作手册 -============= +======================== +Administrator Guide +======================== .. toctree:: :hidden: diff --git a/docs/documentation/en/administrator-guide/load-data/index.rst b/docs/documentation/en/administrator-guide/load-data/index.rst index f4807d1df86b61..159b0d23156e3e 100644 --- a/docs/documentation/en/administrator-guide/load-data/index.rst +++ b/docs/documentation/en/administrator-guide/load-data/index.rst @@ -1,12 +1,12 @@ ============= -数据导入 +Load Data ============= .. toctree:: :maxdepth: 2 - load-manual.md - broker-load-manual.md - stream-load-manual.md - routine-load-manual.md - insert-into-manual.md + load-manual_EN.md + broker-load-manual_EN.md + stream-load-manual_EN.md + routine-load-manual_EN.md + insert-into-manual_EN.md diff --git a/docs/documentation/en/administrator-guide/operation/index.rst b/docs/documentation/en/administrator-guide/operation/index.rst index 978ac3d83f8503..b961f2bc1a0287 100644 --- a/docs/documentation/en/administrator-guide/operation/index.rst +++ b/docs/documentation/en/administrator-guide/operation/index.rst @@ -1,6 +1,6 @@ -============= -运维操作 -============= +========================== +Maintainence Operation +========================== .. toctree:: :maxdepth: 2 diff --git a/docs/documentation/en/administrator-guide/operation/metadata-operation_EN.md b/docs/documentation/en/administrator-guide/operation/metadata-operation_EN.md index 443a5cc475501b..7f30ae956d91d5 100644 --- a/docs/documentation/en/administrator-guide/operation/metadata-operation_EN.md +++ b/docs/documentation/en/administrator-guide/operation/metadata-operation_EN.md @@ -2,11 +2,11 @@ This document focuses on how to manage Doris metadata in a real production environment. It includes the proposed deployment of FE nodes, some commonly used operational methods, and common error resolution methods. -For the time being, read the [Doris metadata design document](../../internal/metadata-design.md) to understand how Doris metadata works. +For the time being, read the [Doris metadata design document](../../internal/metadata-design_EN.md) to understand how Doris metadata works. ## Important tips -* Current metadata design is not backward compatible. That is, if the new version has a new metadata structure change (you can see whether there is a new VERSION in the `FeMetaVersion. java'file in the FE code), it is usually impossible to roll back to the old version after upgrading to the new version. Therefore, before upgrading FE, be sure to test metadata compatibility according to the operations in the [Upgrade Document](../../installing/upgrade. md). +* Current metadata design is not backward compatible. That is, if the new version has a new metadata structure change (you can see whether there is a new VERSION in the `FeMetaVersion. java'file in the FE code), it is usually impossible to roll back to the old version after upgrading to the new version. Therefore, before upgrading FE, be sure to test metadata compatibility according to the operations in the [Upgrade Document](../../installing/upgrade_EN.md). ## Metadata catalog structure @@ -235,7 +235,7 @@ FE currently has the following ports ## Best Practices -The deployment recommendation of FE is described in the Installation and [Deployment Document](../../installing/install-deploy.md). Here are some supplements. +The deployment recommendation of FE is described in the Installation and [Deployment Document](../../installing/install-deploy_EN.md). Here are some supplements. * **If you don't know the operation logic of FE metadata very well, or you don't have enough experience in the operation and maintenance of FE metadata, we strongly recommend that only one FOLLOWER-type FE be deployed as MASTER in practice, and the other FEs are OBSERVER, which can reduce many complex operation and maintenance problems.** Don't worry too much about the failure of MASTER single point to write metadata. First, if you configure it properly, FE as a java process is very difficult to hang up. Secondly, if the MASTER disk is damaged (the probability is very low), we can also use the metadata on OBSERVER to recover manually through `fault recovery`. diff --git a/docs/documentation/en/community/index.rst b/docs/documentation/en/community/index.rst index 26ae323869baf2..5ff10aa4694a25 100644 --- a/docs/documentation/en/community/index.rst +++ b/docs/documentation/en/community/index.rst @@ -1,6 +1,6 @@ -=========== -Apache 社区 -=========== +=================== +Apache Commnity +=================== .. toctree:: :glob: diff --git a/docs/documentation/en/extending-doris/index.rst b/docs/documentation/en/extending-doris/index.rst index 4fda2a01dfaa58..282d12575930a9 100644 --- a/docs/documentation/en/extending-doris/index.rst +++ b/docs/documentation/en/extending-doris/index.rst @@ -1,6 +1,6 @@ -=========== -扩展功能 -=========== +==================== +Extending Ability +==================== .. toctree:: :glob: diff --git a/docs/documentation/en/getting-started/index.rst b/docs/documentation/en/getting-started/index.rst index dcb7cdb916ceb9..2ce4e86b7e649f 100644 --- a/docs/documentation/en/getting-started/index.rst +++ b/docs/documentation/en/getting-started/index.rst @@ -1,12 +1,12 @@ -============= -开始使用 -============= +==================== +Getting started +==================== .. toctree:: - basic-usage.md - advance-usage.md - best-practice.md - data-partition.md - data-model-rollup.md - hit-the-rollup.md + basic-usage_EN.md + advance-usage_EN.md + best-practice_EN.md + data-partition_EN.md + data-model-rollup_EN.md + hit-the-rollup_EN.md diff --git a/docs/documentation/en/index.rst b/docs/documentation/en/index.rst new file mode 100644 index 00000000000000..8de13bb56ab96a --- /dev/null +++ b/docs/documentation/en/index.rst @@ -0,0 +1,15 @@ +============= +Engilsh +============= + +.. toctree:: + :hidden: + + administrator-guide/index + community/index + extending-doris/index + getting-started/index + installing/index + internal/index + sql-reference/index + diff --git a/docs/documentation/en/installing/compilation.md b/docs/documentation/en/installing/compilation.md deleted file mode 100644 index 0ca91e865ec6ef..00000000000000 --- a/docs/documentation/en/installing/compilation.md +++ /dev/null @@ -1,77 +0,0 @@ -# 编译 - -本文档主要介绍如何通过源码编译 Doris。 - -## 使用 Docker 开发镜像编译（推荐） - -### 使用现成的镜像 - -1. 下载 Docker 镜像 - - `$ docker pull apachedoris/doris-dev:build-env` - - 检查镜像下载完成： - - ``` - $ docker images - REPOSITORY TAG IMAGE ID CREATED SIZE - apachedoris/doris-dev build-env f8bc5d4024e0 21 hours ago 3.28GB - ``` - -注: 针对不同的 Doris 版本，需要下载对应的镜像版本 - -| image version | commit id | release version | -|---|---|---| -| apachedoris/doris-dev:build-env | before [ff0dd0d](https://github.com/apache/incubator-doris/commit/ff0dd0d2daa588f18b6db56f947e813a56d8ec81) | 0.8.x, 0.9.x | -| apachedoris/doris-dev:build-env-1.1 | [ff0dd0d](https://github.com/apache/incubator-doris/commit/ff0dd0d2daa588f18b6db56f947e813a56d8ec81) or later | 0.10.x or later | - -2. 运行镜像 - - `$ docker run -it apachedoris/doris-dev:build-env` - - 如果你希望编译本地 Doris 源码，则可以挂载路径： - - ``` - $ docker run -it -v /your/local/incubator-doris-DORIS-x.x.x-release/:/root/incubator-doris-DORIS-x.x.x-release/ apachedoris/doris-dev:build-env - ``` - -3. 下载源码 - - 启动镜像后，你应该已经处于容器内。可以通过以下命令下载 Doris 源码（已挂载本地源码目录则不用）： - - ``` - $ wget https://dist.apache.org/repos/dist/dev/incubator/doris/xxx.tar.gz - or - $ git clone https://github.com/apache/incubator-doris.git - ``` - -4. 编译 Doris - - ``` - $ sh build.sh - ``` - - 编译完成后，产出文件在 `output/` 目录中。 - -### 自行编译开发环境镜像 - -你也可以自己创建一个 Doris 开发环境镜像，具体可参阅 `docker/README.md` 文件。 - - -## 直接编译（CentOS/Ubuntu） - -你可以在自己的 linux 环境中直接尝试编译 Doris。 - -1. 系统依赖 - - `GCC 5.3.1+, Oracle JDK 1.8+, Python 2.7+, Apache Maven 3.5+, CMake 3.4.3+` - - 安装完成后，自行设置环境变量 `PATH`, `JAVA_HOME` 等。 - -2. 编译 Doris - - ``` - $ sh build.sh - ``` - - 编译完成后，产出文件在 `output/` 目录中。 diff --git a/docs/documentation/en/installing/index.rst b/docs/documentation/en/installing/index.rst index 29e0e2f4a1d0d3..4fa1d6cdc10f33 100644 --- a/docs/documentation/en/installing/index.rst +++ b/docs/documentation/en/installing/index.rst @@ -1,9 +1,9 @@ -=========== -编译与部署 -=========== +=============================== +Compilation and deployment +=============================== .. toctree:: - compilation.md - install-deploy.md - upgrade.md + compilation_EN.md + install-deploy_EN.md + upgrade_EN.md diff --git a/docs/documentation/en/installing/install-deploy.md b/docs/documentation/en/installing/install-deploy.md deleted file mode 100644 index c284e388750833..00000000000000 --- a/docs/documentation/en/installing/install-deploy.md +++ /dev/null @@ -1,380 +0,0 @@ -# 安装与部署 - -该文档主要介绍了部署 Doris 所需软硬件环境、建议的部署方式、集群扩容缩容，以及集群搭建到运行过程中的常见问题。 -在阅读本文档前，请先根据编译文档编译 Doris。 - -## 软硬件需求 - -### 概述 - -Doris 作为一款开源的 MPP 架构 OLAP 数据库，能够运行在绝大多数主流的商用服务器上。为了能够充分运用 MPP 架构的并发优势，以及 Doris 的高可用特性，我们建议 Doris 的部署遵循以下需求： - -#### Linux 操作系统版本需求 - -| Linux 系统 | 版本 | -|---|---| -| CentOS | 7.1 及以上 | -| Ubuntu | 16.04 及以上 | - -#### 软件需求 - -| 软件 | 版本 | -|---|---| -| Java | 1.8 及以上 | -| GCC | 4.8.2 及以上 | - -#### 开发测试环境 - -| 模块 | CPU | 内存 | 磁盘 | 网络 | 实例数量 | -|---|---|---|---|---|---| -| Frontend | 8核+ | 8GB+ | SSD 或 SATA，10GB+ * | 千兆网卡 | 1 | -| Backend | 8核+ | 16GB+ | SSD 或 SATA，50GB+ * | 千兆网卡 | 1-3 * | - -#### 生产环境 - -| 模块 | CPU | 内存 | 磁盘 | 网络 | 实例数量（最低要求） | -|---|---|---|---|---|---| -| Frontend | 16核+ | 64GB+ | SSD 或 RAID 卡，100GB+ * | 万兆网卡 | 1-5 * | -| Backend | 16核+ | 64GB+ | SSD 或 SATA，100G+ * | 万兆网卡 | 10-100 * | - -> 注1： -> 1. FE 的磁盘空间主要用于存储元数据，包括日志和 image。通常从几百 MB 到几个 GB 不等。 -> 2. BE 的磁盘空间主要用于存放用户数据，总磁盘空间按用户总数据量 * 3（3副本）计算，然后再预留额外 40% 的空间用作后台 compaction 以及一些中间数据的存放。 -> 3. 一台机器上可以部署多个 BE 实例，但是**只能部署一个 FE**。如果需要 3 副本数据，那么至少需要 3 台机器各部署一个 BE 实例（而不是1台机器部署3个BE实例）。**多个FE所在服务器的时钟必须保持一致（允许最多5秒的时钟偏差）** -> 4. 测试环境也可以仅适用一个 BE 进行测试。实际生产环境，BE 实例数量直接决定了整体查询延迟。 -> 5. 所有部署节点关闭 Swap。 - -> 注2：FE 节点的数量 -> 1. FE 角色分为 Follower 和 Observer，（Leader 为 Follower 组中选举出来的一种角色，以下统称 Follower，具体含义见 [元数据设计文档](../internal/metadata-design)）。 -> 2. FE 节点数据至少为1（1 个 Follower）。当部署 1 个 Follower 和 1 个 Observer 时，可以实现读高可用。当部署 3 个 Follower 时，可以实现读写高可用（HA）。 -> 3. Follower 的数量**必须**为奇数，Observer 数量随意。 -> 4. 根据以往经验，当集群可用性要求很高是（比如提供在线业务），可以部署 3 个 Follower 和 1-3 个 Observer。如果是离线业务，建议部署 1 个 Follower 和 1-3 个 Observer。 - -* **通常我们建议 10 ~ 100 台左右的机器，来充分发挥 Doris 的性能（其中 3 台部署 FE（HA），剩余的部署 BE）** -* **当然，Doris的性能与节点数量及配置正相关。在最少4台机器（一台 FE，三台 BE，其中一台 BE 混部一个 Observer FE 提供元数据备份），以及较低配置的情况下，依然可以平稳的运行 Doris。** -* **如果 FE 和 BE 混部，需注意资源竞争问题，并保证元数据目录和数据目录分属不同磁盘。** - -#### Broker 部署 - -Broker 是用于访问外部数据源（如 hdfs）的进程。通常，在每台机器上部署一个 broker 实例即可。 - -#### 网络需求 - -Doris 各个实例直接通过网络进行通讯。以下表格展示了所有需要的端口 - -| 实例名称 | 端口名称 | 默认端口 | 通讯方向 | 说明 | -|---|---|---|---| ---| -| BE | be_port | 9060 | FE --> BE | BE 上 thrift server 的端口，用于接收来自 FE 的请求 | -| BE | be\_rpc_port | 9070 | BE <--> BE | BE 之间 rpc 使用的端口 | -| BE | webserver_port | 8040 | BE <--> BE | BE 上的 http server 的端口 | -| BE | heartbeat\_service_port | 9050 | FE --> BE | BE 上心跳服务端口（thrift），用户接收来自 FE 的心跳 | -| BE | brpc\_port* | 8060 | FE<-->BE, BE <--> BE | BE 上的 brpc 端口，用于 BE 之间通讯 | -| FE | http_port * | 8030 | FE <--> FE，用户 |FE 上的 http server 端口 | -| FE | rpc_port | 9020 | BE --> FE, FE <--> FE | FE 上的 thrift server 端口 | -| FE | query_port | 9030 | 用户 | FE 上的 mysql server 端口 | -| FE | edit\_log_port | 9010 | FE <--> FE | FE 上的 bdbje 之间通信用的端口 | -| Broker | broker\_ipc_port | 8000 | FE --> Broker, BE --> Broker | Broker 上的 thrift server，用于接收请求 | - -> 注： -> 1. 当部署多个 FE 实例时，要保证 FE 的 http\_port 配置相同。 -> 2. 部署前请确保各个端口在应有方向上的访问权限。 -> 3. brpc\_port 在 0.8.2 版本后替代了 be\_rpc_port - -#### IP 绑定 - -因为有多网卡的存在，或因为安装过 docker 等环境导致的虚拟网卡的存在，同一个主机可能存在多个不同的 ip。当前 Doris 并不能自动识别可用 IP。所以当遇到部署主机上有多个 IP 时，必须通过 priority\_networks 配置项来强制指定正确的 IP。 - -priority\_networks 是 FE 和 BE 都有的一个配置，配置项需写在 fe.conf 和 be.conf 中。该配置项用于在 FE 或 BE 启动时，告诉进程应该绑定哪个IP。示例如下： - -`priority_networks=10.1.3.0/24` - -这是一种 [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) 的表示方法。FE 或 BE 会根据这个配置项来寻找匹配的IP，作为自己的 localIP。 - -**注意**：当配置完 priority\_networks 并启动 FE 或 BE 后，只是保证了 FE 或 BE 自身的 IP 进行了正确的绑定。而在使用 ADD BACKEND 或 ADD FRONTEND 语句中，也需要指定和 priority\_networks 配置匹配的 IP，否则集群无法建立。举例： - -BE 的配置为：`priority_networks=10.1.3.0/24` - -但是在 ADD BACKEND 时使用的是：`ALTER SYSTEM ADD BACKEND "192.168.0.1:9050";` - -则 FE 和 BE 将无法正常通信。 - -这时，必须 DROP 掉这个添加错误的 BE，重新使用正确的 IP 执行 ADD BACKEND。 - -FE 同理。 - -BROKER 当前没有，也不需要 priority\_networks 这个选项。Broker 的服务默认绑定在 0.0.0.0 上。只需在 ADD BROKER 时，执行正确可访问的 BROKER IP 即可。 - -## 集群部署 - -### 手动部署 - -#### FE 部署 - -* 拷贝 FE 部署文件到指定节点 - - 将源码编译生成的 output 下的 fe 文件夹拷贝到 FE 的节点指定部署路径下。 - -* 配置 FE - - 1. 配置文件为 conf/fe.conf。其中注意：`meta_dir`：元数据存放位置。默认在 fe/palo-meta/ 下。需**手动创建**该目录。 - 2. fe.conf 中 JAVA_OPTS 默认 java 最大堆内存为 2GB，建议生产环境调整至 8G 以上。 - -* 启动FE - - `sh bin/start_fe.sh --daemon` - - FE进程启动进入后台执行。日志默认存放在 fe/log/ 目录下。如启动失败，可以通过查看 fe/log/fe.log 或者 fe/log/fe.out 查看错误信息。 - -* 如需部署多 FE，请参见 "FE 扩容和缩容" 章节 - -#### BE 部署 - -* 拷贝 BE 部署文件到所有要部署 BE 的节点 - - 将源码编译生成的 output 下的 be 文件夹拷贝到 BE 的节点的指定部署路径下。 - -* 修改所有 BE 的配置 - - 修改 be/conf/be.conf。主要是配置 `storage_root_path`：数据存放目录，使用 `;` 分隔（最后一个目录后不要加 `;`），其它可以采用默认值。 - -* 在 FE 中添加所有 BE 节点 - - BE 节点需要先在 FE 中添加，才可加入集群。可以使用 mysql-client 连接到 FE： - - `./mysql-client -h host -P port -uroot` - - 其中 host 为 FE 所在节点 ip；port 为 fe/conf/fe.conf 中的 query_port；默认使用 root 账户，无密码登录。 - - 登录后，执行以下命令来添加每一个 BE： - - `ALTER SYSTEM ADD BACKEND "host:port";` - - 如果使用多租户功能，则执行以下命令添加 BE: - - `ALTER SYSTEM ADD FREE BACKEND "host:port";` - - 其中 host 为 BE 所在节点 ip；port 为 be/conf/be.conf 中的 heartbeat_service_port。 - - 如果不添加 FREE 关键字，BE 默认进入自动生成的 cluster，添加了 FREE 关键字后新的 BE 不属于任何 cluster，这样创建新 cluster 的时候就可以从这些空闲的be中选取，详细见[多租户设计文档](../administrator-guide/operation/multi-tenant.md) - -* 启动 BE - - `sh bin/start_be.sh --daemon` - - BE 进程将启动并进入后台执行。日志默认存放在 be/log/ 目录下。如启动失败，可以通过查看 be/log/be.log 或者 be/log/be.out 查看错误信息。 - -* 查看BE状态 - - 使用 mysql-client 连接到 FE，并执行 `SHOW PROC '/backends';` 查看 BE 运行情况。如一切正常，`isAlive` 列应为 `true`。 - -#### （可选）FS_Broker 部署 - -Broker 以插件的形式，独立于 Doris 部署。如果需要从第三方存储系统导入数据，需要部署相应的 Broker，默认提供了读取 HDFS 和百度云 BOS 的 fs_broker。fs_broker 是无状态的，建议每一个 FE 和 BE 节点都部署一个 Broker。 - -* 拷贝源码 fs_broker 的 output 目录下的相应 Broker 目录到需要部署的所有节点上。建议和 BE 或者 FE 目录保持同级。 - -* 修改相应 Broker 配置 - - 在相应 broker/conf/ 目录下对应的配置文件中，可以修改相应配置。 - - * 启动 Broker - - `sh bin/start_broker.sh --daemon` 启动 Broker。 - -* 添加 Broker - - 要让 Doris 的 FE 和 BE 知道 Broker 在哪些节点上，通过 sql 命令添加 Broker 节点列表。 - - 使用 mysql-client 连接启动的 FE，执行以下命令： - - `ALTER SYSTEM ADD BROKER broker_name "host1:port1","host2:port2",...;` - - 其中 host 为 Broker 所在节点 ip；port 为 Broker 配置文件中的 broker\_ipc\_port。 - -* 查看 Broker 状态 - - 使用 mysql-client 连接任一已启动的 FE，执行以下命令查看 Broker 状态：`SHOW PROC "/brokers";` - -**注：在生产环境中，所有实例都应使用守护进程启动，以保证进程退出后，会被自动拉起，如 [Supervisor](http://supervisord.org/)。如需使用守护进程启动，在 0.9.0 及之前版本中，需要修改各个 start_xx.sh 脚本，去掉最后的 & 符号**。从 0.10.0 版本开始，直接调用 `sh start_xx.sh` 启动即可。也可参考 [这里](https://www.cnblogs.com/lenmom/p/9973401.html) - -## 扩容缩容 - -Doris 可以很方便的扩容和缩容 FE、BE、Broker 实例。 - -### FE 扩容和缩容 - -可以通过将 FE 扩容至 3 个一上节点来实现 FE 的高可用。 - -用户可以通过 mysql 客户端登陆 Master FE。通过: - -`SHOW PROC '/frontends';` - -来查看当前 FE 的节点情况。 - -也可以通过前端页面连接：```http://fe_hostname:fe_http_port/frontend``` 或者 ```http://fe_hostname:fe_http_port/system?path=//frontends``` 来查看 FE 节点的情况。 - -以上方式，都需要 Doris 的 root 用户权限。 - -FE 节点的扩容和缩容过程，不影响当前系统运行。 - -#### 增加 FE 节点 - -FE 分为 Leader，Follower 和 Observer 三种角色。 默认一个集群，只能有一个 Leader，可以有多个 Follower 和 Observer。其中 Leader 和 Follower 组成一个 Paxos 选择组，如果 Leader 宕机，则剩下的 Follower 会自动选出新的 Leader，保证写入高可用。Observer 同步 Leader 的数据，但是不参加选举。如果只部署一个 FE，则 FE 默认就是 Leader。 - -第一个启动的 FE 自动成为 Leader。在此基础上，可以添加若干 Follower 和 Observer。 - -添加 Follower 或 Observer。使用 mysql-client 连接到已启动的 FE，并执行： - -`ALTER SYSTEM ADD FOLLOWER "host:port";` - -或 - -`ALTER SYSTEM ADD OBSERVER "host:port";` - -其中 host 为 Follower 或 Observer 所在节点 ip，port 为其配置文件 fe.conf 中的 edit\_log\_port。 - -配置及启动 Follower 或 Observer。Follower 和 Observer 的配置同 Leader 的配置。第一次启动时，需执行以下命令： - -`./bin/start_fe.sh --helper host:port --daemon` - -查看 Follower 或 Observer 运行状态。使用 mysql-client 连接到任一已启动的 FE，并执行：SHOW PROC '/frontends'; 可以查看当前已加入集群的 FE 及其对应角色。 - -> FE 扩容注意事项： -> 1. Follower FE（包括 Leader）的数量必须为奇数，建议最多部署 3 个组成高可用（HA）模式即可。 -> 2. 当 FE 处于高可用部署时（1个 Leader，2个 Follower），我们建议通过增加 Observer FE 来扩展 FE 的读服务能力。当然也可以继续增加 Follower FE，但几乎是不必要的。 -> 3. 通常一个 FE 节点可以应对 10-20 台 BE 节点。建议总的 FE 节点数量在 10 个以下。而通常 3 个即可满足绝大部分需求。 - -#### 删除 FE 节点 - -使用以下命令删除对应的 FE 节点： - -```ALTER SYSTEM DROP FOLLOWER[OBSERVER] "fe_host:edit_log_port";``` - -> FE 缩容注意事项： -> 1. 删除 Follower FE 时，确保最终剩余的 Follower（包括 Leader）节点为奇数。 - -### BE 扩容和缩容 - -用户可以通过 mysql-client 登陆 Leader FE。通过: - -```SHOW PROC '/backends';``` - -来查看当前 BE 的节点情况。 - -也可以通过前端页面连接：```http://fe_hostname:fe_http_port/backend``` 或者 ```http://fe_hostname:fe_http_port/system?path=//backends``` 来查看 BE 节点的情况。 - -以上方式，都需要 Doris 的 root 用户权限。 - -BE 节点的扩容和缩容过程，不影响当前系统运行以及正在执行的任务，并且不会影响当前系统的性能。数据均衡会自动进行。根据集群现有数据量的大小，集群会在几个小时到1天不等的时间内，恢复到负载均衡的状态。集群负载情况，可以参见 [Tablet 负载均衡文档](../administrator-guide/operation/tablet-repair-and-balance.md)。 - -#### 增加 BE 节点 - -BE 节点的增加方式同 **BE 部署** 一节中的方式，通过 `ALTER SYSTEM ADD BACKEND` 命令增加 BE 节点。 - -> BE 扩容注意事项： -> 1. BE 扩容后，Doris 会自动根据负载情况，进行数据均衡，期间不影响使用。 - -#### 删除 BE 节点 - -删除 BE 节点有两种方式：DROP 和 DECOMMISSION - -DROP 语句如下： - -```ALTER SYSTEM DROP BACKEND "be_host:be_heartbeat_service_port";``` - -**注意：DROP BACKEND 会直接删除该 BE，并且其上的数据将不能再恢复！！！所以我们强烈不推荐使用 DROP BACKEND 这种方式删除 BE 节点。当你使用这个语句时，会有对应的防误操作提示。** - -DECOMMISSION 语句如下： - -```ALTER SYSTEM DECOMMISSION BACKEND "be_host:be_heartbeat_service_port";``` - -> DECOMMISSION 命令说明： -> 1. 该命令用于安全删除 BE 节点。命令下发后，Doris 会尝试将该 BE 上的数据向其他 BE 节点迁移，当所有数据都迁移完成后，Doris 会自动删除该节点。 -> 2. 该命令是一个异步操作。执行后，可以通过 ```SHOW PROC '/backends';``` 看到该 BE 节点的 isDecommission 状态为 true。表示该节点正在进行下线。 -> 3. 该命令**不一定执行成功**。比如剩余 BE 存储空间不足以容纳下线 BE 上的数据，或者剩余机器数量不满足最小副本数时，该命令都无法完成，并且 BE 会一直处于 isDecommission 为 true 的状态。 -> 4. DECOMMISSION 的进度，可以通过 ```SHOW PROC '/backends';``` 中的 TabletNum 查看，如果正在进行，TabletNum 将不断减少。 -> 5. 该操作可以通过: -> ```CANCEL ALTER SYSTEM DECOMMISSION BACKEND "be_host:be_heartbeat_service_port";``` -> 命令取消。取消后，该 BE 上的数据将维持当前剩余的数据量。后续 Doris 重新进行负载均衡 - -**对于多租户部署环境下，BE 节点的扩容和缩容，请参阅 [多租户设计文档](../administrator-guide/operation/multi-tenant.md)。** - -### Broker 扩容缩容 - -Broker 实例的数量没有硬性要求。通常每台物理机部署一个即可。Broker 的添加和删除可以通过以下命令完成： - -```ALTER SYSTEM ADD BROKER broker_name "broker_host:broker_ipc_port";``` -```ALTER SYSTEM DROP BROKER broker_name "broker_host:broker_ipc_port";``` -```ALTER SYSTEM DROP ALL BROKER broker_name;``` - -Broker 是无状态的进程，可以随意启停。当然，停止后，正在其上运行的作业会失败，重试即可。 - -## 常见问题 - -### 进程相关 - -1. 如何确定 FE 进程启动成功 - - FE 进程启动后，会首先加载元数据，根据 FE 角色的不同，在日志中会看到 ```transfer from UNKNOWN to MASTER/FOLLOWER/OBSERVER```。最终会看到 ```thrift server started``` 日志，并且可以通过 mysql 客户端连接到 FE，则表示 FE 启动成功。 - - 也可以通过如下连接查看是否启动成功： - `http://fe_host:fe_http_port/api/bootstrap` - - 如果返回： - `{"status":"OK","msg":"Success"}` - - 则表示启动成功，其余情况，则可能存在问题。 - - > 注：如果在 fe.log 中查看不到启动失败的信息，也许在 fe.out 中可以看到。 - -2. 如何确定 BE 进程启动成功 - - BE 进程启动后，如果之前有数据，则可能有数分钟不等的数据索引加载时间。 - - 如果是 BE 的第一次启动，或者该 BE 尚未加入任何集群，则 BE 日志会定期滚动 ```waiting to receive first heartbeat from frontend``` 字样。表示 BE 还未通过 FE 的心跳收到 Master 的地址，正在被动等待。这种错误日志，在 FE 中 ADD BACKEND 并发送心跳后，就会消失。如果在接到心跳后，又重复出现 ``````master client, get client from cache failed.host: , port: 0, code: 7`````` 字样，说明 FE 成功连接了 BE，但 BE 无法主动连接 FE。可能需要检查 BE 到 FE 的 rpc_port 的连通性。 - - 如果 BE 已经被加入集群，日志中应该每隔 5 秒滚动来自 FE 的心跳日志：```get heartbeat, host: xx.xx.xx.xx, port: 9020, cluster id: xxxxxx```，表示心跳正常。 - - 其次，日志中应该每隔 10 秒滚动 ```finish report task success. return code: 0``` 的字样，表示 BE 向 FE 的通信正常。 - - 同时，如果有数据查询，应该能看到不停滚动的日志，并且有 ```execute time is xxx``` 日志，表示 BE 启动成功，并且查询正常。 - - 也可以通过如下连接查看是否启动成功： - `http://be_host:be_http_port/api/health` - - 如果返回： - `{"status": "OK","msg": "To Be Added"}` - - 则表示启动成功，其余情况，则可能存在问题。 - - > 注：如果在 be.INFO 中查看不到启动失败的信息，也许在 be.out 中可以看到。 - -3. 搭建系统后，如何确定 FE、BE 连通性正常 - - 首先确认 FE 和 BE 进程都已经单独正常启动，并确认已经通过 `ADD BACKEND` 或者 `ADD FOLLOWER/OBSERVER` 语句添加了所有节点。 - - 如果心跳正常，BE 的日志中会显示 ```get heartbeat, host: xx.xx.xx.xx, port: 9020, cluster id: xxxxxx```。如果心跳失败，在 FE 的日志中会出现 ```backend[10001] got Exception: org.apache.thrift.transport.TTransportException``` 类似的字样，或者其他 thrift 通信异常日志，表示 FE 向 10001 这个 BE 的心跳失败。这里需要检查 FE 向 BE host 的心跳端口的连通性。 - - 如果 BE 向 FE 的通信正常，则 BE 日志中会显示 ```finish report task success. return code: 0``` 的字样。否则会出现 ```master client, get client from cache failed``` 的字样。这种情况下，需要检查 BE 向 FE 的 rpc_port 的连通性。 - -4. Doris 各节点认证机制 - - 除了 Master FE 以外，其余角色节点（Follower FE，Observer FE，Backend），都需要通过 `ALTER SYSTEM ADD` 语句先注册到集群，然后才能加入集群。 - - Master FE 在第一次启动时，会在 palo-meta/image/VERSION 文件中生成一个 cluster_id。 - - FE 在第一次加入集群时，会首先从 Master FE 获取这个文件。之后每次 FE 之间的重新连接（FE 重启），都会校验自身 cluster id 是否与已存在的其它 FE 的 cluster id 相同。如果不同，则该 FE 会自动退出。 - - BE 在第一次接收到 Master FE 的心跳时，会从心跳中获取到 cluster id，并记录到数据目录的 `cluster_id` 文件中。之后的每次心跳都会比对 FE 发来的 cluster id。如果 cluster id 不相等，则 BE 会拒绝响应 FE 的心跳。 - - 心跳中同时会包含 Master FE 的 ip。当 FE 切主时，新的 Master FE 会携带自身的 ip 发送心跳给 BE，BE 会更新自身保存的 Master FE 的 ip。 - - > **priority\_network** - > - > priority\_network 是 FE 和 BE 都有一个配置，其主要目的是在多网卡的情况下，协助 FE 或 BE 识别自身 ip 地址。priority\_network 采用 CIDR 表示法：[RFC 4632](https://tools.ietf.org/html/rfc4632) - > - > 当确认 FE 和 BE 连通性正常后，如果仍然出现建表 Timeout 的情况，并且 FE 的日志中有 `backend does not found. host: xxx.xxx.xxx.xxx` 字样的错误信息。则表示 Doris 自动识别的 IP 地址有问题，需要手动设置 priority\_network 参数。 - > - > 出现这个问题的主要原因是：当用户通过 `ADD BACKEND` 语句添加 BE 后，FE 会识别该语句中指定的是 hostname 还是 IP。如果是 hostname，则 FE 会自动将其转换为 IP 地址并存储到元数据中。当 BE 在汇报任务完成信息时，会携带自己的 IP 地址。而如果 FE 发现 BE 汇报的 IP 地址和元数据中不一致时，就会出现如上错误。 - > - > 这个错误的解决方法：1）分别在 FE 和 BE 设置 **priority\_network** 参数。通常 FE 和 BE 都处于一个网段，所以该参数设置为相同即可。2）在 `ADD BACKEND` 语句中直接填写 BE 正确的 IP 地址而不是 hostname，以避免 FE 获取到错误的 IP 地址。 diff --git a/docs/documentation/en/installing/upgrade.md b/docs/documentation/en/installing/upgrade.md deleted file mode 100644 index 44456c11e1a699..00000000000000 --- a/docs/documentation/en/installing/upgrade.md +++ /dev/null @@ -1,37 +0,0 @@ -# 集群升级 - -Doris 可以通过滚动升级的方式，平滑进行升级。建议按照以下步骤进行安全升级。 - -> 注： -> 1. 以下方式均建立在高可用部署的情况下。即数据 3 副本，FE 高可用情况下。 - -## 测试 BE 升级正确性 - -1. 任意选择一个 BE 节点，部署最新的 palo_be 二进制文件。 -2. 重启 BE 节点，通过 BE 日志 be.INFO，查看是否启动成功。 -3. 如果启动失败，可以先排查原因。如果错误不可恢复，可以直接通过 DROP BACKEND 删除该 BE、清理数据后，使用上一个版本的 palo_be 重新启动 BE。然后重新 ADD BACKEND。（**该方法会导致丢失一个数据副本，请务必确保3副本完整的情况下，执行这个操作！！！**） - -## 测试 FE 元数据兼容性 - -0. **重要！!元数据兼容性异常很可能导致数据无法恢复！！** -1. 单独使用新版本部署一个测试用的 FE 进程（比如自己本地的开发机）。 -2. 修改测试用的 FE 的配置文件 fe.conf，将所有端口设置为**与线上不同**。 -3. 在 fe.conf 添加配置：cluster_id=123456 -4. 在 fe.conf 添加配置：metadata\_failure_recovery=true -5. 拷贝线上环境 Master FE 的元数据目录 palo-meta 到测试环境 -6. 将拷贝到测试环境中的 palo-meta/image/VERSION 文件中的 cluster_id 修改为 123456（即与第3步中相同） -7. 在测试环境中，运行 sh bin/start_fe.sh 启动 FE -8. 通过 FE 日志 fe.log 观察是否启动成功。 -9. 如果启动成功，运行 sh bin/stop_fe.sh 停止测试环境的 FE 进程。 -10. **以上 2-6 步的目的是防止测试环境的FE启动后，错误连接到线上环境中。** - -## 升级准备 - -1. 在完成数据正确性验证后，将 BE 和 FE 新版本的二进制文件分发到各自目录下。 -2. 通常小版本升级，BE 只需升级 palo_be；而 FE 只需升级 palo-fe.jar。如果是大版本升级，则可能需要升级其他文件（包括但不限于 bin/ lib/ 等等）如果你不清楚是否需要替换其他文件，建议全部替换。 - -## 滚动升级 - -1. 确认新版本的文件部署完成后。逐台重启 FE 和 BE 实例即可。 -2. 建议逐台重启 BE 后，再逐台重启 FE。因为通常 Doris 保证 FE 到 BE 的向后兼容性，即老版本的 FE 可以访问新版本的 BE。但可能不支持老版本的 BE 访问新版本的 FE。 -3. 建议确认前一个实例启动成功后，在重启下一个实例。实例启动成功的标识，请参阅安装部署文档。 diff --git a/docs/documentation/en/internal/index.rst b/docs/documentation/en/internal/index.rst index 2d2aee33b2665d..ef52e59aee3447 100644 --- a/docs/documentation/en/internal/index.rst +++ b/docs/documentation/en/internal/index.rst @@ -1,6 +1,6 @@ -=========== -设计文档 -=========== +==================== +Design Documents +==================== .. toctree:: :glob: diff --git a/docs/documentation/en/sql-reference/index.rst b/docs/documentation/en/sql-reference/index.rst index c30bebbc01c5f0..f00ee956159488 100644 --- a/docs/documentation/en/sql-reference/index.rst +++ b/docs/documentation/en/sql-reference/index.rst @@ -1,6 +1,6 @@ -=========== -SQL 手册 -=========== +============= +SQL Manual +============= .. toctree:: :hidden: diff --git a/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/avg_EN.md b/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/avg_EN.md index 26e0aec307b900..6b48fc56a734f7 100644 --- a/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/avg_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/avg_EN.md @@ -1,6 +1,6 @@ -'35; AVG -Description -'35;'35;' 35; Syntax +#AVG +## Description +### Syntax `AVG([DISTINCT] expr)` @@ -9,7 +9,7 @@ Used to return the average value of the selected field Optional field DISTINCT parameters can be used to return the weighted average -'35;'35; example +## example ``` mysql> SELECT datetime, AVG(cost_time) FROM log_statis group by datetime; diff --git a/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/count_EN.md b/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/count_EN.md index 95681930ebe7f1..168bdc356966a2 100644 --- a/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/count_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/count_EN.md @@ -1,13 +1,13 @@ # COUNT -Description -'35;'35;' 35; Syntax +## Description +### Syntax `COUNT([DISTINCT] expr)` Number of rows used to return the required rows -'35;'35; example +## example ``` MySQL > select count(*) from log_statis group by datetime; diff --git a/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/count_distinct_EN.md b/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/count_distinct_EN.md index fe761721a4d60e..95c2d1dca7fbed 100644 --- a/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/count_distinct_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/count_distinct_EN.md @@ -1,13 +1,13 @@ # COUNT_DISTINCT -Description -'35;'35;' 35; Syntax +## Description +### Syntax `COUNT_DISTINCT(expr)` The number of rows used to return the required number, or the number of non-NULL rows -'35;'35; example +## example ``` MySQL > select count_distinct(query_id) from log_statis group by datetime; diff --git a/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/hll_union_agg_EN.md b/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/hll_union_agg_EN.md index aac0b31364a66b..0586664b2cea3d 100644 --- a/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/hll_union_agg_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/hll_union_agg_EN.md @@ -1,8 +1,8 @@ -THE EUROPEAN UNION -Description -'35;'35;' 35; Syntax +# HLL_UNION_AGG +## description +### Syntax -'HLL UNION'u AGG (hll)' +`HLL_UNION_AGG(hll)` HLL is an engineering implementation based on HyperLog algorithm, which is used to save the intermediate results of HyperLog calculation process. @@ -13,7 +13,7 @@ Based on this, we get an estimate with an error of about 1%. The HLL column is g When importing, hll_hash function is used to specify which column in data is used to generate HLL column. It is often used to replace count distinct, and to calculate UV quickly in business by combining rollup. -'35;'35; example +## example ``` MySQL > select HLL_UNION_AGG(uv_set) from test_uv;; +-------------------------+ diff --git a/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/index.rst b/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/index.rst index 10a1dceb92d1d7..9cab40ca9f4885 100644 --- a/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/index.rst +++ b/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/index.rst @@ -1,6 +1,6 @@ -============= -聚合函数 -============= +======================== +Aggregate Functions +======================== .. toctree:: :glob: diff --git a/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/max_EN.md b/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/max_EN.md index c26638790e5447..41b8cbcca98059 100644 --- a/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/max_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/max_EN.md @@ -1,13 +1,13 @@ # MAX -Description -'35;'35;' 35; Syntax +## description +### Syntax -'MAX (expr) +`MAX(expr)` Returns the maximum value of an expr expression -'35;'35; example +## example ``` MySQL > select max(scan_rows) from log_statis group by datetime; +------------------+ diff --git a/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/min_EN.md b/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/min_EN.md index 497162ee895d24..f8c61955fd34d2 100644 --- a/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/min_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/min_EN.md @@ -1,13 +1,13 @@ # MIN -Description -'35;'35;' 35; Syntax +## Description +### Syntax `MIN(expr)` Returns the minimum value of an expr expression -'35;'35; example +## example ``` MySQL > select min(scan_rows) from log_statis group by datetime; +------------------+ diff --git a/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/ndv_EN.md b/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/ndv_EN.md index 724023d2609435..e7c1f3932be4fb 100644 --- a/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/ndv_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/ndv_EN.md @@ -1,15 +1,15 @@ -'35; NDV -Description -'35;'35;' 35; Syntax +# NDV +## Description +### Syntax -'NDV (expr)' +`NDV (expr)` Returns an approximate aggregation function similar to the result of COUNT (DISTINCT col). It combines COUNT and DISTINCT faster and uses fixed-size memory, so less memory can be used for columns with high cardinality. -'35;'35; example +## example ``` MySQL > select ndv(query_id) from log_statis group by datetime; +-----------------+ diff --git a/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/percentile_approx_EN.md b/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/percentile_approx_EN.md index da666749fd5666..e8bec54d3900e8 100644 --- a/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/percentile_approx_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/percentile_approx_EN.md @@ -1,6 +1,6 @@ # PERCENTILE_APPROX -Description -'35;'35;' 35; Syntax +## Description +### Syntax `PERCENTILE_APPROX(expr, DOUBLE p)` @@ -9,7 +9,7 @@ Return the approximation of the point p, where the value of P is between 0 and 1 This function uses fixed size memory, so less memory can be used for columns with high cardinality, and can be used to calculate statistics such as tp99. -'35;'35; example +## example ``` MySQL > select `table`, percentile_approx(cost_time,0.99) from log_statis group by `table`; +---------------------+---------------------------+ diff --git a/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/stddev_EN.md b/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/stddev_EN.md index 63e459e212cefa..c5a09d91427f3f 100644 --- a/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/stddev_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/stddev_EN.md @@ -1,13 +1,13 @@ # STDDEV,STDDEV_POP -Description -'35;'35;' 35; Syntax +## Description +### Syntax -"`stddev (expl)' +`stddev (expl)` Returns the standard deviation of the expr expression -'35;'35; example +## example ``` MySQL > select stddev(scan_rows) from log_statis group by datetime; +---------------------+ diff --git a/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/stddev_samp_EN.md b/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/stddev_samp_EN.md index 2309cb49be5364..0970ded060d687 100644 --- a/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/stddev_samp_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/stddev_samp_EN.md @@ -1,13 +1,13 @@ -"35; STDDEV SAMP -Description -'35;'35;' 35; Syntax +# STDDEV_SAMP +## Description +### Syntax 'STDDEV SAMP (expr)' Returns the sample standard deviation of the expr expression -'35;'35; example +## example ``` MySQL > select stddev_samp(scan_rows) from log_statis group by datetime; +--------------------------+ diff --git a/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/sum_EN.md b/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/sum_EN.md index a0ceb7beb9e85a..c9b06f28414294 100644 --- a/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/sum_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/sum_EN.md @@ -1,13 +1,13 @@ # SUM -Description -'35;'35;' 35; Syntax +## Description +### Syntax ` Sum (Expr)' Used to return the sum of all values of the selected field -'35;'35; example +## example ``` MySQL > select sum(scan_rows) from log_statis group by datetime; +------------------+ diff --git a/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/var_samp_EN.md b/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/var_samp_EN.md index 22384650e764da..5fc65d572d70c9 100644 --- a/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/var_samp_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/var_samp_EN.md @@ -1,13 +1,13 @@ -"35; VARIANCE SAMP, VARIANCE SAMP -Description -'35;'35;' 35; Syntax +# VARIANCE_SAMP,VARIANCE_SAMP +## Description +### Syntax 'VAR SAMP (expr)' Returns the sample variance of the expr expression -'35;'35; example +## example ``` MySQL > select var_samp(scan_rows) from log_statis group by datetime; +-----------------------+ diff --git a/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/variance_EN.md b/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/variance_EN.md index bc28d18162640b..6b0da50e2359f9 100644 --- a/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/variance_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/aggregate-functions/variance_EN.md @@ -1,13 +1,13 @@ # VARIANCE,VAR_POP,VARIANCE_POP -Description -'35;'35;' 35; Syntax +## Description +### Syntax `VARIANCE(expr)` Returns the variance of the expr expression -'35;'35; example +## example ``` MySQL > select variance(scan_rows) from log_statis group by datetime; +-----------------------+ diff --git a/docs/documentation/en/sql-reference/sql-functions/cast_EN.md b/docs/documentation/en/sql-reference/sql-functions/cast_EN.md index d3e5fb93436a9f..4d1011b966e8d6 100644 --- a/docs/documentation/en/sql-reference/sql-functions/cast_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/cast_EN.md @@ -1,14 +1,14 @@ -'35; CAST -Description +# CAST +##Description ``` cast (input as type) ``` -'35;'35;' 35; BIGINT type +### BIGINT type -'35;'35;' 35; Syntax (BIGINT) +### Syntax (BIGINT) ``` cast (input as BIGINT) ``` @@ -18,7 +18,7 @@ Converts input to the specified type Converting the current column input to BIGINT type -'35;'35; example +## example 1. Turn constant, or a column in a table diff --git a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/date_add_EN.md b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/date_add_EN.md index fbaa7bd1463124..bebb73c2a6eb1f 100644 --- a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/date_add_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/date_add_EN.md @@ -1,6 +1,6 @@ -Date 35; Date Add -Description -'35;'35;' 35; Syntax +# date_add +## Description +### Syntax `INT DATE_ADD(DATETIME date,INTERVAL expr type)` @@ -13,7 +13,7 @@ The expr parameter is the interval you want to add. Sweet, sweet, sweet -'35;'35; example +## example ``` mysql > select date to add ('2010 -11 -30 23:59:59', INTERVAL 2 DAY); diff --git a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/date_sub_EN.md b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/date_sub_EN.md index b794857073d2a7..6aa8b734478eab 100644 --- a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/date_sub_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/date_sub_EN.md @@ -1,6 +1,6 @@ -3500; date sub -Description -'35;'35;' 35; Syntax +# date_sub +## Description +### Syntax `INT DATE_SUB(DATETIME date,INTERVAL expr type)` @@ -13,7 +13,7 @@ The expr parameter is the interval you want to add. Sweet, sweet, sweet -'35;'35; example +## example ``` mysql > select date sub ('2010 -11 -30 23:59:59', INTERVAL 2 DAY); diff --git a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/datediff_EN.md b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/datediff_EN.md index a085950c5adad6..8fdcb8f0ebaeb9 100644 --- a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/datediff_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/datediff_EN.md @@ -1,6 +1,6 @@ # datediff -Description -'35;'35;' 35; Syntax +## Description +### Syntax 'DATETIME DATEDIFF (DATETIME expr1,DATETIME expr2)' @@ -11,7 +11,7 @@ Expr1 and expr2 parameters are valid date or date/time expressions. Note: Only the date part of the value participates in the calculation. -'35;'35; example +### example ``` MySQL > select DateDiff (CAST ('2007 -12 -31 23:59:59 'AS DATETIME), CAST (2007 -12 -30' AS DATETIME)); diff --git a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/day_EN.md b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/day_EN.md index 048abeb71dccd6..b17b8993f4ae81 100644 --- a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/day_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/day_EN.md @@ -1,6 +1,6 @@ # day -Description -'35;'35;' 35; Syntax +## Description +### Syntax `INT DAY(DATETIME date)` @@ -9,7 +9,7 @@ Get the day information in the date, and return values range from 1 to 31. The parameter is Date or Datetime type -'35;'35; example +## example ``` mysql> select day('1987-01-31'); diff --git a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/dayname_EN.md b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/dayname_EN.md index e363906ff55c38..cc25e86f09a455 100644 --- a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/dayname_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/dayname_EN.md @@ -1,6 +1,6 @@ # dayname -Description -'35;'35;' 35; Syntax +## Description +### Syntax 'VARCHAR DAYNAME (DATE)' @@ -9,7 +9,7 @@ Date name corresponding to return date The parameter is Date or Datetime type -'35;'35; example +## example ``` mysql > select dayname ('2007 -02 -03 00:00'); diff --git a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/dayofmonth_EN.md b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/dayofmonth_EN.md index f683c4f9b0e2fd..4304a5d0de7100 100644 --- a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/dayofmonth_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/dayofmonth_EN.md @@ -1,6 +1,6 @@ -Dayofmonth -Description -'35;'35;' 35; Syntax +# Dayofmonth +## Description +### Syntax 'INT DAYOFMONTH (DATETIME date)' @@ -9,7 +9,7 @@ Get the day information in the date, and return values range from 1 to 31. The parameter is Date or Datetime type -'35;'35; example +## example ``` mysql> select dayofmonth('1987-01-31'); diff --git a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/dayofweek_EN.md b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/dayofweek_EN.md index f543f1e80cf210..3a5fbf86439a7f 100644 --- a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/dayofweek_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/dayofweek_EN.md @@ -1,6 +1,6 @@ # dayofweek -Description -'35;'35;' 35; Syntax +## Description +### Syntax INT DayOfWeek (DATETIME date) @@ -9,7 +9,7 @@ The DAYOFWEEK function returns the index value of the working day of the date, t The parameter is Date or Datetime type -'35;'35; example +## example ``` mysql> select dayofweek('2019-06-25'); diff --git a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/dayofyear_EN.md b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/dayofyear_EN.md index 5124c831561719..cbdfb3e3e0ddc6 100644 --- a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/dayofyear_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/dayofyear_EN.md @@ -1,6 +1,6 @@ -3500; Dayofyear -Description -'35;'35;' 35; Syntax +# Dayofyear +## Description +### Syntax 'INT DAYOFYEAR (DATETIME date)' @@ -9,7 +9,7 @@ The date of acquisition is the date of the corresponding year. The parameter is Date or Datetime type -'35;'35; example +## example ``` mysql > select dayofyear ('2007 -02 -03 00:00'); diff --git a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/from_days_EN.md b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/from_days_EN.md index 45f23313e39d8a..a3095fd91549dd 100644 --- a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/from_days_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/from_days_EN.md @@ -1,13 +1,13 @@ # from_days -Description -'35;'35;' 35; Syntax +## Description +### Syntax `DATE FROM_DAYS(INT N)` Calculate which day by the number of days from 0000-01-01 -'35;'35; example +## example ``` mysql > select from u days (730669); diff --git a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/index.rst b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/index.rst index 9841d7ea1d124d..ed3e2aa86792a3 100644 --- a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/index.rst +++ b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/index.rst @@ -1,6 +1,6 @@ -============= -日期函数 -============= +========================= +Date Time Functions +========================= .. toctree:: :glob: diff --git a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/month_EN.md b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/month_EN.md index c3ae6899313f3c..493be9cccdb0d3 100644 --- a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/month_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/month_EN.md @@ -1,6 +1,6 @@ -month -Description -'35;'35;' 35; Syntax +# month +## Description +### Syntax INT MONTH (DATETIME date) @@ -9,7 +9,7 @@ Returns month information in the time type, ranging from 1,12 The parameter is Date or Datetime type -'35;'35; example +## example ``` mysql> select month('1987-01-01'); diff --git a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/monthname_EN.md b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/monthname_EN.md index edf03909516f53..27c377fc3d3def 100644 --- a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/monthname_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/monthname_EN.md @@ -1,6 +1,6 @@ -\ 35; Monthname -Description -'35;'35;' 35; Syntax +# Monthname +## Description +### Syntax 'VARCHAR MONTHNAME (DATE)' @@ -9,7 +9,7 @@ Month name corresponding to return date The parameter is Date or Datetime type -'35;'35; example +## example ``` mysql > select monthname ('2008 -02 -03 00:00'); diff --git a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/now_EN.md b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/now_EN.md index 0c4685bc713a92..6ce54f3457fd65 100644 --- a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/now_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/now_EN.md @@ -1,13 +1,13 @@ # now -Description -'35;'35;' 35; Syntax +## Description +### Syntax 'DATETIME NOW ()' Get the current time and return it in Datetime type -'35;'35; example +## example ``` mysql> select now(); diff --git a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/str_to_date_EN.md b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/str_to_date_EN.md index 6201ccabc0d410..c78effae9bc3d6 100644 --- a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/str_to_date_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/str_to_date_EN.md @@ -1,6 +1,6 @@ -3500; Str_to_date -Description -'35;'35;' 35; Syntax +# Str_to_date +## Description +### Syntax 'DATETIME STR TWO DATES (VARCHAR STR, VARCHAR format)' @@ -9,7 +9,7 @@ Convert STR to DATE type by format specified, if the conversion result does not The format format supported is consistent with date_format -'35;'35; example +## example ``` mysql > select str to u date ('2014 -12 -21 12:34:56','%Y -%m -%d%H:%i:%s'); diff --git a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/timediff_EN.md b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/timediff_EN.md index 134cd39df4daf6..52a6effe114188 100644 --- a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/timediff_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/timediff_EN.md @@ -1,6 +1,6 @@ -Time diff -Description -'35;'35;' 35; Syntax +# timediff +## Description +### Syntax 'TIME TIMEDIFF (DATETIME expr1, DATETIME expr2)' @@ -11,7 +11,7 @@ The TIMEDIFF function returns the result of expr1 - expr2 expressed as a time va The results are limited to TIME values ranging from - 838:59:59 to 838:59:59. -'35;'35; example +### example ``` mysql> SELECT TIMEDIFF(now(),utc_timestamp()); diff --git a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/to_days_EN.md b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/to_days_EN.md index efea2bbeb0f65b..c104dba967d59a 100644 --- a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/to_days_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/to_days_EN.md @@ -1,6 +1,6 @@ -'35; to u days -Description -'35;'35;' 35; Syntax +# to_days +## Description +### Syntax 'INT TO DAYS' @@ -9,7 +9,7 @@ Days of returning date distance 0000-01-01 The parameter is Date or Datetime type -'35;'35; example +## example ``` mysql> select to_days('2007-10-07'); diff --git a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/utc_timestamp_EN.md b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/utc_timestamp_EN.md index fe7442083a0d93..844f6bfb3db54f 100644 --- a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/utc_timestamp_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/utc_timestamp_EN.md @@ -1,6 +1,6 @@ # utc_timestamp -Description -'35;'35;' 35; Syntax +## Description +### Syntax `DATETIME UTC_TIMESTAMP()` @@ -11,7 +11,7 @@ A Value of "YYYYMMDDHMMSS" Format Depending on whether the function is used in a string or numeric context -'35;'35; example +## example ``` mysql> select utc_timestamp(),utc_timestamp() + 1; diff --git a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/workofyear_EN.md b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/workofyear_EN.md index 977957de6684b0..6fbe04548a4de3 100644 --- a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/workofyear_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/workofyear_EN.md @@ -1,6 +1,6 @@ -'35; weekofyear -Description -'35;'35;' 35; Syntax +# weekofyear +## Description +### Syntax 'INT WEEKOFYEAR (DATETIME DATE)' @@ -10,7 +10,7 @@ Get the Weeks of the Year The parameter is Date or Datetime type -'35;'35; example +## example ``` mysql > select weekofyear ('2008 -02 -20 00:00:00'); diff --git a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/year_EN.md b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/year_EN.md index cba5e28614eab7..3720ec77267e08 100644 --- a/docs/documentation/en/sql-reference/sql-functions/date-time-functions/year_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/date-time-functions/year_EN.md @@ -1,6 +1,6 @@ # year -Description -'35;'35;' 35; Syntax +## Description +### Syntax `INT YEAR(DATETIME date)` @@ -9,7 +9,7 @@ Returns the year part of the date type, ranging from 1000 to 9999 The parameter is Date or Datetime type -'35;'35; example +## example ``` mysql> select year('1987-01-01'); diff --git a/docs/documentation/en/sql-reference/sql-functions/index.rst b/docs/documentation/en/sql-reference/sql-functions/index.rst index 4f929c43878d62..cbabe87ddc9200 100644 --- a/docs/documentation/en/sql-reference/sql-functions/index.rst +++ b/docs/documentation/en/sql-reference/sql-functions/index.rst @@ -1,6 +1,6 @@ -=========== -SQL 函数 -=========== +================== +SQL Functions +================== .. toctree:: :glob: diff --git a/docs/documentation/en/sql-reference/sql-functions/spatial-functions/index.rst b/docs/documentation/en/sql-reference/sql-functions/spatial-functions/index.rst index f09712d02b8b01..f36f6cc29bbf56 100644 --- a/docs/documentation/en/sql-reference/sql-functions/spatial-functions/index.rst +++ b/docs/documentation/en/sql-reference/sql-functions/spatial-functions/index.rst @@ -1,6 +1,6 @@ -============= -地理位置函数 -============= +======================= +Sptial Functions +======================= .. toctree:: :glob: diff --git a/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_astext_EN.md b/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_astext_EN.md index 2f35ac03f4c653..7802b20a76c1d5 100644 --- a/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_astext_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_astext_EN.md @@ -1,13 +1,13 @@ -'35; 'ST AsText','ST AsWKT' -Description -'35;'35;' 35; Syntax +# `ST_AsText`,`ST_AsWKT` +## Description +### Syntax 'VARCHAR ST'u AsText (GEOMETRY geo)' Converting a geometric figure into a WKT (Well Known Text) representation -'35;'35; example +## example ``` mysql> SELECT ST_AsText(ST_Point(24.7, 56.7)); @@ -18,4 +18,4 @@ mysql> SELECT ST_AsText(ST_Point(24.7, 56.7)); +---------------------------------+ ``` ##keyword -ST. ASTEXT, ST. ASWKT, ST, ASTEXT, ASWKT +ST_ASTEXT,ST_ASWKT,ST,ASTEXT,ASWKT diff --git a/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_circle_EN.md b/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_circle_EN.md index 55578980dfd5fd..68ece952eedf18 100644 --- a/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_circle_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_circle_EN.md @@ -1,6 +1,6 @@ # `ST_Circle` -Description -'35;'35;' 35; Syntax +## Description +### Syntax `GEOMETRY ST_Circle(DOUBLE center_lng, DOUBLE center_lat, DOUBLE radius)` @@ -8,7 +8,7 @@ Description Convert a WKT (Well Known Text) into a circle on the earth's sphere. Where `center_lng'denotes the longitude of the center of a circle, ` Center_lat` denotes the latitude of the center of a circle, radius` denotes the radius of a circle in meters. -'35;'35; example +## example ``` mysql> SELECT ST_AsText(ST_Circle(111, 64, 10000)); diff --git a/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_contains_EN.md b/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_contains_EN.md index 95162d4443bf4a..ff43c8997ce64f 100644 --- a/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_contains_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_contains_EN.md @@ -1,13 +1,13 @@ -\ 35; `St U contains' -Description -'35;'35;' 35; Syntax +# `ST_Contains' +## Description +### Syntax `BOOL ST_Contains(GEOMETRY shape1, GEOMETRY shape2)` Judging whether geometric shape 1 can contain geometric shape 2 completely -'35;'35; example +## example ``` MYSQL > Select ST ^ U contains (ST ^ U Polygon ("Polygon ((0, 10, 10, 10, 10, 10, 0, 10, 0, 0, 0))), ST ^ UPOint (5, 5)); @@ -25,4 +25,4 @@ MYSQL > Select St ^ U contains (ST ^ U Polygon ("Polygon ((0, 10, 10, 10, 10, 10 +------------------------------------------------------------------------------------------+ ``` ##keyword -St. John, St. John +ST_CONTAINS,ST,CONTAINS diff --git a/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_distance_sphere_EN.md b/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_distance_sphere_EN.md index 3592e61dbb16fb..e9a45e9c5daf62 100644 --- a/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_distance_sphere_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_distance_sphere_EN.md @@ -1,13 +1,13 @@ -Distance sphere -Description -'35;'35;' 35; Syntax +# `ST_Distance_Sphere` +## description +### Syntax `DOUBLE ST_Distance_Sphere(DOUBLE x_lng, DOUBLE x_lat, DOUBLE y_lng, DOUBLE x_lat)` Calculate the spherical distance between two points of the earth in meters. The incoming parameters are the longitude of point X, the latitude of point X, the longitude of point Y and the latitude of point Y. -'35;'35; example +## example ``` mysql> select st_distance_sphere(116.35620117, 39.939093, 116.4274406433, 39.9020987219); diff --git a/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_geometryfromtext_EN.md b/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_geometryfromtext_EN.md index 3af66a9f5bd4c8..dc0dc5c3ce91f1 100644 --- a/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_geometryfromtext_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_geometryfromtext_EN.md @@ -1,13 +1,13 @@ -'35; ` ST GeometryFromText','ST GeomFromText ' -Description -'35;'35;' 35; Syntax +# `ST_GeometryFromText`,`ST GeomFromText` +## Description +### Syntax 'GEOMETRY ST'u GeometryFromText (VARCHAR wkt)' Converting a WKT (Well Known Text) into a corresponding memory geometry -'35;'35; example +## example ``` mysql> SELECT ST_AsText(ST_GeometryFromText("LINESTRING (1 1, 2 2)")); @@ -18,4 +18,4 @@ mysql> SELECT ST_AsText(ST_GeometryFromText("LINESTRING (1 1, 2 2)")); +---------------------------------------------------------+ ``` ##keyword -ST. GEOMETRYFROMTEXT,ST. GEOMFROMTEXT,ST,GEOMETRYFROMTEXT,GEOMFROMTEXT +ST_GEOMETRYFROMTEXT,ST_GEOMFROMTEXT,ST,GEOMETRYFROMTEXT,GEOMFROMTEXT diff --git a/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_linefromtext_EN.md b/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_linefromtext_EN.md index c3925278879655..a2fed73c1b5246 100644 --- a/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_linefromtext_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_linefromtext_EN.md @@ -1,13 +1,13 @@ -'35; ` ST LineFromText','ST LineStringFromText ' -Description -'35;'35;' 35; Syntax +# `ST_LineFromText`,`ST_LineStringFromText` +## Description +### Syntax 'GEOMETRY ST LineFromText (VARCHAR wkt)' Converting a WKT (Well Known Text) into a Line-style memory representation -'35;'35; example +## example ``` mysql> SELECT ST_AsText(ST_LineFromText("LINESTRING (1 1, 2 2)")); @@ -18,4 +18,4 @@ mysql> SELECT ST_AsText(ST_LineFromText("LINESTRING (1 1, 2 2)")); +---------------------------------------------------------+ ``` ##keyword -ST. LINEFROMTEXT, ST. LINESTRINGFROMTEXT,ST,LINEFROMTEXT,LINESTRINGFROMTEXT +ST_LINEFROMTEXT, ST_LINESTRINGFROMTEXT,ST,LINEFROMTEXT,LINESTRINGFROMTEXT diff --git a/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_point_EN.md b/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_point_EN.md index a13359bdc38226..a924ef84c814f7 100644 --- a/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_point_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_point_EN.md @@ -1,6 +1,6 @@ -\ 35; St upoint' -Description -'35;'35;' 35; Syntax +# St_Point' +## Description +### Syntax `POINT ST_Point(DOUBLE x, DOUBLE y)` @@ -8,7 +8,7 @@ Description Given the X coordinate value, the Y coordinate value returns the corresponding Point. The current value is meaningful only for spherical sets, and X/Y corresponds to longitude/latitude. -'35;'35; example +## example ``` mysql> SELECT ST_AsText(ST_Point(24.7, 56.7)); @@ -19,4 +19,4 @@ mysql> SELECT ST_AsText(ST_Point(24.7, 56.7)); +---------------------------------+ ``` ##keyword -ST -u POINT,ST,POINT +ST_POINT,ST,POINT diff --git a/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_polygon_EN.md b/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_polygon_EN.md index b088ab8095a26e..21425809fb4717 100644 --- a/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_polygon_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_polygon_EN.md @@ -1,6 +1,6 @@ -'35; ` ST Polygon','ST PolyFromText','ST PolygonFromText ' -Description -'35;'35;' 35; Syntax +# `ST_Polygon`,`ST_PolyFromText`,`ST_PolygonFromText` +## Description +### Syntax 'GEOMETRY ST'u Polygon (VARCHAR wkt)' @@ -8,6 +8,7 @@ Description Converting a WKT (Well Known Text) into a corresponding polygon memory form +### example ``` mysql> SELECT ST_AsText(ST_Polygon("POLYGON ((0 0, 10 0, 10 10, 0 10, 0 0))")); diff --git a/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_x_EN.md b/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_x_EN.md index 854655d32c677f..4a6ea6b5e1d3e0 100644 --- a/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_x_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_x_EN.md @@ -1,13 +1,13 @@ -35; 'ST -u X' -Description -'35;'35;' 35; Syntax +# `ST_X` +## Description +### Syntax `DOUBLE ST_X(POINT point)` When point is a valid POINT type, the corresponding X coordinate value is returned. -'35;'35; example +## example ``` mysql> SELECT ST_X(ST_Point(24.7, 56.7)); diff --git a/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_y_EN.md b/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_y_EN.md index 1de6f29b42788c..e7a8bb98705d16 100644 --- a/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_y_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/spatial-functions/st_y_EN.md @@ -1,13 +1,13 @@ -35; 'ST -u Y' -Description -'35;'35;' 35; Syntax +# `ST_Y` +## Description +### Syntax `DOUBLE ST_Y(POINT point)` When point is a valid POINT type, the corresponding Y coordinate value is returned. -'35;'35; example +## example ``` mysql> SELECT ST_Y(ST_Point(24.7, 56.7)); diff --git a/docs/documentation/en/sql-reference/sql-functions/string-functions/ascii_EN.md b/docs/documentation/en/sql-reference/sql-functions/string-functions/ascii_EN.md index dcb94363402899..b98457ba1df720 100644 --- a/docs/documentation/en/sql-reference/sql-functions/string-functions/ascii_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/string-functions/ascii_EN.md @@ -1,13 +1,13 @@ -It35; ASCII -Description -'35;'35;' 35; Syntax +# ASCII +## Description +### Syntax 'INT AXES (WARCHAR STR)' Returns the ASCII code corresponding to the first character of the string -'35;'35; example +## example ``` mysql > select ascii ('1'); diff --git a/docs/documentation/en/sql-reference/sql-functions/string-functions/concat_EN.md b/docs/documentation/en/sql-reference/sql-functions/string-functions/concat_EN.md index df844d58f0fbe7..e3cdb579cd59aa 100644 --- a/docs/documentation/en/sql-reference/sql-functions/string-functions/concat_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/string-functions/concat_EN.md @@ -1,13 +1,13 @@ -'35; concat -Description -'35;'35;' 35; Syntax +# concat +## Description +### Syntax 'VARCHAR concat (VARCHAR,...)' Connect multiple strings and return NULL if any of the parameters is NULL -'35;'35; example +## example ``` mysql> select concat("a", "b"); diff --git a/docs/documentation/en/sql-reference/sql-functions/string-functions/concat_ws_EN.md b/docs/documentation/en/sql-reference/sql-functions/string-functions/concat_ws_EN.md index 3a559b964478de..6af64b4474dc23 100644 --- a/docs/documentation/en/sql-reference/sql-functions/string-functions/concat_ws_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/string-functions/concat_ws_EN.md @@ -1,6 +1,6 @@ -Concat w -Description -'35;'35;' 35; Syntax +# Concat_ws +## Description +### Syntax 'VARCHAR concat ws (VARCHAR sep., VARCHAR str,...)' @@ -9,7 +9,7 @@ Using the first parameter SEP as a connector, the second parameter and all subse If the separator is NULL, return NULL. ` The concat_ws` function does not skip empty strings, but NULL values. -'35;'35; example +## example ``` mysql> select concat_ws("or", "d", "is"); @@ -34,4 +34,4 @@ Concat ws ("or", "d", NULL,"is"). +---------------------------------+ ``` ##keyword -CONCAT WS,CONCAT,WS +CONCAT_WS,CONCAT,WS diff --git a/docs/documentation/en/sql-reference/sql-functions/string-functions/find_in_set_EN.md b/docs/documentation/en/sql-reference/sql-functions/string-functions/find_in_set_EN.md index eb20c4bb743441..24ae8da43e72d3 100644 --- a/docs/documentation/en/sql-reference/sql-functions/string-functions/find_in_set_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/string-functions/find_in_set_EN.md @@ -1,13 +1,15 @@ -IV35; Find@U set -Description -'35;'35;' 35; Syntax +# find_in_set +## description +### Syntax + +`INT find_in_set(VARCHAR str, VARCHAR strlist)` "NOT found in set (VARCHAR str., VARCHAR strlist)" Return to the location where the str first appears in strlist (counting from 1). Strlist is a comma-separated string. If not, return 0. Any parameter is NULL, returning NULL. -'35;'35; example +## example ``` mysql > select find in u set ("b", "a,b,c"); diff --git a/docs/documentation/en/sql-reference/sql-functions/string-functions/get_json_double_EN.md b/docs/documentation/en/sql-reference/sql-functions/string-functions/get_json_double_EN.md index 5362d230fd8c3c..f069dbbdd2e9de 100644 --- a/docs/documentation/en/sql-reference/sql-functions/string-functions/get_json_double_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/string-functions/get_json_double_EN.md @@ -1,8 +1,8 @@ -Get two copies -Description -'35;'35;' 35; Syntax +# get_json_double +## description +### Syntax -"DOUBLE get" is a double (VARCHAR is on the street, VARCHAR is on the path) +`DOUBLE get_json_double(VARCHAR json_str, VARCHAR json_path) Parse and get the floating-point content of the specified path in the JSON string. @@ -11,7 +11,7 @@ Use [] to denote array subscripts, starting at 0. The content of path cannot contain ",[and]. If the json_string format is incorrect, or the json_path format is incorrect, or matches cannot be found, NULL is returned. -'35;'35; example +## example 1. Get the value of key as "k1" diff --git a/docs/documentation/en/sql-reference/sql-functions/string-functions/get_json_int_EN.md b/docs/documentation/en/sql-reference/sql-functions/string-functions/get_json_int_EN.md index 0f6bf0cb2527d7..1fa4243e163a23 100644 --- a/docs/documentation/en/sql-reference/sql-functions/string-functions/get_json_int_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/string-functions/get_json_int_EN.md @@ -1,6 +1,6 @@ # get_json_int -Description -'35;'35;' 35; Syntax +## Description +### Syntax 'I don't get you int (VARCHAR is on, VARCHAR is on the path) @@ -11,7 +11,7 @@ Use [] to denote array subscripts, starting at 0. The content of path cannot contain ",[and]. If the json_string format is incorrect, or the json_path format is incorrect, or matches cannot be found, NULL is returned. -'35;'35; example +## example 1. Get the value of key as "k1" diff --git a/docs/documentation/en/sql-reference/sql-functions/string-functions/get_json_string_EN.md b/docs/documentation/en/sql-reference/sql-functions/string-functions/get_json_string_EN.md index e2d5455ac8ab26..2980159407c2b1 100644 --- a/docs/documentation/en/sql-reference/sql-functions/string-functions/get_json_string_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/string-functions/get_json_string_EN.md @@ -1,6 +1,6 @@ -''35; get me a string -Description -'35;'35;' 35; Syntax +# get_json_string +## description +### Syntax 'VARCHAR get'u string (VARCHAR json str, VARCHAR json path) @@ -11,7 +11,7 @@ Use [] to denote array subscripts, starting at 0. The content of path cannot contain ",[and]. If the json_string format is incorrect, or the json_path format is incorrect, or matches cannot be found, NULL is returned. -'35;'35; example +## example 1. Get the value of key as "k1" diff --git a/docs/documentation/en/sql-reference/sql-functions/string-functions/group_concat_EN.md b/docs/documentation/en/sql-reference/sql-functions/string-functions/group_concat_EN.md index c3c06d05468676..5fc194f570712e 100644 --- a/docs/documentation/en/sql-reference/sql-functions/string-functions/group_concat_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/string-functions/group_concat_EN.md @@ -1,13 +1,13 @@ -Groups \\\35 -Description -'35;'35;' 35; Syntax +# group_concat +## description +### Syntax -'VARCHAR group 'concat (VARCHAR str [, VARCHAR sep]) +`VARCHAR group_concat(VARCHAR str[, VARCHAR sep])` This function is an aggregation function similar to sum (), and group_concat links multiple rows of results in the result set to a string. The second parameter, sep, is a connection symbol between strings, which can be omitted. This function usually needs to be used with group by statements. -'35;'35; example +## example ``` mysql> select value from test; diff --git a/docs/documentation/en/sql-reference/sql-functions/string-functions/index.rst b/docs/documentation/en/sql-reference/sql-functions/string-functions/index.rst index 7d372f8a93a082..411341eaa1d732 100644 --- a/docs/documentation/en/sql-reference/sql-functions/string-functions/index.rst +++ b/docs/documentation/en/sql-reference/sql-functions/string-functions/index.rst @@ -1,6 +1,6 @@ -============= -字符串函数 -============= +======================= +String Functions +======================= .. toctree:: :glob: diff --git a/docs/documentation/en/sql-reference/sql-functions/string-functions/instr_EN.md b/docs/documentation/en/sql-reference/sql-functions/string-functions/instr_EN.md index 36c299a471d5da..7dde9643ea5779 100644 --- a/docs/documentation/en/sql-reference/sql-functions/string-functions/instr_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/string-functions/instr_EN.md @@ -1,13 +1,13 @@ -~35instr -Description -'35;'35;' 35; Syntax +# instr +## Description +### Syntax 'INT INSR (WARCHAR STR, WARCHAR substrate)' Returns the location where substr first appeared in str (counting from 1). If substr does not appear in str, return 0. -'35;'35; example +## example ``` mysql> select instr("abc", "b"); diff --git a/docs/documentation/en/sql-reference/sql-functions/string-functions/lcase_EN.md b/docs/documentation/en/sql-reference/sql-functions/string-functions/lcase_EN.md index b1d23e0059a722..6a918f4c7f5368 100644 --- a/docs/documentation/en/sql-reference/sql-functions/string-functions/lcase_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/string-functions/lcase_EN.md @@ -1,6 +1,6 @@ -'35; lcase -Description -'35;'35;' 35; Syntax +# lcase +## Description +### Syntax 'INT lcase (VARCHAR str)' diff --git a/docs/documentation/en/sql-reference/sql-functions/string-functions/left_EN.md b/docs/documentation/en/sql-reference/sql-functions/string-functions/left_EN.md index ad071bf789d79f..90cff590bef960 100644 --- a/docs/documentation/en/sql-reference/sql-functions/string-functions/left_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/string-functions/left_EN.md @@ -1,13 +1,13 @@ # left -Description -'35;'35;' 35; Syntax +## Description +### Syntax 'VARCHAR left (VARCHAR str)' It returns the left part of a string of specified length -'35;'35; example +## example ``` mysql> select left("Hello doris",5); diff --git a/docs/documentation/en/sql-reference/sql-functions/string-functions/length_EN.md b/docs/documentation/en/sql-reference/sql-functions/string-functions/length_EN.md index b24ea0c4a3e8aa..bb4fb1aa2bd99e 100644 --- a/docs/documentation/en/sql-reference/sql-functions/string-functions/length_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/string-functions/length_EN.md @@ -1,13 +1,13 @@ # length -Description -'35;'35;' 35; Syntax +## Description +### Syntax 'INT length (VARCHAR str)' Returns the length of the string and the number of characters returned for multi-byte characters. For example, five two-byte width words return a length of 10. -'35;'35; example +## example ``` mysql> select length("abc"); diff --git a/docs/documentation/en/sql-reference/sql-functions/string-functions/locate_EN.md b/docs/documentation/en/sql-reference/sql-functions/string-functions/locate_EN.md index fcee2e13ef0161..fa838202590b8d 100644 --- a/docs/documentation/en/sql-reference/sql-functions/string-functions/locate_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/string-functions/locate_EN.md @@ -1,13 +1,13 @@ -'35; locate -Description -'35;'35;' 35; Syntax +# locate +## Description +### Syntax 'INT LOCATION (WARCHAR substrate, WARCHAR str [, INT pos]]' Returns where substr appears in str (counting from 1). If the third parameter POS is specified, the position where substr appears is found from the string where STR starts with POS subscript. If not found, return 0 -'35;'35; example +## example ``` mysql> SELECT LOCATE('bar', 'foobarbar'); diff --git a/docs/documentation/en/sql-reference/sql-functions/string-functions/lower_EN.md b/docs/documentation/en/sql-reference/sql-functions/string-functions/lower_EN.md index 94f56bb49b1526..e2de65793456e5 100644 --- a/docs/documentation/en/sql-reference/sql-functions/string-functions/lower_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/string-functions/lower_EN.md @@ -1,13 +1,13 @@ # lower -Description -'35;'35;' 35; Syntax +## Description +### Syntax 'INT lower (WARCHAR str)' Convert all strings in parameters to lowercase -'35;'35; example +## example ``` mysql> SELECT lower("AbC123"); diff --git a/docs/documentation/en/sql-reference/sql-functions/string-functions/lpad_EN.md b/docs/documentation/en/sql-reference/sql-functions/string-functions/lpad_EN.md index 070a81b7734fc0..6ac8ad55e1fd65 100644 --- a/docs/documentation/en/sql-reference/sql-functions/string-functions/lpad_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/string-functions/lpad_EN.md @@ -1,13 +1,13 @@ -{35; lpad -Description -'35;'35;' 35; Syntax +# lpad +## Description +### Syntax 'VARCHAR lpad (VARCHAR str., INT len, VARCHAR pad)' Returns a string of length len in str, starting with the initials. If len is longer than str, pad characters are added to STR until the length of the string reaches len. If len is less than str's length, the function is equivalent to truncating STR strings and returning only strings of len's length. -'35;'35; example +## example ``` mysql > SELECT lpad ("hi", 5, "xy"); diff --git a/docs/documentation/en/sql-reference/sql-functions/string-functions/ltrim_EN.md b/docs/documentation/en/sql-reference/sql-functions/string-functions/ltrim_EN.md index bacd064c85cd92..4dac479a3c7481 100644 --- a/docs/documentation/en/sql-reference/sql-functions/string-functions/ltrim_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/string-functions/ltrim_EN.md @@ -1,13 +1,13 @@ -'35; ltrim -Description -'35;'35;' 35; Syntax +# ltrim +## Description +### Syntax 'VARCHAR ltrim (VARCHAR str)' Remove the space that appears continuously from the beginning of the parameter str -'35;'35; example +## example ``` mysql > SELECT ltrim (ab d'); diff --git a/docs/documentation/en/sql-reference/sql-functions/string-functions/money_format_EN.md b/docs/documentation/en/sql-reference/sql-functions/string-functions/money_format_EN.md index 3b7c6036f1b5eb..2cfe379fef560a 100644 --- a/docs/documentation/en/sql-reference/sql-functions/string-functions/money_format_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/string-functions/money_format_EN.md @@ -1,13 +1,13 @@ # money_format -Description -'35;'35;' 35; Syntax +## Description +### Syntax VARCHAR money format (Number) The number is output in currency format, the integer part is separated by commas every three bits, and the decimal part is reserved for two bits. -'35;'35; example +## example ``` mysql> select money_format(17014116); diff --git a/docs/documentation/en/sql-reference/sql-functions/string-functions/regexp_extract_EN.md b/docs/documentation/en/sql-reference/sql-functions/string-functions/regexp_extract_EN.md index 4e5d90b632be4f..972fb57c4429ce 100644 --- a/docs/documentation/en/sql-reference/sql-functions/string-functions/regexp_extract_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/string-functions/regexp_extract_EN.md @@ -1,13 +1,13 @@ # regexp_extract -Description -'35;'35;' 35; Syntax +## Description +### Syntax 'VARCHAR regexp 'extract (VARCHAR str, VARCHAR pattern, int pos) The string STR is matched regularly and the POS matching part which conforms to pattern is extracted. Patterns need to match exactly some part of the STR to return to the matching part of the pattern. If there is no match, return an empty string. -'35;'35; example +## example ``` mysql> SELECT regexp_extract('AbCdE', '([[:lower:]]+)C([[:lower:]]+)', 1); diff --git a/docs/documentation/en/sql-reference/sql-functions/string-functions/regexp_replace_EN.md b/docs/documentation/en/sql-reference/sql-functions/string-functions/regexp_replace_EN.md index 8913c4e5fe6584..c340c700e5fcbf 100644 --- a/docs/documentation/en/sql-reference/sql-functions/string-functions/regexp_replace_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/string-functions/regexp_replace_EN.md @@ -1,13 +1,13 @@ -Replace regexp -Description -'35;'35;' 35; Syntax +# regexp_replace +## description +### Syntax -VARCHAR regexp replace (VARCHAR str, VARCHAR pattern, VARCHAR repl) +`VARCHAR regexp_replace(VARCHAR str, VARCHAR pattern, VARCHAR repl) Regular matching of STR strings, replacing the part hitting pattern with repl -'35;'35; example +## example ``` mysql> SELECT regexp_replace('a b c', " ", "-"); diff --git a/docs/documentation/en/sql-reference/sql-functions/string-functions/repeat_EN.md b/docs/documentation/en/sql-reference/sql-functions/string-functions/repeat_EN.md index 0630b9a711a163..528575adcfe710 100644 --- a/docs/documentation/en/sql-reference/sql-functions/string-functions/repeat_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/string-functions/repeat_EN.md @@ -1,13 +1,13 @@ # repeat -Description -'35;'35;' 35; Syntax +## Description +### Syntax 'VARCHAR repeat (VARCHAR str, INT count) Repeat the str of the string count times, return empty string when count is less than 1, return NULL when str, count is any NULL -'35;'35; example +## example ``` mysql> SELECT repeat("a", 3); diff --git a/docs/documentation/en/sql-reference/sql-functions/string-functions/right_EN.md b/docs/documentation/en/sql-reference/sql-functions/string-functions/right_EN.md index 3bce2e313fde61..7a1807d1018dce 100644 --- a/docs/documentation/en/sql-reference/sql-functions/string-functions/right_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/string-functions/right_EN.md @@ -1,13 +1,13 @@ # right -Description -'35;'35;' 35; Syntax +## Description +### Syntax -'WARCHAR RIGHT (WARCHAR STR)' +'VARCHAR RIGHT (VARCHAR STR)' It returns the right part of a string of specified length -'35;'35; example +## example ``` mysql> select right("Hello doris",5); diff --git a/docs/documentation/en/sql-reference/sql-functions/string-functions/split_part_EN.md b/docs/documentation/en/sql-reference/sql-functions/string-functions/split_part_EN.md index ea173dac068d56..c74dcbbc3b690e 100644 --- a/docs/documentation/en/sql-reference/sql-functions/string-functions/split_part_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/string-functions/split_part_EN.md @@ -1,13 +1,13 @@ # split_part -Description -'35;'35;' 35; Syntax +## Description +### Syntax 'VARCHAR split party (VARCHAR content, VARCHAR delimiter, INT field)' Returns the specified partition (counting from the beginning) by splitting the string according to the partitioner. -'35;'35; example +## example ``` mysql> select split_part("hello world", " ", 1); diff --git a/docs/documentation/en/sql-reference/sql-functions/string-functions/strleft_EN.md b/docs/documentation/en/sql-reference/sql-functions/string-functions/strleft_EN.md index 3e62b0da341f3d..f1aeb9d8df5022 100644 --- a/docs/documentation/en/sql-reference/sql-functions/string-functions/strleft_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/string-functions/strleft_EN.md @@ -1,13 +1,13 @@ # strleft -Description -'35;'35;' 35; Syntax +## Description +### Syntax -'WARCHAR STRAIGHT (WARCHAR STR)' +'VARCHAR STRAIGHT (VARCHAR STR)' It returns the left part of a string of specified length -'35;'35; example +## example ``` mysql> select strleft("Hello doris",5); diff --git a/docs/documentation/en/sql-reference/sql-functions/string-functions/strright_EN.md b/docs/documentation/en/sql-reference/sql-functions/string-functions/strright_EN.md index 96b4c164adfede..eeaed89b30cfd5 100644 --- a/docs/documentation/en/sql-reference/sql-functions/string-functions/strright_EN.md +++ b/docs/documentation/en/sql-reference/sql-functions/string-functions/strright_EN.md @@ -1,13 +1,13 @@ -35; strright -Description -'35;'35;' 35; Syntax +# strright +## Description +### Syntax 'VARCHAR strright (VARCHAR str)' It returns the right part of a string of specified length -'35;'35; example +## example ``` mysql> select strright("Hello doris",5); diff --git a/docs/documentation/en/sql-reference/sql-statements/Account Management/CREATE ROLE_EN.md b/docs/documentation/en/sql-reference/sql-statements/Account Management/CREATE ROLE_EN.md index 6d939d48e61eaf..0ef785b7c408e1 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Account Management/CREATE ROLE_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Account Management/CREATE ROLE_EN.md @@ -1,5 +1,5 @@ # CREATE ROLE -Description +## Description The statement user creates a role Grammar: @@ -7,7 +7,7 @@ CREATE ROLE role1; This statement creates an unauthorized role that can be subsequently granted permission through the GRANT command. -'35;'35; example +## example 1. Create a role diff --git a/docs/documentation/en/sql-reference/sql-statements/Account Management/CREATE USER_EN.md b/docs/documentation/en/sql-reference/sql-statements/Account Management/CREATE USER_EN.md index 949534a2dfeca0..7fcd8c7fec0cb9 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Account Management/CREATE USER_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Account Management/CREATE USER_EN.md @@ -1,5 +1,5 @@ # CREATE USER -Description +##Description Syntax: @@ -14,7 +14,7 @@ The host part can also be specified as a domain with the grammar:'user_name'@['d If a role (ROLE) is specified, the permissions that the role has are automatically granted to the newly created user. If not specified, the user defaults to having no permissions. The specified ROLE must already exist. -'35;'35; example +## example 1. Create a passwordless user (without specifying host, it is equivalent to Jack @'%') diff --git a/docs/documentation/en/sql-reference/sql-statements/Account Management/DROP ROLE_EN.md b/docs/documentation/en/sql-reference/sql-statements/Account Management/DROP ROLE_EN.md index 5726b96f643f77..a119a9c234ab9d 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Account Management/DROP ROLE_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Account Management/DROP ROLE_EN.md @@ -1,5 +1,5 @@ # DROP ROLE -Description +## Description The statement user deletes a role Grammar: @@ -7,7 +7,7 @@ DROP ROLE role1; Deleting a role does not affect the permissions of users who previously belonged to that role. It is only equivalent to decoupling the role from the user. The permissions that the user has obtained from the role will not change. -'35;'35; example +## example 1. Delete a role diff --git a/docs/documentation/en/sql-reference/sql-statements/Account Management/DROP USER_EN.md b/docs/documentation/en/sql-reference/sql-statements/Account Management/DROP USER_EN.md index ce34afc93ff269..47e30fd0a9c632 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Account Management/DROP USER_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Account Management/DROP USER_EN.md @@ -1,5 +1,5 @@ # DROP USER -Description +## Description Syntax: @@ -7,7 +7,7 @@ DROP USER 'user_name' The DROP USER command deletes a Palo user. Doris does not support deleting the specified user_identity here. When a specified user is deleted, all user_identities corresponding to that user are deleted. For example, two users, Jack @'192%'and Jack @['domain'] were created through the CREATE USER statement. After DROP USER'jack' was executed, Jack @'192%'and Jack @['domain'] would be deleted. -'35;'35; example +## example 1. Delete user jack diff --git a/docs/documentation/en/sql-reference/sql-statements/Account Management/GRANT_EN.md b/docs/documentation/en/sql-reference/sql-statements/Account Management/GRANT_EN.md index a3ca675977bc91..a4ab8c03a708b2 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Account Management/GRANT_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Account Management/GRANT_EN.md @@ -1,5 +1,5 @@ -Grant -Description +# Grant +## Description The GRANT command is used to give the specified user or role the specified permissions. @@ -36,7 +36,7 @@ The user_identity syntax here is the same as CREATE USER. And you must create us You can also grant permissions to the specified ROLE, which is automatically created if the specified ROLE does not exist. -'35;'35; example +## example 1. Grant permissions to all libraries and tables to users diff --git a/docs/documentation/en/sql-reference/sql-statements/Account Management/REVOKE_EN.md b/docs/documentation/en/sql-reference/sql-statements/Account Management/REVOKE_EN.md index fa217e166389c0..856ac368adc157 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Account Management/REVOKE_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Account Management/REVOKE_EN.md @@ -1,5 +1,5 @@ # REVOKE -Description +## Description The REVOKE command is used to revoke the rights specified by the specified user or role. Syntax @@ -11,7 +11,7 @@ The user_identity syntax here is the same as CREATE USER. And you must create us You can also revoke the permission of the specified ROLE, which must exist for execution. -'35;'35; example +## example 1. Revoke the rights of user Jack database testDb diff --git a/docs/documentation/en/sql-reference/sql-statements/Account Management/SET PASSWORD_EN.md b/docs/documentation/en/sql-reference/sql-statements/Account Management/SET PASSWORD_EN.md index a288ad1ca5a510..86be5af05ea391 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Account Management/SET PASSWORD_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Account Management/SET PASSWORD_EN.md @@ -1,5 +1,5 @@ # SET PASSWORD -Description +## Description Syntax: @@ -13,7 +13,7 @@ Note that the user_identity here must match exactly the user_identity specified PASSWORD () input is a plaintext password, and direct use of strings, you need to pass the encrypted password. If you change the password of other users, you need to have administrator privileges. -'35;'35; example +## example 1. Modify the password of the current user diff --git a/docs/documentation/en/sql-reference/sql-statements/Account Management/SET PROPERTY_EN.md b/docs/documentation/en/sql-reference/sql-statements/Account Management/SET PROPERTY_EN.md index fa7f2f86659a44..1cc17b6b7cb0ef 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Account Management/SET PROPERTY_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Account Management/SET PROPERTY_EN.md @@ -1,5 +1,5 @@ # SET PROPERTY -Description +## Description Syntax: @@ -26,7 +26,7 @@ Load_cluster. {cluster_name}. hadoop_configs: configuration of hadoop, where fs. Load ucluster. {cluster name}. hadoop port: Hadoop HDFS name node http} Default_load_cluster: The default import cluster. -'35;'35; example +## example 1. Modify the maximum number of user jacks to 1000 SET PROPERTY FOR 'jack' 'max_user_connections' = '1000'; diff --git a/docs/documentation/en/sql-reference/sql-statements/Account Management/SHOW GRANTS_EN.md b/docs/documentation/en/sql-reference/sql-statements/Account Management/SHOW GRANTS_EN.md index 35295aff57b9b2..f7de555088e357 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Account Management/SHOW GRANTS_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Account Management/SHOW GRANTS_EN.md @@ -1,5 +1,5 @@ # SHOW GRANTS -Description +## Description This statement is used to view user rights. @@ -12,7 +12,7 @@ Explain: 3. If you do not specify user_identity, view the permissions of the current user. -'35;'35; example +## example 1. View all user rights information diff --git a/docs/documentation/en/sql-reference/sql-statements/Account Management/SHOW ROLES_EN.md b/docs/documentation/en/sql-reference/sql-statements/Account Management/SHOW ROLES_EN.md index b877c4b7b06671..45955f4e74b3f1 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Account Management/SHOW ROLES_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Account Management/SHOW ROLES_EN.md @@ -1,11 +1,11 @@ # SHOW ROLES -Description +## Description This statement is used to display all created role information, including the role name, the user included, and the permissions. Grammar: SHOW ROLES; -'35;'35; example +## example 1. View the created roles: diff --git a/docs/documentation/en/sql-reference/sql-statements/Account Management/index.rst b/docs/documentation/en/sql-reference/sql-statements/Account Management/index.rst new file mode 100644 index 00000000000000..68c44caa012cb3 --- /dev/null +++ b/docs/documentation/en/sql-reference/sql-statements/Account Management/index.rst @@ -0,0 +1,8 @@ +====================== +Account Management +====================== + +.. toctree:: + :glob: + + * diff --git a/docs/documentation/en/sql-reference/sql-statements/Administration/ADMIN CANCEL REPAIR_EN.md b/docs/documentation/en/sql-reference/sql-statements/Administration/ADMIN CANCEL REPAIR_EN.md index a38293a56053e3..47c99b7182ee09 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Administration/ADMIN CANCEL REPAIR_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Administration/ADMIN CANCEL REPAIR_EN.md @@ -1,5 +1,5 @@ # ADMIN CANCEL REPAIR -Description +## Description This statement is used to cancel repairing a specified table or partition with high priority @@ -11,7 +11,7 @@ Explain: 1. This statement only indicates that the system no longer repairs fragmented copies of specified tables or partitions with high priority. The system will still repair the copy by default scheduling. -'35;'35; example +## example 1. Cancel High Priority Repair diff --git a/docs/documentation/en/sql-reference/sql-statements/Administration/ADMIN REPAIR_EN.md b/docs/documentation/en/sql-reference/sql-statements/Administration/ADMIN REPAIR_EN.md index fe24057c3f7b1d..bd12c2dc6efaba 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Administration/ADMIN REPAIR_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Administration/ADMIN REPAIR_EN.md @@ -1,5 +1,5 @@ # ADMIN REPAIR -Description +## Description This statement is used to try to fix the specified table or partition first @@ -12,7 +12,7 @@ Explain: 1. This statement only means that the system attempts to repair a fragmented copy of a specified table or partition with high priority, and it is not guaranteed to be successful. Users can view the repair status through the ADMIN SHOW REPLICA STATUS command. 2. The default timeout is 14400 seconds (4 hours). Timeout means that the system will no longer repair fragmented copies of specified tables or partitions with high priority. The command settings need to be reused. -'35;'35; example +## example 1. Attempt to fix the specified table diff --git a/docs/documentation/en/sql-reference/sql-statements/Administration/ADMIN SET CONFIG_EN.md b/docs/documentation/en/sql-reference/sql-statements/Administration/ADMIN SET CONFIG_EN.md index 1a17c5e1add684..d3a463d1136e91 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Administration/ADMIN SET CONFIG_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Administration/ADMIN SET CONFIG_EN.md @@ -1,5 +1,5 @@ # ADMIN SET CONFIG -Description +## Description This statement is used to set the configuration items for the cluster (currently only the configuration items for setting FE are supported). Settable configuration items can be viewed through AMDIN SHOW FRONTEND CONFIG; commands. @@ -8,7 +8,7 @@ Grammar: ADMIN SET FRONTEND CONFIG ("key" = "value"); -'35;'35; example +## example 1. "disable balance" true diff --git a/docs/documentation/en/sql-reference/sql-statements/Administration/ADMIN SHOW CONFIG_EN.md b/docs/documentation/en/sql-reference/sql-statements/Administration/ADMIN SHOW CONFIG_EN.md index 7ff776e2b86040..6479acad1cc9a9 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Administration/ADMIN SHOW CONFIG_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Administration/ADMIN SHOW CONFIG_EN.md @@ -1,5 +1,5 @@ # ADMIN SHOW CONFIG -Description +## Description This statement is used to show the configuration of the current cluster (currently only supporting the display of FE configuration items) @@ -17,7 +17,7 @@ The implications of the results are as follows: 5. MasterOnly： 是否仅适用于 Master FE 6. Comment: Configuration Item Description -'35;'35; example +## example 1. View the configuration of the current FE node diff --git a/docs/documentation/en/sql-reference/sql-statements/Administration/ADMIN SHOW REPLICA DISTRIBUTION_EN.md b/docs/documentation/en/sql-reference/sql-statements/Administration/ADMIN SHOW REPLICA DISTRIBUTION_EN.md index c34fb9a9a228d3..9a65b0bc7e1fa0 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Administration/ADMIN SHOW REPLICA DISTRIBUTION_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Administration/ADMIN SHOW REPLICA DISTRIBUTION_EN.md @@ -1,5 +1,5 @@ # ADMIN SHOW REPLICA DISTRIBUTION -Description +## Description This statement is used to show the distribution status of a table or partition replica @@ -11,7 +11,7 @@ Explain: The Graph column in the result shows the distribution ratio of replicas graphically -'35;'35; example +## example 1. View the distribution of replicas of tables diff --git a/docs/documentation/en/sql-reference/sql-statements/Administration/ADMIN SHOW REPLICA STATUS_EN.md b/docs/documentation/en/sql-reference/sql-statements/Administration/ADMIN SHOW REPLICA STATUS_EN.md index 53525c09a829ec..90b80796afbad9 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Administration/ADMIN SHOW REPLICA STATUS_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Administration/ADMIN SHOW REPLICA STATUS_EN.md @@ -1,5 +1,5 @@ # ADMIN SHOW REPLICA STATUS -Description +## Description This statement is used to display copy status information for a table or partition @@ -18,7 +18,7 @@ VERSION_ERROR: The replica data version is missing SCHEMA ERROR: replica schema hash MISSING: replica does not exist -'35;'35; example +## example 1. View the status of all copies of the table diff --git a/docs/documentation/en/sql-reference/sql-statements/Administration/ALTER CLUSTER_EN.md b/docs/documentation/en/sql-reference/sql-statements/Administration/ALTER CLUSTER_EN.md index ad43bc711254b6..660b6e9c17ffaf 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Administration/ALTER CLUSTER_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Administration/ALTER CLUSTER_EN.md @@ -1,5 +1,5 @@ -OLD CLUSES -Description +# ALTER CLUSTER +## description This statement is used to update the logical cluster. Administrator privileges are required @@ -13,7 +13,7 @@ Proerties ("Instrume = Unum"= "3") Instancefn Microsoft Yahei -'35;'35; example +## example 1. Reduce the number of be of logical cluster test_cluster containing 3 be by 2. diff --git a/docs/documentation/en/sql-reference/sql-statements/Administration/ALTER SYSTEM_EN.md b/docs/documentation/en/sql-reference/sql-statements/Administration/ALTER SYSTEM_EN.md index 3b69dc6e1f1aee..b66c7ce03bdb1a 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Administration/ALTER SYSTEM_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Administration/ALTER SYSTEM_EN.md @@ -1,5 +1,5 @@ # ALTER SYSTEM -Description +## Description This statement is used to operate on nodes in a system. (Administrator only!) Grammar: @@ -47,7 +47,7 @@ Broker: Name of broker Path: Remote Storage Path Other properties: Other information necessary to access remote storage, such as authentication information. -'35;'35; example +## example 1. Add a node ALTER SYSTEM ADD BACKEND "host:port"; diff --git a/docs/documentation/en/sql-reference/sql-statements/Administration/CANCEL DECOMMISSION_EN.md b/docs/documentation/en/sql-reference/sql-statements/Administration/CANCEL DECOMMISSION_EN.md index 40a59122a65656..80df49f4500be5 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Administration/CANCEL DECOMMISSION_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Administration/CANCEL DECOMMISSION_EN.md @@ -1,11 +1,11 @@ # CANCEL DECOMMISSION -Description +## Description This statement is used to undo a node's offline operation. (Administrator only!) Grammar: CANCEL DECOMMISSION BACKEND "host:heartbeat_port"[,"host:heartbeat_port"...]; -'35;'35; example +## example 1. Cancel the offline operation of two nodes: CANCEL DECOMMISSION BACKEND "host1:port", "host2:port"; diff --git a/docs/documentation/en/sql-reference/sql-statements/Administration/CREATE CLUSTER_EN.md b/docs/documentation/en/sql-reference/sql-statements/Administration/CREATE CLUSTER_EN.md index 425e5d676f50f4..487c48d63be39e 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Administration/CREATE CLUSTER_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Administration/CREATE CLUSTER_EN.md @@ -1,5 +1,5 @@ # CREATE CLUSTER -Description +## Description This statement is used to create a new logical cluster, requiring administrator privileges. If you don't use multiple tenants, create a cluster named default_cluster directly. Otherwise, create a cluster with a custom name. @@ -21,7 +21,7 @@ Instancefn Microsoft Yahei 2. Identify by'password'each logical cluster contains a superuser whose password must be specified when creating a logical cluster -'35;'35; example +## example 1. Create a new test_cluster with three be nodes and specify its superuser password diff --git a/docs/documentation/en/sql-reference/sql-statements/Administration/CREATE FILE_EN.md b/docs/documentation/en/sql-reference/sql-statements/Administration/CREATE FILE_EN.md index 25c03b350954c2..1e96f659cf166d 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Administration/CREATE FILE_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Administration/CREATE FILE_EN.md @@ -1,5 +1,5 @@ # CREATE FILE -Description +## Description This statement is used to create and upload a file to the Doris cluster. This function is usually used to manage files that need to be used in some other commands, such as certificates, public key, private key, etc. @@ -24,7 +24,7 @@ Url: Must. Specify a download path for a file. Currently only unauthenticated HT Catalog: Yes. The classification name of the file can be customized. But in some commands, files in the specified catalog are looked up. For example, in a routine import, when the data source is kafka, the file under the name of catalog is looked up. Md5: Optional. MD5 of the file. If specified, it will be checked after downloading the file. -'35;'35; example +## example 1. Create a file ca. pem, categorized as Kafka diff --git a/docs/documentation/en/sql-reference/sql-statements/Administration/DROP CLUSTER_EN.md b/docs/documentation/en/sql-reference/sql-statements/Administration/DROP CLUSTER_EN.md index 254a038dc70039..4915345d020412 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Administration/DROP CLUSTER_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Administration/DROP CLUSTER_EN.md @@ -1,5 +1,5 @@ # DROP CLUSTER -Description +## Description This statement is used to delete logical cluster. Successful deletion of logical cluster requires first deleting dB in the cluster and administrator privileges. @@ -7,7 +7,7 @@ grammar DROP CLUSTER [IF EXISTS] cluster_name -'35;'35; example +## example Delete logical cluster test_cluster diff --git a/docs/documentation/en/sql-reference/sql-statements/Administration/DROP FILE_EN.md b/docs/documentation/en/sql-reference/sql-statements/Administration/DROP FILE_EN.md index 77614532f2605c..90ea4c77e29137 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Administration/DROP FILE_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Administration/DROP FILE_EN.md @@ -1,5 +1,5 @@ # DROP FILE -Description +## Description This statement is used to delete an uploaded file. @@ -15,7 +15,7 @@ properties 支持以下参数: Catalog: Yes. Classification of documents. -'35;'35; example +## example 1. Delete the file ca.pem diff --git a/docs/documentation/en/sql-reference/sql-statements/Administration/ENTER_EN.md b/docs/documentation/en/sql-reference/sql-statements/Administration/ENTER_EN.md index 337ffb3ff62b18..2a2d9e0138b4f3 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Administration/ENTER_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Administration/ENTER_EN.md @@ -1,5 +1,5 @@ -ENTER -Description +# ENTER +## Description This statement is used to enter a logical cluster. All users and databases created need to be executed in a logical cluster. After creation, they belong to the logic. @@ -7,7 +7,7 @@ Cluster, need administrator privileges ENTER cluster name -'35;'35; example +## example 1. Enter the logical cluster test_cluster diff --git a/docs/documentation/en/sql-reference/sql-statements/Administration/LINK DATABASE_EN.md b/docs/documentation/en/sql-reference/sql-statements/Administration/LINK DATABASE_EN.md index 478e78f5c1e8aa..180cf50fa3f746 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Administration/LINK DATABASE_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Administration/LINK DATABASE_EN.md @@ -1,5 +1,5 @@ -'35; LINK DATABASE -Description +# LINK DATABASE +## Description This statement allows users to link a database of one logical cluster to another logical cluster. A database is only allowed to be linked once at the same time and the linked database is deleted. @@ -9,7 +9,7 @@ grammar LINK DATABASE src u cluster name.src db name of the cluster name.des db name -'35;'35; example +## example 1. Link test_db in test_cluster A to test_cluster B and name it link_test_db diff --git a/docs/documentation/en/sql-reference/sql-statements/Administration/MIGRATE DATABASE_EN.md b/docs/documentation/en/sql-reference/sql-statements/Administration/MIGRATE DATABASE_EN.md index 2b64b07f1d4a83..674b978fd69abd 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Administration/MIGRATE DATABASE_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Administration/MIGRATE DATABASE_EN.md @@ -1,5 +1,5 @@ # MIGRATE DATABASE -Description +## Description This statement is used to migrate a logical cluster database to another logical cluster. Before performing this operation, the database must be in a link state and need to be managed. @@ -9,7 +9,7 @@ grammar MIGRATE DATABASE src u cluster name.src db name of the cluster name.des db name -'35;'35; example +## example 1. 迁移test_clusterA中的test_db到test_clusterB diff --git a/docs/documentation/en/sql-reference/sql-statements/Administration/SHOW BACKENDS_EN.md b/docs/documentation/en/sql-reference/sql-statements/Administration/SHOW BACKENDS_EN.md index 7c146f51bbf398..05b610b5082768 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Administration/SHOW BACKENDS_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Administration/SHOW BACKENDS_EN.md @@ -1,5 +1,5 @@ # SHOW BACKENDS -Description +## Description This statement is used to view BE nodes in the cluster Grammar: SHOW BACKENDS; diff --git a/docs/documentation/en/sql-reference/sql-statements/Administration/SHOW BROKER_EN.md b/docs/documentation/en/sql-reference/sql-statements/Administration/SHOW BROKER_EN.md index 576ca117acf32c..00489a710938e2 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Administration/SHOW BROKER_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Administration/SHOW BROKER_EN.md @@ -1,5 +1,5 @@ # SHOW BROKER -Description +## Description This statement is used to view the existing broker Grammar: SHOW BROKER; diff --git a/docs/documentation/en/sql-reference/sql-statements/Administration/SHOW FILE_EN.md b/docs/documentation/en/sql-reference/sql-statements/Administration/SHOW FILE_EN.md index 239ef389b19808..9b8bb93c8015bb 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Administration/SHOW FILE_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Administration/SHOW FILE_EN.md @@ -1,5 +1,5 @@ # SHOW FILE -Description +## Description This statement is used to show a file created in a database @@ -16,7 +16,7 @@ FileName: File name FileSize: File size, unit byte MD5: Document MD5 -'35;'35; example +## example 1. View uploaded files in my_database diff --git a/docs/documentation/en/sql-reference/sql-statements/Administration/SHOW FRONTENDS_EN.md b/docs/documentation/en/sql-reference/sql-statements/Administration/SHOW FRONTENDS_EN.md index 9cb7379fdde63c..f08216b9780258 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Administration/SHOW FRONTENDS_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Administration/SHOW FRONTENDS_EN.md @@ -1,5 +1,5 @@ # SHOW FRONTENDS -Description +# Description This statement is used to view FE nodes Grammar: SHOW FRONTENDS; diff --git a/docs/documentation/en/sql-reference/sql-statements/Administration/SHOW MIGRATIONS_EN.md b/docs/documentation/en/sql-reference/sql-statements/Administration/SHOW MIGRATIONS_EN.md index dca606cff71635..cc98737040d194 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Administration/SHOW MIGRATIONS_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Administration/SHOW MIGRATIONS_EN.md @@ -1,5 +1,5 @@ # SHOW MIGRATIONS -Description +## Description This statement is used to view the progress of database migration diff --git a/docs/documentation/en/sql-reference/sql-statements/Administration/index.rst b/docs/documentation/en/sql-reference/sql-statements/Administration/index.rst new file mode 100644 index 00000000000000..29a3fe69ad79fd --- /dev/null +++ b/docs/documentation/en/sql-reference/sql-statements/Administration/index.rst @@ -0,0 +1,8 @@ +================== +Administration +================== + +.. toctree:: + :glob: + + * diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Definition/ALTER DATABASE_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Definition/ALTER DATABASE_EN.md index b4c436b2722cf9..79a8b957dd11ca 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Definition/ALTER DATABASE_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Definition/ALTER DATABASE_EN.md @@ -1,5 +1,5 @@ -'35; OLD DATABASE -Description +# ALTER DATABASE +## description This statement is used to set the properties of the specified database. (Administrators only) Grammar: 1) Setting database data quota in B/K/KB/M/MB/G/GB/T/TB/P/PB @@ -11,7 +11,7 @@ ALTER DATABASE db_name RENAME new_db_name; Explain: After renaming the database, use REVOKE and GRANT commands to modify the corresponding user rights if necessary. -'35;'35; example +## example 1. Setting the specified database data quota ALTER DATABASE example_db SET DATA QUOTA 10995116277760; The above units are bytes, equivalent to diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Definition/ALTER TABLE_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Definition/ALTER TABLE_EN.md index e8bec9f98c04fe..6a821d7a2a70ff 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Definition/ALTER TABLE_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Definition/ALTER TABLE_EN.md @@ -1,5 +1,5 @@ # ALTER TABLE -Description +## Description This statement is used to modify an existing table. If no rollup index is specified, the default operation is base index. 该语句分为三种操作类型： schema change 、rollup 、partition These three types of operations cannot appear in an ALTER TABLE statement at the same time. @@ -135,7 +135,7 @@ RENAME ROLLUP old_rollup_name new_rollup_name; Grammar: Rename old partition name and new partition name -'35;'35; example +## example [partition] 1. Increase partitions, existing partitions [MIN, 2013-01-01], increase partitions [2013-01-01, 2014-01-01], using default bucket partitioning ALTER TABLE example_db.my_table diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Definition/BACKUP_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Definition/BACKUP_EN.md index da56070feb03ef..d70a006159699d 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Definition/BACKUP_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Definition/BACKUP_EN.md @@ -1,5 +1,5 @@ # BACKUP -Description +## Description This statement is used to backup data under the specified database. This command is an asynchronous operation. After successful submission, you need to check progress through the SHOW BACKUP command. Only tables of OLAP type are backed up. Grammar: BACKUP SNAPSHOT [db_name].{snapshot_name} @@ -17,7 +17,7 @@ Explain: "Type" = "full": means that this is a full update (default). "Timeout" = "3600": Task timeout, default to one day. Unit seconds. -'35;'35; example +## example 1. Back up the table example_tbl under example_db in full to the warehouse example_repo: BACKUP SNAPSHOT example_db.snapshot_label1 diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Definition/CANCEL ALTER_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Definition/CANCEL ALTER_EN.md index d731bdc8a54609..2114244369ca6a 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Definition/CANCEL ALTER_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Definition/CANCEL ALTER_EN.md @@ -1,5 +1,5 @@ # CANCEL ALTER -Description +## Description This statement is used to undo an ALTER operation. 1. 撤销 ALTER TABLE COLUMN 操作 Grammar: @@ -16,7 +16,7 @@ Grammar: (To be realized... -'35;'35; example +## example [CANCEL ALTER TABLE COLUMN] 1. 撤销针对 my_table 的 ALTER COLUMN 操作。 CANCEL ALTER TABLE COLUMN diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Definition/CANCEL BACKUP_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Definition/CANCEL BACKUP_EN.md index 80cc609169a7b9..c853ed75f07b37 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Definition/CANCEL BACKUP_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Definition/CANCEL BACKUP_EN.md @@ -1,10 +1,10 @@ # CANCEL BACKUP -Description +## Description This statement is used to cancel an ongoing BACKUP task. Grammar: CANCEL BACKUP FROM db_name; -'35;'35; example +## example 1. Cancel the BACKUP task under example_db. CANCEL BACKUP FROM example_db; diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Definition/CANCEL RESTORE_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Definition/CANCEL RESTORE_EN.md index d83050468929ad..7e89d80b15f39c 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Definition/CANCEL RESTORE_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Definition/CANCEL RESTORE_EN.md @@ -1,5 +1,5 @@ # CANCEL RESTORE -Description +## Description This statement is used to cancel an ongoing RESTORE task. Grammar: CANCEL RESTORE FROM db_name; @@ -7,7 +7,7 @@ CANCEL RESTORE FROM db_name; Be careful: When the recovery is abolished around the COMMIT or later stage, the restored tables may be inaccessible. At this point, data recovery can only be done by performing the recovery operation again. -'35;'35; example +## example 1. Cancel the RESTORE task under example_db. CANCEL RESTORE FROM example_db; diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Definition/CREATE DATABASE_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Definition/CREATE DATABASE_EN.md index 57d598f7832f5a..a6d1fc34ce9dfb 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Definition/CREATE DATABASE_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Definition/CREATE DATABASE_EN.md @@ -1,10 +1,10 @@ # CREATE DATABASE -Description +## Description This statement is used to create a new database Grammar: CREATE DATABASE [IF NOT EXISTS] db_name; -'35;'35; example +## example 1. New database db_test CREATE DATABASE db_test; diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Definition/CREATE REPOSITORY_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Definition/CREATE REPOSITORY_EN.md index 29b39513f60d12..3bb1ce3819d672 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Definition/CREATE REPOSITORY_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Definition/CREATE REPOSITORY_EN.md @@ -1,5 +1,5 @@ # CREATE REPOSITORY -Description +## Description This statement is used to create the warehouse. The warehouse is used for backup or recovery. Only root or superuser users can create warehouses. Grammar: CREATE [READ ONLY] REPOSITORY `repo_name` @@ -12,7 +12,7 @@ Explain: 2. If it is a read-only warehouse, it can only be restored on the warehouse. If not, you can backup and restore operations. 3. According to the different types of broker, PROPERTIES is different, see the example. -'35;'35; example +## example 1. Create a warehouse named bos_repo, which relies on BOS broker "bos_broker", and the data root directory is: bos://palo_backup. CREATE REPOSITORY `bos_repo` WITH BROKER `bos_broker` diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Definition/CREATE TABLE_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Definition/CREATE TABLE_EN.md index a39d07cbe601bf..5338f088480d0e 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Definition/CREATE TABLE_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Definition/CREATE TABLE_EN.md @@ -1,5 +1,5 @@ # CREATE TABLE -Description +## Description This statement is used to create a table. Grammar: CREATE [EXTERNAL] TABLE [IF NOT EXISTS] [database.]table_name @@ -177,7 +177,7 @@ PROPERTIES ( "colocate_with"="table1" ) -'35;'35; example +## example 1. Create an OLAP table, use HASH buckets, use column storage, aggregate records of the same key CREATE TABLE example_db.table_hash ( diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Definition/CREATE VIEW_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Definition/CREATE VIEW_EN.md index dd8c2707f281e6..bdbe3bf118c7db 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Definition/CREATE VIEW_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Definition/CREATE VIEW_EN.md @@ -1,5 +1,5 @@ # CREATE VIEW -Description +## Description This statement is used to create a logical view Grammar: CREATE VIEW [IF NOT EXISTS] @@ -10,7 +10,7 @@ Explain: 1. Views are logical views without physical storage. All queries on views are equivalent to sub-queries corresponding to views. 2. Query_stmt is arbitrarily supported SQL -'35;'35; example +## example 1. Create view example_view on example_db CREATE VIEW example_db.example_view (k1, k2, k3, v1) AS diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Definition/Colocate Join_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Definition/Colocate Join_EN.md index 7ddf1ee25bfb2f..8781a77a1eac28 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Definition/Colocate Join_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Definition/Colocate Join_EN.md @@ -1,5 +1,5 @@ # Colocate Join -Description +## Description Colocate/Local Join means that when multiple nodes are Join, there is no data movement and network transmission, and each node is only Join locally. The premise of Join locally is to import data from the same Join Key into a fixed node according to the same rules. diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Definition/DROP DATABASE_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Definition/DROP DATABASE_EN.md index 70c91025de9b3f..c4bd9b6d0ada1d 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Definition/DROP DATABASE_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Definition/DROP DATABASE_EN.md @@ -1,5 +1,5 @@ # DROP DATABASE -Description +##Description This statement is used to delete the database Grammar: DROP DATABASE [IF EXISTS] db_name; @@ -7,7 +7,7 @@ DROP DATABASE [IF EXISTS] db_name; Explain: After executing DROP DATABASE for a period of time, the deleted database can be restored through the RECOVER statement. See RECOVER statement for details -'35;'35; example +## example 1. Delete database db_test DROP DATABASE db_test; diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Definition/DROP REPOSITORY_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Definition/DROP REPOSITORY_EN.md index 6a40cefefe757f..1f58ed81d7d292 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Definition/DROP REPOSITORY_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Definition/DROP REPOSITORY_EN.md @@ -1,5 +1,5 @@ # DROP REPOSITORY -Description +## Description This statement is used to delete a created warehouse. Only root or superuser users can delete the warehouse. Grammar: DROP REPOSITORY `repo_name`; @@ -7,7 +7,7 @@ DROP REPOSITORY `repo_name`; Explain: 1. Delete the warehouse, just delete the mapping of the warehouse in Palo, and do not delete the actual warehouse data. After deletion, you can map to the repository again by specifying the same broker and LOCATION. -'35;'35; example +## example 1. Delete the warehouse named bos_repo: DROP REPOSITORY `bos_repo`; diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Definition/DROP TABLE_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Definition/DROP TABLE_EN.md index 00b9e2261bb755..a56fbadbff4c7a 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Definition/DROP TABLE_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Definition/DROP TABLE_EN.md @@ -1,5 +1,5 @@ # DROP TABLE -Description +## Description This statement is used to delete the table. Grammar: DROP TABLE [IF EXISTS] [db_name.]table_name; @@ -7,7 +7,7 @@ DROP TABLE [IF EXISTS] [db_name.]table_name; Explain: After executing DROP TABLE for a period of time, the deleted table can be restored through the RECOVER statement. See RECOVER statement for details -'35;'35; example +## example 1. Delete a table DROP TABLE my_table; diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Definition/DROP VIEW_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Definition/DROP VIEW_EN.md index 697c9610ab9f1d..4fc864292fdc8f 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Definition/DROP VIEW_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Definition/DROP VIEW_EN.md @@ -1,11 +1,11 @@ # DROP VIEW -Description +## Description This statement is used to delete a logical view VIEW Grammar: DROP VIEW [IF EXISTS] [db_name.]view_name; -'35;'35; example +## example 1. If it exists, delete view example_view on example_db DROP VIEW IF EXISTS example_db.example_view; diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Definition/HLL_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Definition/HLL_EN.md index b66b040088f0c6..4061060964542b 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Definition/HLL_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Definition/HLL_EN.md @@ -1,5 +1,5 @@ # HLL -Description +## Description HLL is an engineering implementation based on the HyperLogLog algorithm. It is used to store the intermediate results of the HyperLog calculation process. It can only be used as the value column type of the table. By aggregating to reduce the amount of data continuously, in order to achieve the purpose of speeding up the query, based on which an estimated result, the error is about 1%. The HLL column is generated by other columns or data in the imported data. When imported, the hll_hash function is used to specify which column in the data is used to generate the HLL column. @@ -19,7 +19,7 @@ This function is used to estimate the cardinality of a single HLL sequence HLL_HASH(column_name) Generate HLL column types for insert or import, see the instructions for the use of imports -'35;'35; example +## example 1. First create a table with HLL columns create table test( dt date, diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Definition/RECOVER_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Definition/RECOVER_EN.md index a8f8eaa9696722..e2ffe006eba275 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Definition/RECOVER_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Definition/RECOVER_EN.md @@ -1,5 +1,5 @@ # RECOVER -Description +## Description This statement is used to restore previously deleted databases, tables, or partitions Grammar: 1)24674;"22797database; @@ -13,7 +13,7 @@ Explain: 1. This operation can only recover the meta-information deleted in the previous period of time. The default is 3600 seconds. 2. If new meta-information of the same name and type is created after deleting meta-information, the previously deleted meta-information cannot be restored. -'35;'35; example +## example 1. Restore the database named example_db RECOVER DATABASE example_db; diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Definition/RESTORE_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Definition/RESTORE_EN.md index f3cc3a551e85e6..5a76cf1d175b7a 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Definition/RESTORE_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Definition/RESTORE_EN.md @@ -1,5 +1,5 @@ -"35; RESTORE -Description +# RESTORE +## Description 1. RESTOR This statement is used to restore the data previously backed up by the BACKUP command to the specified database. This command is an asynchronous operation. After successful submission, you need to check progress through the SHOW RESTORE command. Restoring tables of OLAP type is supported only. Grammar: @@ -23,7 +23,7 @@ Explain: "Timeout" = "3600": Task timeout, default to one day. Unit seconds. "Meta_version" = 40: Use the specified meta_version to read the previously backed up metadata. Note that as a temporary solution, this parameter is only used to restore the data backed up by the older version of Doris. The latest version of the backup data already contains metaversion, no need to specify. -'35;'35; example +## example 1. Restore backup table backup_tbl in snapshot_1 from example_repo to database example_db1 with the time version of "2018-05-04-16-45-08". Restore to one copy: RESTORE SNAPSHOT example_db1.`snapshot_1` FROM `example 'u repo' diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Definition/TRUNCATE TABLE_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Definition/TRUNCATE TABLE_EN.md index 2d5057b29e7221..fdba36f35affb5 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Definition/TRUNCATE TABLE_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Definition/TRUNCATE TABLE_EN.md @@ -1,5 +1,5 @@ -'35; TRUNCATE TABLES -Description +# TRUNCATE TABLES +## Description This statement is used to empty the data of the specified table and partition Grammar: @@ -12,7 +12,7 @@ Explain: 4. The data deleted by this operation is not recoverable. 5. When using this command, the table state should be NORMAL, i.e. SCHEMA CHANGE operations are not allowed. -'35;'35; example +## example 1. Clear the table TBL under example_db diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Definition/create-function_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Definition/create-function_EN.md index 8bca1e552c19e4..8130fc116a2696 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Definition/create-function_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Definition/create-function_EN.md @@ -1,6 +1,6 @@ # CREATE FUNCTION -Description -'35;'35;' 35; Syntax +##Description +### Syntax ``` CREATE [AGGREGATE] FUNCTION function_name @@ -45,7 +45,7 @@ This statement creates a custom function. Executing this command requires that t If the `function_name'contains the database name, the custom function will be created in the corresponding database, otherwise the function will be created in the database where the current session is located. The name and parameters of the new function cannot be the same as functions already existing in the current namespace, otherwise the creation will fail. But only with the same name and different parameters can the creation be successful. -'35;'35; example +## example 1. Create a custom scalar function diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Definition/drop-function_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Definition/drop-function_EN.md index f4b31dea75c1e9..1f771a99bb6144 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Definition/drop-function_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Definition/drop-function_EN.md @@ -1,6 +1,6 @@ # DROP FUNCTION -Description -'35;'35;' 35; Syntax +##Description +### Syntax ``` DROP FUNCTION function_name @@ -17,7 +17,7 @@ DROP FUNCTION function_name Delete a custom function. The name of the function and the type of the parameter are exactly the same before they can be deleted. -'35;'35; example +## example 1. Delete a function diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Definition/index.rst b/docs/documentation/en/sql-reference/sql-statements/Data Definition/index.rst new file mode 100644 index 00000000000000..0e100c8758580f --- /dev/null +++ b/docs/documentation/en/sql-reference/sql-statements/Data Definition/index.rst @@ -0,0 +1,8 @@ +==================== +Data Definition +==================== + +.. toctree:: + :glob: + + * diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Definition/show-function_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Definition/show-function_EN.md index 0f09d88dc09b80..55555e0cebeb48 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Definition/show-function_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Definition/show-function_EN.md @@ -1,6 +1,6 @@ # SHOW FUNCTION -Description -'35;'35;' 35; Syntax +## Description +### Syntax ``` SHOW FUNCTION [FROM db] @@ -15,7 +15,7 @@ Look at all the custom functions under the database. If the user specifies the d You need `SHOW'privileges for this database -'35;'35; example +## example ``` mysql> show function in testDb\G diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/RESUME ROUTINE LOAD_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/RESUME ROUTINE LOAD_EN.md index 924297f1402cd4..ca120135bdfc99 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/RESUME ROUTINE LOAD_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/RESUME ROUTINE LOAD_EN.md @@ -1,5 +1,5 @@ # RESUME ROUTINE LOAD -'35;'35; example +## example 1. Restore the routine import job named test 1. diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/ROUTINE LOAD_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/ROUTINE LOAD_EN.md index dd677d0e9664ab..06d2ae66f8f10b 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/ROUTINE LOAD_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/ROUTINE LOAD_EN.md @@ -1,5 +1,5 @@ # ROUTINE LOAD -Description +## Description Routine Load enables users to submit a permanent import task and import data into Doris by constantly reading data from a specified data source. Currently only support importing text format (CSV) data from Kakfa through unauthenticated or SSL authentication. @@ -198,7 +198,7 @@ Date class (DATE/DATETIME): 2017-10-03, 2017-06-13 12:34:03. String class (CHAR/VARCHAR) (without quotation marks): I am a student, a NULL value: N -'35;'35; example +## example 1. Create a Kafka routine import task named test 1 for example_tbl of example_db. diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW ALTER_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW ALTER_EN.md index df1894fffd31f4..1e52aa39711fcc 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW ALTER_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW ALTER_EN.md @@ -1,5 +1,5 @@ # SHOW ALTER -Description +## Description This statement is used to show the execution of various modification tasks currently under way. Grammar: SHOW ALTER [CLUSTER | TABLE [COLUMN | ROLLUP] [FROM db_name]]; @@ -10,7 +10,7 @@ TABLE ROLLUP: Shows the task of creating or deleting ROLLUP index If db_name is not specified, use the current default DB CLUSTER: Show the cluster operation related tasks (only administrators use! To be realized... -'35;'35; example +## example 1. Show the task execution of all modified columns of default DB SHOW ALTER TABLE COLUMN; diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW BACKUP_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW BACKUP_EN.md index 7aadc834988e36..a0ff12abc0ee48 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW BACKUP_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW BACKUP_EN.md @@ -1,5 +1,5 @@ # SHOW BACKUP -Description +## Description This statement is used to view BACKUP tasks Grammar: SHOW BACKUP [FROM db_name] @@ -28,7 +28,7 @@ Unfinished Tasks: The unfinished sub-task ID is displayed in the SNAP HOTING and Status: Display failure information if the job fails Timeout: Job timeout, per second -'35;'35; example +## example 1. See the last BACKUP task under example_db. SHOW BACKUP FROM example_db; diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW DATABASES_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW DATABASES_EN.md index db9b072109fe72..5e25b414794b79 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW DATABASES_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW DATABASES_EN.md @@ -1,5 +1,5 @@ # SHOW DATABASES -Description +## Description This statement is used to show the currently visible DB Grammar: SHOW DATABASES; diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW DATA_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW DATA_EN.md index 6857c50452d07b..aee0feb80061e6 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW DATA_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW DATA_EN.md @@ -1,5 +1,5 @@ # SHOW DATA -Description +## Description This statement is used to show the amount of data Grammar: SHOW DATA [FROM db_name[.table_name]]; @@ -9,7 +9,7 @@ Explain: 2. If the FROM clause is specified, the amount of data subdivided into indices under the table is shown. 3. If you want to see the size of individual Partitions, see help show partitions -'35;'35; example +## example 1. Display the data volume and aggregate data volume of each table of default DB SHOW DATA; diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW DELETE_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW DELETE_EN.md index 6a6bdacea64259..15f6991db9aecc 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW DELETE_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW DELETE_EN.md @@ -1,10 +1,10 @@ # SHOW DELETE -Description +## Description This statement is used to show successful historical delete tasks performed Grammar: SHOW DELETE [FROM db_name] -'35;'35; example +## example 1. Show all historical delete tasks for database SHOW DELETE FROM database; diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW EXPORT_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW EXPORT_EN.md index 638429706b81f8..0cf2162f8ad971 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW EXPORT_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW EXPORT_EN.md @@ -1,5 +1,5 @@ # SHOW EXPORT -Description +## Description This statement is used to show the execution of the specified export task Grammar: SHOW EXPORT @@ -18,7 +18,7 @@ Explain: 3) Any column combination can be sorted using ORDER BY 4) If LIMIT is specified, the limit bar matching record is displayed. Otherwise, all of them will be displayed. -'35;'35; example +## example 1. Show all export tasks of default DB SHOW EXPORT; diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW LOAD_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW LOAD_EN.md index 2cf1b024547430..2b8cbb2f30b359 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW LOAD_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW LOAD_EN.md @@ -1,5 +1,5 @@ # SHOW LOAD -Description +## Description This statement is used to show the execution of the specified import task Grammar: SHOW LOAD @@ -24,7 +24,7 @@ Explain: SHOW LOAD WARNINGS ON 'url' -'35;'35; example +## example 1. Show all import tasks of default DB SHOW LOAD; diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW PARTITIONS_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW PARTITIONS_EN.md index 4e0dbb933054db..fe40cdb4828958 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW PARTITIONS_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW PARTITIONS_EN.md @@ -1,10 +1,10 @@ # SHOW PARTITIONS -Description +## Description This statement is used to display partition information Grammar: SHOW PARTITIONS FROM [db_name.]table_name [PARTITION partition_name]; -'35;'35; example +## example 1. Display partition information for the specified table below the specified DB SHOW PARTITIONS FROM example_db.table_name; diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW PROPERTY_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW PROPERTY_EN.md index 44b94b79491d1b..61b138b0ecd6b0 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW PROPERTY_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW PROPERTY_EN.md @@ -1,10 +1,10 @@ # SHOW PROPERTY -Description +## Description This statement is used to view user attributes Grammar: SHOW PROPERTY [FOR user] [LIKE key] -'35;'35; example +## example 1. View the attributes of the jack user SHOW PROPERTY FOR 'jack' diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW REPOSITORIES_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW REPOSITORIES_EN.md index 286670a84aa566..15f95af05f4f7d 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW REPOSITORIES_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW REPOSITORIES_EN.md @@ -1,5 +1,5 @@ # SHOW REPOSITORIES -Description +## Description This statement is used to view the currently created warehouse. Grammar: SHOW REPOSITORIES; @@ -14,7 +14,7 @@ Location: The root directory in the repository for backing up data Broker: Dependent Broker ErrMsg: Palo regularly checks the connectivity of the warehouse, and if problems occur, error messages are displayed here. -'35;'35; example +## example 1. View the warehouse that has been created: SHOW REPOSITORIES; diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW RESTORE_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW RESTORE_EN.md index d7d1b5cbc12714..d957d7e812bef6 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW RESTORE_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW RESTORE_EN.md @@ -1,5 +1,5 @@ # SHOW RESTORE -Description +## Description This statement is used to view RESTORE tasks Grammar: SHOW RESTORE [FROM db_name] @@ -32,7 +32,7 @@ Unfinished Tasks: The unfinished sub-task ID is displayed in the SNAP HOTING, DO Status: Display failure information if the job fails Timeout: Job timeout, per second -'35;'35; example +## example 1. Check the last RESTORE task under example_db. SHOW RESTORE FROM example_db; diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW ROUTINE LOAD TASK_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW ROUTINE LOAD TASK_EN.md index e1c4f7adcecbe9..687c18793b7642 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW ROUTINE LOAD TASK_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW ROUTINE LOAD TASK_EN.md @@ -1,5 +1,5 @@ # SHOW ROUTINE LOAD TASK -'35;'35; example +## example 1. Show sub-task information for a routine import task called test 1. diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW ROUTINE LOAD_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW ROUTINE LOAD_EN.md index b4723dcde6c321..e19939166d6f91 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW ROUTINE LOAD_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW ROUTINE LOAD_EN.md @@ -1,5 +1,5 @@ # SHOW ROUTINE LOAD -'35;'35; example +## example 1. Show all routine import jobs named test 1 (including stopped or cancelled jobs). The result is one or more lines. diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW SNAPSHOT_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW SNAPSHOT_EN.md index 5eeef7b296d556..a48d665acd99b9 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW SNAPSHOT_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW SNAPSHOT_EN.md @@ -1,5 +1,5 @@ # SHOW SNAPSHOT -Description +## Description This statement is used to view existing backups in the warehouse. Grammar: SHOW SNAPSHOT ON `repo_name` diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW TABLES_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW TABLES_EN.md index 1bc7aaf9de66ef..2e1213bfc5db55 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW TABLES_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW TABLES_EN.md @@ -1,5 +1,5 @@ # SHOW TABLES -Description +## Description This statement is used to show all tables under the current DB Grammar: SHOW TABLES; diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW TABLET_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW TABLET_EN.md index 0bd827cfbe0f7b..59bb40234cafba 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW TABLET_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/SHOW TABLET_EN.md @@ -1,11 +1,11 @@ # SHOW TABLET -Description +## Description This statement is used to display tablet-related information (for administrators only) Grammar: SHOW TABLET [From [db-uu name]] table U name.; Table U Id] -'35;'35; example +## example 1. Display all tablet information in the specified table below the specified DB SHOW TABLET FROM example_db.table_name; diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/STOP ROUTINE LOAD_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/STOP ROUTINE LOAD_EN.md index 3860ea34ec453d..c7d4f1fc3f9f8d 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/STOP ROUTINE LOAD_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/STOP ROUTINE LOAD_EN.md @@ -1,5 +1,5 @@ # STOP ROUTINE LOAD -'35;'35; example +## example 1. Stop the routine import job named test 1. diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/STREAM LOAD_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/STREAM LOAD_EN.md index 7c4efcc03e96b1..53354613ec9c12 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/STREAM LOAD_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/STREAM LOAD_EN.md @@ -1,5 +1,5 @@ # STREAM LOAD -Description +## Description NAME: stream-load: load data to table in streaming @@ -64,7 +64,7 @@ SHOW LOAD WARNINGS ON 'url' The URL is the URL given by Error URL. -'35;'35; example +## example 1. Import the data from the local file'testData'into the table'testTbl' in the database'testDb', and use Label for de-duplication. curl --location-trusted -u root -H "label:123" -T testData http://host:port/api/testDb/testTbl/_stream_load diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/index.rst b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/index.rst new file mode 100644 index 00000000000000..92dd5a72cadf92 --- /dev/null +++ b/docs/documentation/en/sql-reference/sql-statements/Data Manipulation/index.rst @@ -0,0 +1,8 @@ +====================== +Data Manipulation +====================== + +.. toctree:: + :glob: + + * diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Types/BIGINT_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Types/BIGINT_EN.md index 423ab66b49fcc9..e98ab8e08b9e79 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Types/BIGINT_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Types/BIGINT_EN.md @@ -1,5 +1,5 @@ -35; BIGINT -Description +# BIGINT +## Description BIGINT 8-byte signed integer, range [-9223372036854775808, 9223372036854775807] diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Types/BOOLEAN_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Types/BOOLEAN_EN.md index 80bf1892ea0d9a..24be83fd463665 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Types/BOOLEAN_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Types/BOOLEAN_EN.md @@ -1,5 +1,5 @@ # BOOLEAN -Description +## Description BOOL, BOOLEN Like TINYINT, 0 stands for false and 1 for true. diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Types/CHAR_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Types/CHAR_EN.md index a7c00f14274dbd..716e3bec00be3b 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Types/CHAR_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Types/CHAR_EN.md @@ -1,5 +1,5 @@ # CHAR -Description +## Description CHAR(M) A fixed-length string, M represents the length of a fixed-length string. The range of M is 1-255. diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Types/DATETIME_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Types/DATETIME_EN.md index 052e0d664b65b4..646b39778c79df 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Types/DATETIME_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Types/DATETIME_EN.md @@ -1,5 +1,5 @@ -DATETIME -Description +# DATETIME +## Description DATETIME Date and time type, value range is ['1000-01-01 00:00:00','9999-12-31 23:59:59']. The form of printing is'YYYY-MM-DD HH:MM:SS' diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Types/DATE_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Types/DATE_EN.md index 2edc00ec82d29d..bf087c8b08b6e7 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Types/DATE_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Types/DATE_EN.md @@ -1,5 +1,5 @@ -date -Description +# date +## Description DATE function Syntax: Date @@ -7,7 +7,7 @@ Convert input type to DATE type date Date type, the current range of values is ['1900-01-01','9999-12-31'], and the default print form is'YYYYY-MM-DD'. -'35;'35; example +## example mysql> SELECT DATE('2003-12-31 01:02:03'); -> '2003-12-31' diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Types/DECIMAL_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Types/DECIMAL_EN.md index cf8ef08387a5cf..6b61c83ed490d0 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Types/DECIMAL_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Types/DECIMAL_EN.md @@ -1,5 +1,5 @@ -'35; DECIMAL -Description +# DECIMAL +## Description DECIMAL (M [,D]) High-precision fixed-point, M stands for the total number of significant numbers (precision), D stands for the maximum number of decimal points (scale) The range of M is [1,27], the range of D is [1,9], in addition, M must be greater than or equal to the value of D. The default value of D is 0. diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Types/DOUBLE_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Types/DOUBLE_EN.md index df853cf4f099b4..e1fc72094b9153 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Types/DOUBLE_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Types/DOUBLE_EN.md @@ -1,5 +1,5 @@ - -Description +# Double +## Description DOUBLE 8-byte floating point number diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Types/FLOAT_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Types/FLOAT_EN.md index eb76968e449869..bf537eecd2af19 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Types/FLOAT_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Types/FLOAT_EN.md @@ -1,5 +1,5 @@ # FLOAT -Description +## Description FLOAT 4-byte floating point number diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Types/HLL(HyperLogLog)_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Types/HLL(HyperLogLog)_EN.md index 9c011b2ff26ada..d1197469831573 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Types/HLL(HyperLogLog)_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Types/HLL(HyperLogLog)_EN.md @@ -1,5 +1,5 @@ -HLL (Hyloglog) -Description +#HLL (Hyloglog) +## Description MARKETING (M) A variable length string, M represents the length of a variable length string. The range of M is 1-16385. Users do not need to specify length and default values. Length is controlled within the system according to the aggregation degree of data diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Types/INT_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Types/INT_EN.md index 82d88429fc50f9..aa9f00474afa84 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Types/INT_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Types/INT_EN.md @@ -1,5 +1,5 @@ # INT -Description +## Description INT 4-byte signed integer, range [-2147483648, 2147483647] diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Types/SMALLINT_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Types/SMALLINT_EN.md index dbbf8a12ed63d6..be374dfc02b5bf 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Types/SMALLINT_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Types/SMALLINT_EN.md @@ -1,5 +1,5 @@ -SMALLINT -Description +# SMALLINT +## Description SMALLINT 2-byte signed integer, range [-32768, 32767] diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Types/TINYINT_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Types/TINYINT_EN.md index b71c9c64a32314..4f943be4695eef 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Types/TINYINT_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Types/TINYINT_EN.md @@ -1,5 +1,5 @@ # TINYINT -Description +## Description TINYINT 1 byte signed integer, range [-128, 127] diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Types/VARCHAR_EN.md b/docs/documentation/en/sql-reference/sql-statements/Data Types/VARCHAR_EN.md index ef25a6b522b876..19d601477f410b 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Data Types/VARCHAR_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Data Types/VARCHAR_EN.md @@ -1,5 +1,5 @@ -"35; VARCHAR -Description +# VARCHAR +## Description MARKETING (M) A variable length string, M represents the length of a variable length string. The range of M is 1-65535. diff --git a/docs/documentation/en/sql-reference/sql-statements/Data Types/index.rst b/docs/documentation/en/sql-reference/sql-statements/Data Types/index.rst new file mode 100644 index 00000000000000..f2ead57ce5559f --- /dev/null +++ b/docs/documentation/en/sql-reference/sql-statements/Data Types/index.rst @@ -0,0 +1,8 @@ +============= +Data Types +============= + +.. toctree:: + :glob: + + * diff --git a/docs/documentation/en/sql-reference/sql-statements/Utility/index.rst b/docs/documentation/en/sql-reference/sql-statements/Utility/index.rst new file mode 100644 index 00000000000000..d00fb23d05ae9d --- /dev/null +++ b/docs/documentation/en/sql-reference/sql-statements/Utility/index.rst @@ -0,0 +1,8 @@ +============= +Utility +============= + +.. toctree:: + :glob: + + * diff --git a/docs/documentation/en/sql-reference/sql-statements/Utility/util_stmt_EN.md b/docs/documentation/en/sql-reference/sql-statements/Utility/util_stmt_EN.md index 06511e76e41ebb..6ad9277896ce66 100644 --- a/docs/documentation/en/sql-reference/sql-statements/Utility/util_stmt_EN.md +++ b/docs/documentation/en/sql-reference/sql-statements/Utility/util_stmt_EN.md @@ -1,5 +1,5 @@ -35; Description -Description +# Describe +## Description This statement is used to display schema information for the specified table Grammar: DESC [FISH] [dbu name.]table name [ALL]; @@ -7,7 +7,7 @@ DESC [FISH] [dbu name.]table name [ALL]; Explain: If ALL is specified, the schema of all indexes of the table is displayed -'35;'35; example +## example ## keyword DESCRIBE,DESC diff --git a/docs/documentation/en/sql-reference/sql-statements/index.rst b/docs/documentation/en/sql-reference/sql-statements/index.rst index 4f3490142cc122..b968ec022c7acf 100644 --- a/docs/documentation/en/sql-reference/sql-statements/index.rst +++ b/docs/documentation/en/sql-reference/sql-statements/index.rst @@ -1,8 +1,13 @@ -============ -DDL 语句 -============ +================== +DDL Statements +================== .. toctree:: - :glob: + :hidden: - * + Account Management/index + Administration/index + Data Definition/index + Data Manipulation/index + Data Types/index + Utility/index diff --git a/docs/website/build_site.sh b/docs/website/build_site.sh index efbca852a0b0f3..5751c8de1323e8 100644 --- a/docs/website/build_site.sh +++ b/docs/website/build_site.sh @@ -75,15 +75,12 @@ if [[ ${HELP} -eq 1 ]]; then fi -if [ ${BUILD_CN} -eq 1 ] ; then - rm -rf ${CUR}/source/Docs/* - rm -rf ${CUR}/source/resources/ - cp -r ${DORIS_HOME}/docs/documentation/cn/ ${CUR}/source/Docs/ - cp -r ${DORIS_HOME}/docs/resources/ ${CUR}/source/ - - make clean && make html -elif [ ${BUILD_EN} -eq 1 ] ; then - echo "not implemented yet" - exit 1 -fi +rm -rf ${CUR}/source/Docs/* +rm -rf ${CUR}/source/resources/ +mkdir -p ${CUR}/source/Docs/cn +mkdir -p ${CUR}/source/Docs/en +cp -r ${DORIS_HOME}/docs/documentation/cn/ ${CUR}/source/Docs/cn/ +cp -r ${DORIS_HOME}/docs/documentation/en/ ${CUR}/source/Docs/en/ +cp -r ${DORIS_HOME}/docs/resources/ ${CUR}/source/resources/ +make clean && make html diff --git a/docs/website/source/index.rst b/docs/website/source/index.rst index 22253b5ba8228b..1d54385d778088 100644 --- a/docs/website/source/index.rst +++ b/docs/website/source/index.rst @@ -157,7 +157,7 @@ increased response latency. For example, Hive metadata query latency is sometimes up to tens of seconds or even minutes. In order to speedup the metadata access, we adopt the in-memory catalog storage. -.. figure:: ./resources/iamges/log_replication.jpg +.. figure:: ./resources/images/log_replication.jpg :alt: log replication log replication @@ -586,10 +586,5 @@ downstream systems for further processing. .. toctree:: :hidden: - Docs/cn/installing/index - Docs/cn/getting-started/index - Docs/cn/administrator-guide/index - Docs/cn/extending-doris/index - Docs/cn/internal/index - Docs/cn/sql-reference/index - Docs/cn/community/index + Docs/cn/index + Docs/en/index