This is an automated email from the ASF dual-hosted git repository.
morningman pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/doris-website.git
The following commit(s) were added to refs/heads/master by this push:
new 8f4e06feeea Updated the instructions for using sql-converter (#1144)
8f4e06feeea is described below
commit 8f4e06feeeaf3df8c0bdc22fb10be2c5fcb8b0bb
Author: Jiwen liu <[email protected]>
AuthorDate: Fri Sep 27 22:45:31 2024 +0800
Updated the instructions for using sql-converter (#1144)
# Versions
- [x] dev
- [x] 3.0
- [x] 2.1
- [ ] 2.0
# Languages
- [x] Chinese
- [x] English
---
docs/lakehouse/sql-dialect.md | 32 +++++++++++++++++-----
.../current/lakehouse/sql-dialect.md | 27 ++++++++++++++----
.../version-2.1/lakehouse/sql-dialect.md | 27 ++++++++++++++----
.../version-3.0/lakehouse/sql-dialect.md | 27 ++++++++++++++----
.../version-2.1/lakehouse/sql-dialect.md | 32 +++++++++++++++++-----
.../version-3.0/lakehouse/sql-dialect.md | 32 +++++++++++++++++-----
6 files changed, 141 insertions(+), 36 deletions(-)
diff --git a/docs/lakehouse/sql-dialect.md b/docs/lakehouse/sql-dialect.md
index 7f3c9ddd26d..3dc6b2f6e30 100644
--- a/docs/lakehouse/sql-dialect.md
+++ b/docs/lakehouse/sql-dialect.md
@@ -1,6 +1,6 @@
---
{
- "title": "SQL Dialect Convertor",
+ "title": "SQL Converter for Apache Doris",
"language": "en"
}
---
@@ -36,7 +36,8 @@ This function is currently an experimental function. If you
encounter any proble
## Deploy service
-1. Download latest [Doris SQL
Convertor](https://www.selectdb.com/tools/doris-sql-convertor)
+1. Download latest [SQL Converter for Apache
Doris](https://www.selectdb.com/tools/doris-sql-convertor)
+
:::info NOTE
The SQL dialect conversion tool is based on the open-source
[SQLGlot](https://github.com/tobymao/sqlglot) and has been further developed by
SelectDB. For more information about SQLGlot, please refer to the [SQLGlot
official website](https://sqlglot.com/sqlglot.html).
@@ -45,11 +46,28 @@ The SQL Convertor is not maintained or endorsed by Apache
Doris; these efforts a
2. On any FE node, start the service through the following command:
- `sh bin/start.sh`
+ ```shell
+ # Configuring the service port
+ vim apiserver/conf/config.conf
+ # Start the SQL Converter for Apache Doris conversion service
+ sh apiserver/bin/start.sh
+ # If you need a front-end interface, you can configure the corresponding
port in the webserver and start it. If you don't need a front-end, you can
ignore the following operations.
+ vim webserver/conf/config.conf
+ # Start the front-end interface
+ sh webserver/bin/start.sh
+ ```
- - This service is a stateless service and can be started and stopped at
any time.
- - The default startup port is `5001`, and the specified port can be
configured in `conf/config.conf`.
- - It is recommended to start a separate service on each FE node.
+
+ :::tip
+ 1. This service is a stateless service and can be started and stopped
at any time.
+
+ 2. Configure port in `apiserver/conf/config.conf` to specify any
available port, and configure workers to specify the number of threads to
start. In concurrent scenarios, you can adjust as needed, the default is 1.
+
+ 3. It is recommended to start a separate service on each FE node.
+
+ 4. If you need to start the front-end interface, you can configure the SQL
Converter for Apache Doris conversion service address in
`webserver/conf/config`.conf. The default is `API_HOST=http://127.0.0.1:5001`
+ :::
+
3. Start the Doris cluster (version 2.1 or higher)
4. Set the URL of the SQL Dialect Conversion Service with the following
command in Doris:
@@ -64,10 +82,10 @@ Currently supported dialect types include:
- `presto`
- `trino`
+- `clickhouse`
- `hive`
- `spark`
- `postgres`
-- `clickhouse`
- `oracle`
example:
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/sql-dialect.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/sql-dialect.md
index b58a805f305..a2cac63a2f9 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/sql-dialect.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/sql-dialect.md
@@ -45,13 +45,28 @@ under the License.
2. 在任意 FE 节点，通过以下命令启动服务：
- `sh bin/start.sh`
+ ```shell
+ # 配置服务端口
+ vim apiserver/conf/config.conf
+ # 启动 SQL Converter for Apache Doris 转换服务
+ sh apiserver/bin/start.sh
+ # 如需前端界面, 可在 webserver 中配置相应的端口并启动, 不需要前端则可以忽略以下操作
+ vim webserver/conf/config.conf
+ # 启动前端界面
+ sh webserver/bin/start.sh
+ ```
- - 该服务是一个无状态的服务，可随时启停。
- - 默认启动端口是`5001`，可在`conf/config.conf`中配置指定端口。
+ :::tip
- - 建议在每个 FE 节点都单独启动一个服务。
+ 1. 该服务是一个无状态的服务, 可随时启停
+
+ 2. 在 `apiserver/conf/config.conf` 中配置 port 来指定任意一个可用端口, 配置 workers
来指定启动的线程数量. 在并发场景中, 可以根据需要调整, 默认为 1
+
+ 3. 建议在每个 FE 节点都单独启动一个服务
+
+ 4. 如需启动前端界面, 可以在 `webserver/conf/config.conf` 中配置 SQL Converter for Apache
Doris 转换服务地址, 默认是 `API_HOST=http://127.0.0.1:5001`
+ :::
3. 启动 Doris 集群（2.1 或更高版本）
@@ -69,13 +84,15 @@ under the License.
- `trino`
+- `clickhouse`
+
- `hive`
- `spark`
- `postgres`
-- `clickhouse`
+
示例：
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/lakehouse/sql-dialect.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/lakehouse/sql-dialect.md
index b58a805f305..a2cac63a2f9 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/lakehouse/sql-dialect.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/lakehouse/sql-dialect.md
@@ -45,13 +45,28 @@ under the License.
2. 在任意 FE 节点，通过以下命令启动服务：
- `sh bin/start.sh`
+ ```shell
+ # 配置服务端口
+ vim apiserver/conf/config.conf
+ # 启动 SQL Converter for Apache Doris 转换服务
+ sh apiserver/bin/start.sh
+ # 如需前端界面, 可在 webserver 中配置相应的端口并启动, 不需要前端则可以忽略以下操作
+ vim webserver/conf/config.conf
+ # 启动前端界面
+ sh webserver/bin/start.sh
+ ```
- - 该服务是一个无状态的服务，可随时启停。
- - 默认启动端口是`5001`，可在`conf/config.conf`中配置指定端口。
+ :::tip
- - 建议在每个 FE 节点都单独启动一个服务。
+ 1. 该服务是一个无状态的服务, 可随时启停
+
+ 2. 在 `apiserver/conf/config.conf` 中配置 port 来指定任意一个可用端口, 配置 workers
来指定启动的线程数量. 在并发场景中, 可以根据需要调整, 默认为 1
+
+ 3. 建议在每个 FE 节点都单独启动一个服务
+
+ 4. 如需启动前端界面, 可以在 `webserver/conf/config.conf` 中配置 SQL Converter for Apache
Doris 转换服务地址, 默认是 `API_HOST=http://127.0.0.1:5001`
+ :::
3. 启动 Doris 集群（2.1 或更高版本）
@@ -69,13 +84,15 @@ under the License.
- `trino`
+- `clickhouse`
+
- `hive`
- `spark`
- `postgres`
-- `clickhouse`
+
示例：
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/lakehouse/sql-dialect.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/lakehouse/sql-dialect.md
index b58a805f305..a2cac63a2f9 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/lakehouse/sql-dialect.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/lakehouse/sql-dialect.md
@@ -45,13 +45,28 @@ under the License.
2. 在任意 FE 节点，通过以下命令启动服务：
- `sh bin/start.sh`
+ ```shell
+ # 配置服务端口
+ vim apiserver/conf/config.conf
+ # 启动 SQL Converter for Apache Doris 转换服务
+ sh apiserver/bin/start.sh
+ # 如需前端界面, 可在 webserver 中配置相应的端口并启动, 不需要前端则可以忽略以下操作
+ vim webserver/conf/config.conf
+ # 启动前端界面
+ sh webserver/bin/start.sh
+ ```
- - 该服务是一个无状态的服务，可随时启停。
- - 默认启动端口是`5001`，可在`conf/config.conf`中配置指定端口。
+ :::tip
- - 建议在每个 FE 节点都单独启动一个服务。
+ 1. 该服务是一个无状态的服务, 可随时启停
+
+ 2. 在 `apiserver/conf/config.conf` 中配置 port 来指定任意一个可用端口, 配置 workers
来指定启动的线程数量. 在并发场景中, 可以根据需要调整, 默认为 1
+
+ 3. 建议在每个 FE 节点都单独启动一个服务
+
+ 4. 如需启动前端界面, 可以在 `webserver/conf/config.conf` 中配置 SQL Converter for Apache
Doris 转换服务地址, 默认是 `API_HOST=http://127.0.0.1:5001`
+ :::
3. 启动 Doris 集群（2.1 或更高版本）
@@ -69,13 +84,15 @@ under the License.
- `trino`
+- `clickhouse`
+
- `hive`
- `spark`
- `postgres`
-- `clickhouse`
+
示例：
diff --git a/versioned_docs/version-2.1/lakehouse/sql-dialect.md
b/versioned_docs/version-2.1/lakehouse/sql-dialect.md
index 7f3c9ddd26d..3dc6b2f6e30 100644
--- a/versioned_docs/version-2.1/lakehouse/sql-dialect.md
+++ b/versioned_docs/version-2.1/lakehouse/sql-dialect.md
@@ -1,6 +1,6 @@
---
{
- "title": "SQL Dialect Convertor",
+ "title": "SQL Converter for Apache Doris",
"language": "en"
}
---
@@ -36,7 +36,8 @@ This function is currently an experimental function. If you
encounter any proble
## Deploy service
-1. Download latest [Doris SQL
Convertor](https://www.selectdb.com/tools/doris-sql-convertor)
+1. Download latest [SQL Converter for Apache
Doris](https://www.selectdb.com/tools/doris-sql-convertor)
+
:::info NOTE
The SQL dialect conversion tool is based on the open-source
[SQLGlot](https://github.com/tobymao/sqlglot) and has been further developed by
SelectDB. For more information about SQLGlot, please refer to the [SQLGlot
official website](https://sqlglot.com/sqlglot.html).
@@ -45,11 +46,28 @@ The SQL Convertor is not maintained or endorsed by Apache
Doris; these efforts a
2. On any FE node, start the service through the following command:
- `sh bin/start.sh`
+ ```shell
+ # Configuring the service port
+ vim apiserver/conf/config.conf
+ # Start the SQL Converter for Apache Doris conversion service
+ sh apiserver/bin/start.sh
+ # If you need a front-end interface, you can configure the corresponding
port in the webserver and start it. If you don't need a front-end, you can
ignore the following operations.
+ vim webserver/conf/config.conf
+ # Start the front-end interface
+ sh webserver/bin/start.sh
+ ```
- - This service is a stateless service and can be started and stopped at
any time.
- - The default startup port is `5001`, and the specified port can be
configured in `conf/config.conf`.
- - It is recommended to start a separate service on each FE node.
+
+ :::tip
+ 1. This service is a stateless service and can be started and stopped
at any time.
+
+ 2. Configure port in `apiserver/conf/config.conf` to specify any
available port, and configure workers to specify the number of threads to
start. In concurrent scenarios, you can adjust as needed, the default is 1.
+
+ 3. It is recommended to start a separate service on each FE node.
+
+ 4. If you need to start the front-end interface, you can configure the SQL
Converter for Apache Doris conversion service address in
`webserver/conf/config`.conf. The default is `API_HOST=http://127.0.0.1:5001`
+ :::
+
3. Start the Doris cluster (version 2.1 or higher)
4. Set the URL of the SQL Dialect Conversion Service with the following
command in Doris:
@@ -64,10 +82,10 @@ Currently supported dialect types include:
- `presto`
- `trino`
+- `clickhouse`
- `hive`
- `spark`
- `postgres`
-- `clickhouse`
- `oracle`
example:
diff --git a/versioned_docs/version-3.0/lakehouse/sql-dialect.md
b/versioned_docs/version-3.0/lakehouse/sql-dialect.md
index 7f3c9ddd26d..3dc6b2f6e30 100644
--- a/versioned_docs/version-3.0/lakehouse/sql-dialect.md
+++ b/versioned_docs/version-3.0/lakehouse/sql-dialect.md
@@ -1,6 +1,6 @@
---
{
- "title": "SQL Dialect Convertor",
+ "title": "SQL Converter for Apache Doris",
"language": "en"
}
---
@@ -36,7 +36,8 @@ This function is currently an experimental function. If you
encounter any proble
## Deploy service
-1. Download latest [Doris SQL
Convertor](https://www.selectdb.com/tools/doris-sql-convertor)
+1. Download latest [SQL Converter for Apache
Doris](https://www.selectdb.com/tools/doris-sql-convertor)
+
:::info NOTE
The SQL dialect conversion tool is based on the open-source
[SQLGlot](https://github.com/tobymao/sqlglot) and has been further developed by
SelectDB. For more information about SQLGlot, please refer to the [SQLGlot
official website](https://sqlglot.com/sqlglot.html).
@@ -45,11 +46,28 @@ The SQL Convertor is not maintained or endorsed by Apache
Doris; these efforts a
2. On any FE node, start the service through the following command:
- `sh bin/start.sh`
+ ```shell
+ # Configuring the service port
+ vim apiserver/conf/config.conf
+ # Start the SQL Converter for Apache Doris conversion service
+ sh apiserver/bin/start.sh
+ # If you need a front-end interface, you can configure the corresponding
port in the webserver and start it. If you don't need a front-end, you can
ignore the following operations.
+ vim webserver/conf/config.conf
+ # Start the front-end interface
+ sh webserver/bin/start.sh
+ ```
- - This service is a stateless service and can be started and stopped at
any time.
- - The default startup port is `5001`, and the specified port can be
configured in `conf/config.conf`.
- - It is recommended to start a separate service on each FE node.
+
+ :::tip
+ 1. This service is a stateless service and can be started and stopped
at any time.
+
+ 2. Configure port in `apiserver/conf/config.conf` to specify any
available port, and configure workers to specify the number of threads to
start. In concurrent scenarios, you can adjust as needed, the default is 1.
+
+ 3. It is recommended to start a separate service on each FE node.
+
+ 4. If you need to start the front-end interface, you can configure the SQL
Converter for Apache Doris conversion service address in
`webserver/conf/config`.conf. The default is `API_HOST=http://127.0.0.1:5001`
+ :::
+
3. Start the Doris cluster (version 2.1 or higher)
4. Set the URL of the SQL Dialect Conversion Service with the following
command in Doris:
@@ -64,10 +82,10 @@ Currently supported dialect types include:
- `presto`
- `trino`
+- `clickhouse`
- `hive`
- `spark`
- `postgres`
-- `clickhouse`
- `oracle`
example:
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
