You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudberry.apache.org by dj...@apache.org on 2025/02/24 02:09:08 UTC

(cloudberry-site) branch main updated: docs: add dbeaver docs (#238)

This is an automated email from the ASF dual-hosted git repository.

djwang pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/cloudberry-site.git


The following commit(s) were added to refs/heads/main by this push:
     new 4d07be52 docs: add dbeaver docs (#238)
4d07be52 is described below

commit 4d07be5243c7f976c124708ff0a2a1fac7ec5b20
Author: TomShawn <41...@users.noreply.github.com>
AuthorDate: Mon Feb 24 10:09:04 2025 +0800

    docs: add dbeaver docs (#238)
---
 docs/ecosystem/sql-clients/dbeaver.md              |  50 +++++++++++++++++++++
 docs/media/dbeaver1.png                            | Bin 0 -> 152937 bytes
 docs/media/dbeaver2.png                            | Bin 0 -> 336490 bytes
 docs/media/dbeaver3.png                            | Bin 0 -> 233447 bytes
 docs/media/dbeaver4.png                            | Bin 0 -> 560954 bytes
 docs/media/dbeaver5.png                            | Bin 0 -> 470179 bytes
 docs/media/dbeaver6.png                            | Bin 0 -> 628935 bytes
 docs/media/dbeaver7.png                            | Bin 0 -> 666330 bytes
 .../zh/docusaurus-plugin-content-docs/current.json |   4 ++
 .../current/ecosystem/sql-clients/dbeaver.md       |  50 +++++++++++++++++++++
 .../current/media/dbeaver1.png                     | Bin 0 -> 152937 bytes
 .../current/media/dbeaver2.png                     | Bin 0 -> 336490 bytes
 .../current/media/dbeaver3.png                     | Bin 0 -> 233447 bytes
 .../current/media/dbeaver4.png                     | Bin 0 -> 560954 bytes
 .../current/media/dbeaver5.png                     | Bin 0 -> 470179 bytes
 .../current/media/dbeaver6.png                     | Bin 0 -> 628935 bytes
 .../current/media/dbeaver7.png                     | Bin 0 -> 666330 bytes
 sidebars.ts                                        |  12 +++++
 18 files changed, 116 insertions(+)

diff --git a/docs/ecosystem/sql-clients/dbeaver.md b/docs/ecosystem/sql-clients/dbeaver.md
new file mode 100644
index 00000000..549607bd
--- /dev/null
+++ b/docs/ecosystem/sql-clients/dbeaver.md
@@ -0,0 +1,50 @@
+---
+title: DBeaver
+---
+
+# DBeaver
+
+DBeaver is a powerful database management tool and SQL client software that supports various database systems, including MySQL, PostgreSQL, and Apache Cloudberry. This document introduces how to establish a connection between DBeaver and the Apache Cloudberry database.
+
+## Prerequisites
+
+- Apache Cloudberry is deployed with proper database access permissions set in `pg_hba.conf`.
+- DBeaver (v24.3.3 or higher) is installed.
+
+## Steps
+
+1. Launch DBeaver and start creating a new database connection using either of these methods:
+
+    - Select **Database** > **New Database Connection** from the menu bar.
+
+![](../../media/dbeaver1.png)
+
+    - Click the plus (+) icon in the top-left corner.
+
+![](../../media/dbeaver2.png)
+
+2. In the **Select your database** dialog, find and select **Cloudberry**, then click **Next**.
+
+![](../../media/dbeaver3.png)
+
+3. In the **Connection Settings** dialog's **Main** tab, fill in these connection parameters:
+
+    - **Host**: Enter the hostname or IP address of your Cloudberry database server.
+    - **Port**: Enter the database port (for example, `5432`).
+    - **Database**: Enter the target database name.
+    - **Username**: Enter a database username with access privileges.
+    - **Password**: Enter the corresponding password.
+
+![](../../media/dbeaver4.png)
+
+    Switch to the **Driver properties** tab to view and modify Cloudberry driver properties by clicking the Value column.
+
+![](../../media/dbeaver5.png)
+
+4. Verify and complete the configuration: Click **Test Connection** to test the connection. A confirmation dialog indicates a successful test. Click **OK** to confirm, then click **Finish** to complete the setup.
+
+![](../../media/dbeaver6.png)
+
+5. After establishing the connection, you can see the created database connection in the left navigation pane and manage your database through DBeaver.
+
+![](../../media/dbeaver7.png)
diff --git a/docs/media/dbeaver1.png b/docs/media/dbeaver1.png
new file mode 100644
index 00000000..59dd1fac
Binary files /dev/null and b/docs/media/dbeaver1.png differ
diff --git a/docs/media/dbeaver2.png b/docs/media/dbeaver2.png
new file mode 100644
index 00000000..adaf4c6d
Binary files /dev/null and b/docs/media/dbeaver2.png differ
diff --git a/docs/media/dbeaver3.png b/docs/media/dbeaver3.png
new file mode 100644
index 00000000..475e708f
Binary files /dev/null and b/docs/media/dbeaver3.png differ
diff --git a/docs/media/dbeaver4.png b/docs/media/dbeaver4.png
new file mode 100644
index 00000000..b422bb18
Binary files /dev/null and b/docs/media/dbeaver4.png differ
diff --git a/docs/media/dbeaver5.png b/docs/media/dbeaver5.png
new file mode 100644
index 00000000..fabd166c
Binary files /dev/null and b/docs/media/dbeaver5.png differ
diff --git a/docs/media/dbeaver6.png b/docs/media/dbeaver6.png
new file mode 100644
index 00000000..6165a79d
Binary files /dev/null and b/docs/media/dbeaver6.png differ
diff --git a/docs/media/dbeaver7.png b/docs/media/dbeaver7.png
new file mode 100644
index 00000000..a04e2138
Binary files /dev/null and b/docs/media/dbeaver7.png differ
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current.json b/i18n/zh/docusaurus-plugin-content-docs/current.json
index fcad9e60..90609404 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/current.json
+++ b/i18n/zh/docusaurus-plugin-content-docs/current.json
@@ -62,5 +62,9 @@
   "sidebar.docsbars.category.Advanced Analytics": {
     "message": "高级数据分析",
     "description": "The label for category advanced analytics in sidebar docs"
+  },
+  "sidebar.docsbars.category.Ecosystem": {
+    "message": "生态系统",
+    "description": "The label for category ecosystem in sidebar docs"
   }
 }
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/ecosystem/sql-clients/dbeaver.md b/i18n/zh/docusaurus-plugin-content-docs/current/ecosystem/sql-clients/dbeaver.md
new file mode 100644
index 00000000..a88c8a30
--- /dev/null
+++ b/i18n/zh/docusaurus-plugin-content-docs/current/ecosystem/sql-clients/dbeaver.md
@@ -0,0 +1,50 @@
+---
+title: DBeaver
+---
+
+# DBeaver
+
+DBeaver 是一款功能丰富的数据库管理工具和 SQL 客户端软件,可以支持包括 MySQL、PostgreSQL 和 Apache Cloudberry 在内的多种数据库系统,为用户提供了全面的数据库管理能力。本文将介绍如何使用 DBeaver 与 Apache Cloudberry 数据库建立连接。
+
+## 前提条件
+
+- 完成 Apache Cloudberry 的部署,并已在 `pg_bha.conf` 中正确设置数据库访问权限。
+- 完成 DBeaver(v24.3.3 或更高版本)的安装。
+
+## 操作步骤
+
+1. 启动 DBeaver,通过以下两种方式之一开始创建新的数据库连接:
+
+    - 在菜单栏选择 **Database** > **New Database Connection**
+
+![](../../media/dbeaver1.png)
+
+    - 点击界面左上角的加号 (+) 图标
+
+![](../../media/dbeaver2.png)
+
+2. 在弹出的 **Select your database** 对话框中,找到并选择 **Cloudberry**,继续点击 **Next**。
+
+![](../../media/dbeaver3.png)
+
+3. 在 **Connection Settings** 对话框的 **Main** 标签页中,填写以下连接参数:
+
+     - **Host**: 输入 Cloudberry 数据库服务器的主机名或 IP 地址。
+     - **Port**: 输入数据库服务端口(例如 `5432`)。
+     - **Database**: 输入要连接的目标数据库名称。
+     - **Username**: 输入具有访问权限的数据库用户名。
+     - **Password**: 输入对应用户的登录密码。
+
+![](../../media/dbeaver4.png)
+
+    切换到 **Driver properties** 标签页,你可以查看并修改 Cloudberry 驱动程序的相关属性,只需点击属性对应的 Value 列即可进行编辑。
+
+![](../../media/dbeaver5.png)
+
+4. 验证并完成配置:点击左下角的 **Test Connection** 按钮测试连接是否可用。如果出现确认对话框,表示连接测试成功。点击 OK 确认后,最后点击 Finish 按钮完成整个连接设置。
+
+![](../../media/dbeaver6.png)
+
+5. 数据库连接建立以后,你可以在左侧的数据库连接导航看到已创建的数据源连接,并且可以通过 DBeaver 连接并管理数据库。
+
+![](../../media/dbeaver7.png)
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/media/dbeaver1.png b/i18n/zh/docusaurus-plugin-content-docs/current/media/dbeaver1.png
new file mode 100644
index 00000000..59dd1fac
Binary files /dev/null and b/i18n/zh/docusaurus-plugin-content-docs/current/media/dbeaver1.png differ
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/media/dbeaver2.png b/i18n/zh/docusaurus-plugin-content-docs/current/media/dbeaver2.png
new file mode 100644
index 00000000..adaf4c6d
Binary files /dev/null and b/i18n/zh/docusaurus-plugin-content-docs/current/media/dbeaver2.png differ
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/media/dbeaver3.png b/i18n/zh/docusaurus-plugin-content-docs/current/media/dbeaver3.png
new file mode 100644
index 00000000..475e708f
Binary files /dev/null and b/i18n/zh/docusaurus-plugin-content-docs/current/media/dbeaver3.png differ
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/media/dbeaver4.png b/i18n/zh/docusaurus-plugin-content-docs/current/media/dbeaver4.png
new file mode 100644
index 00000000..b422bb18
Binary files /dev/null and b/i18n/zh/docusaurus-plugin-content-docs/current/media/dbeaver4.png differ
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/media/dbeaver5.png b/i18n/zh/docusaurus-plugin-content-docs/current/media/dbeaver5.png
new file mode 100644
index 00000000..fabd166c
Binary files /dev/null and b/i18n/zh/docusaurus-plugin-content-docs/current/media/dbeaver5.png differ
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/media/dbeaver6.png b/i18n/zh/docusaurus-plugin-content-docs/current/media/dbeaver6.png
new file mode 100644
index 00000000..6165a79d
Binary files /dev/null and b/i18n/zh/docusaurus-plugin-content-docs/current/media/dbeaver6.png differ
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/media/dbeaver7.png b/i18n/zh/docusaurus-plugin-content-docs/current/media/dbeaver7.png
new file mode 100644
index 00000000..a04e2138
Binary files /dev/null and b/i18n/zh/docusaurus-plugin-content-docs/current/media/dbeaver7.png differ
diff --git a/sidebars.ts b/sidebars.ts
index af96165a..23505a62 100644
--- a/sidebars.ts
+++ b/sidebars.ts
@@ -113,6 +113,18 @@ const sidebars: SidebarsConfig = {
         'sys-admin/configure-database-system', 'sys-admin/check-database-system', 'sys-admin/enable-coordinator-mirroring', 'sys-admin/recommended-maintenance-monitoring-tasks']
      },
 
+     {
+      type: 'category',
+      label: 'Ecosystem',
+      items: [
+        {
+        type: 'category',
+        label: 'SQL Clients',
+        items: ['ecosystem/sql-clients/dbeaver']
+       },
+        ]
+     },
+
     {
       type: 'category',
       label: 'References',


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cloudberry.apache.org
For additional commands, e-mail: commits-help@cloudberry.apache.org