Skip to content

[docs](typo) Correct typos in kyuubi doc #17672

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
luzhijing merged 1 commit into from
Mar 11, 2023
Merged

[docs](typo) Correct typos in kyuubi doc #17672

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions docs/en/docs/ecosystem/kyuubi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ under the License.

[Apache Kyuubi](https://kyuubi.apache.org/) is a distributed and multi-tenant gateway to provide serverless SQL on Data
Warehouses and Lakehouses.
Apache Kyuubi is providing varied protocols like Thrift, Trino and etc., to the engines as Spark, Flink, Hive, JDBC and
etc.
Drois is supported as JDBC data source in Apache Kyuubi.
Apache Kyuubi also provides a serious useful feature with HA, service discovry,
unified authentication, engine lifecycles and etc.
Apache Kyuubi is providing varied protocols like Thrift, Trino, MySQL etc., to the engines including Spark, Flink, Hive,
JDBC, etc.
Doris could be connected as JDBC data source with Doris dialect supported in Apache Kyuubi.
Apache Kyuubi also provides a series of useful features including HA, service discovery,
unified authentication, engine lifecycle management, etc.

## Usage

Expand All @@ -61,33 +61,33 @@ kyuubi.engine.jdbc.connection.password=***

| Configuration | Description |
|----------------------------------------|---------------------------------------------------------------|
| kyuubi.engine.type | Enine Type, specify to `jdbc` |
| kyuubi.engine.type | Engine Type, specify to `jdbc` |
| kyuubi.engine.jdbc.type | JDBC service type, specify to `doris` |
| kyuubi.engine.jdbc.driver.class | JDBC driver class name, specify to `com.mysql.cj.jdbc.Driver` |
| kyuubi.engine.jdbc.connection.url | JDBC url to Doris FE |
| kyuubi.engine.jdbc.connection.user | JDBC username |
| kyuubi.engine.jdbc.connection.password | JDBC password |
| kyuubi.engine.jdbc.driver.class | JDBC driver class name, specify to `com.mysql.cj.jdbc.Driver` |

- For other configuration in Apache Kyuubi, please refer
to [Apache Kyuubi Configuration Docs](https://kyuubi.readthedocs.io/en/master/deployment/settings.html)
to [Apache Kyuubi Configuration Docs](https://kyuubi.readthedocs.io/en/master/deployment/settings.html) .

### Add MySQL JDBC Driver

Copy the Mysql JDBC Driver `mysql-connector-j-8.X.X.jar` to `$KYUUBI_HOME/incubating-bin/externals/engines/jdbc` 目录下。
Copy the Mysql JDBC Driver `mysql-connector-j-8.X.X.jar` to `$KYUUBI_HOME/externals/engines/jdbc`.

### Start Kyuubi Server

Run `$KYUUBI_HOME/bin/kyuubi run`.
After started, port 10009 by default is listened by Kyuubi Server with Thrift protocol。
Run `$KYUUBI_HOME/bin/kyuubi start`.
After started, port 10009 by default is listened by Kyuubi Server with Thrift protocol.

## Example

The fowllowing example shows basic example of querying Doris with Kyuubi with beeline CLI in thift protocol.
The following example shows basic example of querying Doris with Kyuubi with beeline CLI in Thrift protocol.

### Connect to Kyuubi with Beeline

```shell
$ ./beeline -u "jdbc:hive2://xxxx:10009/"
$ $KYUUBI_HOME/bin/beeline -u "jdbc:hive2://xxxx:10009/"
```

### Execute Query to Kyuubi
Expand All @@ -104,12 +104,12 @@ select * from demo.example_tbl
+----------+-------------+-------+------+------+------------------------+-------+-----------------+-----------------+
| user_id | date | city | age | sex | last_visit_date | cost | max_dwell_time | min_dwell_time |
+----------+-------------+-------+------+------+------------------------+-------+-----------------+-----------------+
| 10000 | 2017-10-01 | 北京 | 20 | 0 | 2017-10-01 07:00:00.0 | 70 | 10 | 2 |
| 10001 | 2017-10-01 | 北京 | 30 | 1 | 2017-10-01 17:05:45.0 | 4 | 22 | 22 |
| 10002 | 2017-10-02 | 上海 | 20 | 1 | 2017-10-02 12:59:12.0 | 400 | 5 | 5 |
| 10003 | 2017-10-02 | 广州 | 32 | 0 | 2017-10-02 11:20:00.0 | 60 | 11 | 11 |
| 10004 | 2017-10-01 | 深圳 | 35 | 0 | 2017-10-01 10:00:15.0 | 200 | 3 | 3 |
| 10004 | 2017-10-03 | 深圳 | 35 | 0 | 2017-10-03 10:20:22.0 | 22 | 6 | 6 |
| 10000 | 2017-10-01 | 北京 | 20 | 0 | 2017-10-01 07:00:00.0 | 70 | 10 | 2 |
| 10001 | 2017-10-01 | 北京 | 30 | 1 | 2017-10-01 17:05:45.0 | 4 | 22 | 22 |
| 10002 | 2017-10-02 | 上海 | 20 | 1 | 2017-10-02 12:59:12.0 | 400 | 5 | 5 |
| 10003 | 2017-10-02 | 广州 | 32 | 0 | 2017-10-02 11:20:00.0 | 60 | 11 | 11 |
| 10004 | 2017-10-01 | 深圳 | 35 | 0 | 2017-10-01 10:00:15.0 | 200 | 3 | 3 |
| 10004 | 2017-10-03 | 深圳 | 35 | 0 | 2017-10-03 10:20:22.0 | 22 | 6 | 6 |
+----------+-------------+-------+------+------+------------------------+-------+-----------------+-----------------+
6 rows selected (0.068 seconds)
```
35 changes: 17 additions & 18 deletions docs/zh-CN/docs/ecosystem/kyuubi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ under the License.

## 介绍

[Apache Kyuubi](https://kyuubi.apache.org/)，一个分布式和多租户网关，用于在 Lakehouse 上提供 Serverless
[Apache Kyuubi](https://kyuubi.apache.org/) 是一个分布式和多租户网关，用于在 Lakehouse 上提供 Serverless
SQL，可连接包括Spark、Flink、Hive、JDBC等引擎，并对外提供Thrift、Trino等接口协议供灵活对接。
其中Apache Kyuubi实现了JDBC Engine并支持Doris方言，并可用于对接Doris作为数据源。
Apache Kyuubi可提供高可用、服务发现、租户隔离、统一认证、生命周期等一系列特性。
Apache Kyuubi可提供高可用、服务发现、租户隔离、统一认证、生命周期管理等一系列特性。

## 下载 Apache Kyuubi

Expand Down Expand Up @@ -61,21 +61,21 @@ kyuubi.engine.jdbc.connection.password=***
| 配置项 | 说明 |
|----------------------------------------|-----------------------------------------------|
| kyuubi.engine.type | 引擎类型。请使用jdbc |
| kyuubi.engine.jdbc.type | jdbc服务类型。这里请指定为doris |
| kyuubi.engine.jdbc.connection.url | jdbc 服务连接。这里请指定 Doris FE 上的 mysql server 连接地址 |
| kyuubi.engine.jdbc.connection.user | jdbc 服务用户名 |
| kyuubi.engine.jdbc.connection.password | jdbc 服务密码 |
| kyuubi.engine.jdbc.driver.class | 连接jdbc服务使用的驱动类名。请使用com.mysql.cj.jdbc.Driver |
| kyuubi.engine.jdbc.type | JDBC 服务类型。这里请指定为doris |
| kyuubi.engine.jdbc.driver.class | 连接 JDBC 服务使用的驱动类名。请使用com.mysql.cj.jdbc.Driver |
| kyuubi.engine.jdbc.connection.url | JDBC 服务连接。这里请指定 Doris FE 上的 mysql server 连接地址 |
| kyuubi.engine.jdbc.connection.user | JDBC 服务用户名 |
| kyuubi.engine.jdbc.connection.password | JDBC 服务密码 |

- 其他相关配置参考 [Apache Kyuubi配置说明](https://kyuubi.readthedocs.io/en/master/deployment/settings.html)
- 其他相关配置参考 [Apache Kyuubi配置说明](https://kyuubi.readthedocs.io/en/master/deployment/settings.html) 。

### 添加MySQL驱动

添加 Mysql JDB C驱动 `mysql-connector-j-8.X.X.jar` 到 `$KYUUBI_HOME/incubating-bin/externals/engines/jdbc` 目录下。
添加 Mysql JDB C驱动 `mysql-connector-j-8.X.X.jar` 到 `$KYUUBI_HOME/externals/engines/jdbc` 目录下。

### 启动 Kyuubi 服务

`$KYUUBI_HOME/bin/kyuubi run`
`$KYUUBI_HOME/bin/kyuubi start`
启动后，Kyuubi默认监听10009端口提供Thrift协议。

## 使用方法
Expand All @@ -85,8 +85,7 @@ kyuubi.engine.jdbc.connection.password=***
### 建立连接

```shell
$ ./beeline -u "jdbc:hive2://xxxx:10009/"

$ $KYUUBI_HOME/bin/beeline -u "jdbc:hive2://xxxx:10009/"
```

### 执行查询
Expand All @@ -103,12 +102,12 @@ select * from demo.example_tbl
+----------+-------------+-------+------+------+------------------------+-------+-----------------+-----------------+
| user_id | date | city | age | sex | last_visit_date | cost | max_dwell_time | min_dwell_time |
+----------+-------------+-------+------+------+------------------------+-------+-----------------+-----------------+
| 10000 | 2017-10-01 | 北京 | 20 | 0 | 2017-10-01 07:00:00.0 | 70 | 10 | 2 |
| 10001 | 2017-10-01 | 北京 | 30 | 1 | 2017-10-01 17:05:45.0 | 4 | 22 | 22 |
| 10002 | 2017-10-02 | 上海 | 20 | 1 | 2017-10-02 12:59:12.0 | 400 | 5 | 5 |
| 10003 | 2017-10-02 | 广州 | 32 | 0 | 2017-10-02 11:20:00.0 | 60 | 11 | 11 |
| 10004 | 2017-10-01 | 深圳 | 35 | 0 | 2017-10-01 10:00:15.0 | 200 | 3 | 3 |
| 10004 | 2017-10-03 | 深圳 | 35 | 0 | 2017-10-03 10:20:22.0 | 22 | 6 | 6 |
| 10000 | 2017-10-01 | 北京 | 20 | 0 | 2017-10-01 07:00:00.0 | 70 | 10 | 2 |
| 10001 | 2017-10-01 | 北京 | 30 | 1 | 2017-10-01 17:05:45.0 | 4 | 22 | 22 |
| 10002 | 2017-10-02 | 上海 | 20 | 1 | 2017-10-02 12:59:12.0 | 400 | 5 | 5 |
| 10003 | 2017-10-02 | 广州 | 32 | 0 | 2017-10-02 11:20:00.0 | 60 | 11 | 11 |
| 10004 | 2017-10-01 | 深圳 | 35 | 0 | 2017-10-01 10:00:15.0 | 200 | 3 | 3 |
| 10004 | 2017-10-03 | 深圳 | 35 | 0 | 2017-10-03 10:20:22.0 | 22 | 6 | 6 |
+----------+-------------+-------+------+------+------------------------+-------+-----------------+-----------------+
6 rows selected (0.068 seconds)
```