Skip to content

Commit

Permalink
[docs](BI & IDE) add DBeaver and DataGrip connect Doris doc (apache#505)
Browse files Browse the repository at this point in the history
  • Loading branch information
zy-kkk authored Apr 2, 2024
1 parent 43d9fd9 commit 42ba42c
Show file tree
Hide file tree
Showing 36 changed files with 1,350 additions and 11 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
{
"title": "Apache Superset Integrate",
"title": "Apache Superset",
"language": "en"
}
---
Expand Down
89 changes: 89 additions & 0 deletions docs/ecosystem/bi/datagrip.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
---
{
"title": "DataGrip",
"language": "en"
}
---

<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->

## introduce

DataGrip is a powerful cross-platform database tool for relational and NoSQL databases from JetBrains.

Apache Doris is highly compatible with the MySQL protocol. You can use DataGrip's MySQL data source to connect to Apache Doris and query data in the internal catalog and external catalog.

## Preconditions

DataGrip installed
You can visit www.jetbrains.com/datagrip/ to download and install DataGrip

## Add data source

:::info Note
Currently verified using DataGrip version 2023.3.4
:::

1. Start DataGrip
2. Click the plus sign (**+**) icon in the upper left corner of the DataGrip window and select the MySQL data source

![add data source](/images/datagrip1.png)

3. Configure Doris connection

On the General tab of the Data Sources and Drivers window, configure the following connection information:

- Host: FE host IP address of the Doris cluster.
- Port: FE query port of Doris cluster, such as 9030.
- Database: The target database in the Doris cluster.
- User: User name used to log in to the Doris cluster, such as admin.
- Password: User password used to log in to the Doris cluster.

:::tip
Database can be used to distinguish between internal catalog and external catalog. If only the Database name is filled in, the current data source will be connected to the internal catalog by default. If the format is catalog.db, the current data source will be connected to the catalog filled in Database by default, as shown in DataGrip The database table is also a database table in the connected catalog. In this way, you can use DataGrip's MySQL data source to create multiple Doris data sources to manage different Catalogs in Doris.
:::

:::info Note
Managing the external catalog connected to Doris through the Database form of catalog.db requires Doris version 2.1.0 and above.
:::

- internal catalog

![connect internal catalog](/images/datagrip2.png)

- external catalog

![connect external catalog](/images/datagrip3.png)

5. Test data source connection

After filling in the connection information, click Test Connection in the lower left corner to verify the accuracy of the database connection information. If DBeaver returns the following pop-up window, the test connection is successful. Then click OK in the lower right corner to complete the connection configuration.

![test connection](/images/datagrip4.png)

6. Connect to database

After the database connection is established, you can see the created data source connection in the database connection navigation on the left, and you can connect and manage the database through DataGrip.

![create connection](/images/datagrip5.png)

## Function support

Basically supports most visual viewing operations, as well as SQL console writing SQL operations Doris does not support or has not been verified various operations such as creating database tables, schema changes, and adding, deleting, and modifying data.
122 changes: 122 additions & 0 deletions docs/ecosystem/bi/dbeaver.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
---
{
"title": "DBeaver",
"language": "en"
}
---

<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->

## introduce

DBeaver is a cross-platform database tool for developers, database administrators, analysts and anyone who works with data.

Apache Doris is highly compatible with the MySQL protocol. You can use DBeaver's MySQL driver to connect to Apache Doris and query data in the internal catalog and external catalog.

## Preconditions

Dbeaver installed
You can visit https://dbeaver.io to download and install DBeaver

## Add data source

:::info Note
Currently verified using DBeaver version 24.0.0
:::

1. Start DBeaver

2. Click the plus sign (**+**) icon in the upper left corner of the DBeaver window, or select **Database > New Database Connection** in the menu bar to open the **Connect to a database** interface.

![add connection 1](/images/dbeaver1.png)

![add connection 2](/images/dbeaver2.png)

3. Select the MySQL driver

In the **Select your database** window, select **MySQL**.

![chose driver](/images/dbeaver3.png)

4. Configure Doris connection

In the **main** tab of the **Connection Settings** window, configure the following connection information:

- Server Host: FE host IP address of the Doris cluster.
- Port: FE query port of Doris cluster, such as 9030.
- Database: The target database in the Doris cluster.
- Username: The username used to log in to the Doris cluster, such as admin.
- Password: User password used to log in to the Doris cluster.

:::tip
Database can be used to distinguish between internal catalog and external catalog. If only the Database name is filled in, the current data source will be connected to the internal catalog by default. If the format is catalog.db, the current data source will be connected to the catalog filled in Database by default, as shown in DBeaver The database tables are also database tables in the connected catalog, so you can use DBeaver's MySQL driver to create multiple Doris data sources to manage different Catalogs in Doris.
:::

:::info Note
Managing the external catalog connected to Doris through the Database form of catalog.db requires Doris version 2.1.0 and above.
:::

- internal catalog
![connect internal catalog](/images/dbeaver4.png)
- external catalog
![connect external catalog](/images/dbeaver5.png)

5. Test data source connection

After filling in the connection information, click Test Connection in the lower left corner to verify the accuracy of the database connection information. DBeaver returns to the following dialog box to confirm the configuration of the connection information. Click OK to confirm that the configured connection information is correct. Then click Finish in the lower right corner to complete the connection configuration.
![test connection](/images/dbeaver6.png)

6. Connect to database

After the database connection is established, you can see the created data source connection in the database connection navigation on the left, and you can connect and manage the database through DBeaver.
![create connection](/images/dbeaver7.png)

## Function support
- fully support
- Visual viewing class
- Databases
- Tables
- Views
- Users
- Administer
- Session Manager
- System Info
- Session Variables
- Global Variables
- Engines
- Charsets
- User Priviages
- Plugin
- Operation class
- SQL editor
- SQL console
- basic support

The basic support part means that you can click to view without error, but due to protocol compatibility issues, there may be incomplete display.

- Visual viewing class
- dash board
- Users/user/properties
- Session Status
- Global Status
- not support

The unsupported part means that when using DBeaver to manage Doris, errors may be reported when performing certain visual operations, or some visual operations are not verified.
Such as visual creation of database tables, schema change, addition, deletion and modification of data, etc.
4 changes: 4 additions & 0 deletions i18n/zh-CN/docusaurus-plugin-content-docs/current.json
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,10 @@
"message": "生态扩展",
"description": "The label for category Ecosystem in sidebar docs"
},
"sidebar.docs.category.BI and Database IDE": {
"message": "BI 与数据库 IDE",
"description": "The label for category BI and Database IDE in sidebar docs"
},
"sidebar.docs.category.Doris Manager": {
"message": "Doris Manager",
"description": "The label for category Doris Manager in sidebar docs"
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
---
{
"title": "DataGrip",
"language": "zh-CN"
}
---

<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->

## 介绍

DataGrip 是 JetBrains 出品的适用于关系数据库和 NoSQL 数据库的强大跨平台数据库工具。

Apache Doris 高度兼容 MySQL 协议,可以使用 DataGrip 的 MySQL 数据源连接 Apache Doris,并查询 internal catalog 和 external catalog 中的数据。

## 前置条件

已安装 DataGrip
可以访问 www.jetbrains.com/datagrip/ 下载安装 DataGrip

## 添加数据源

:::info 备注
当前验证使用 DataGrip 2023.3.4 版本
:::

1. 启动 DataGrip
2. 在 DataGrip 窗口左上角单击加号 (**+**) 图标,选择 MySQL 数据源

![添加数据源](/images/datagrip1.png)

3. 配置 Doris 连接

在 Data Sources and Drivers 窗口的 General 标签页,配置以下连接信息:

- Host:Doris 集群的 FE 主机 IP 地址。
- Port:Doris 集群的 FE 查询端口,如 9030。
- Database:Doris 集群中的目标数据库。
- User:用于登录 Doris 集群的用户名,如 admin。
- Password:用于登录 Doris 集群的用户密码。

:::tip
Database 可以用于区别 internal catalog 和 external catalog,如仅填写 Database 名称,则当前数据源默认连接 internal catalog,如填写格式为 catalog.db,则当前数据源默认连接 Database 中所填写的 catalog,DataGrip 中展示的库表也为所连接 catalog 中的库表,以此可以使用 DataGrip 的 MySQL 数据源来创建多个 Doris 数据源来管理 Doris 中不同的 Catalog。
:::

:::info 备注
通过 catalog.db 的 Database 形式来管理连接 Doris 的 external catalog 需要 Doris 版本在 2.1.0 及以上
:::

- internal catalog

![连接 internal catalog](/images/datagrip2.png)

- external catalog

![连接 external catalog](/images/datagrip3.png)

5. 测试数据源连接

在填写完连接信息后,单击左下角 Test Connection 验证数据库连接信息的准确性。DBeaver 返回如下对弹窗则测试连接成功。然后单击右下角 OK 完成连接配置。

![测试连接](/images/datagrip4.png)

6. 连接数据库

数据库连接建立以后,可以在左侧的数据库连接导航看到已创建的数据源连接,并且可以通过 DataGrip 连接并管理数据库。

![建立连接](/images/datagrip5.png)

## 功能支持

基本支持大部分可视化查看操作,以及 SQL 控制台编写 SQL 操作 Doris,不支持或未经验证各种创建库表、schema change、增删改数据操作。
Loading

0 comments on commit 42ba42c

Please sign in to comment.