虚谷文档 v1.0.1

适用虚谷数据库版本

v12.9



适用虚谷数据库版本

v12.9


DBeaver管理工具 ​

📄字数 3.3K
👁️阅读量 加载中...

一、介绍 ​

1.1 DBeaver介绍 ​

DBeaver 是一款面向开发人员、SQL 程序员、数据库管理员和分析师的免费多平台数据库工具。

DBeaver 支持任何具有 JDBC 驱动程序的数据库（基本上是任何数据库）。商业版本还支持非 JDBC 数据源，如 MongoDB、Cassandra、Couchbase、Redis、BigTable、ScyllaDB、DynamoDB 等。

1.2 XuguDB适配介绍 ​

虚谷数据库对 DBeaver 数据库管理工具进行了插件式支持。通过官方公共接口及 API 标准开发，实现了功能完整支持及多版本 DBeaver 适配。

  1. 本文档以DBeaver-ce-25.0.5版本进行编写。
  2. XuguDB 发行的 DBeaver 有两种
    1. 插件发行
      DBeaver 支持的数据库是以插件的形式开发的，所以 XuguDB 提供 Dbeaver 的插件包，用户可以根据实际情况，在自己本地的 DBeaver 环境中安装 xugu-dbeaver 插件。插件详细的安装教程参考第二章内容。
    2. 集成发行
      XuguDB 在公开的开源适配项目中，打包发布已完整适配的 DBeaver 安装包，可通过下载地址下载完整的安装包，安装即可使用。

二、XuguDB-DBeaver插件安装 ​

2.1 准备 ​

  1. 如果本地已经安装 DBeaver，查看本地 DBeaver 版本是否与 XuguDB适配版本一致。如果 DBeaver 主版本过低，建议升级 DBeaver，可体验更多新功能。（注意：升级前备份其它插件，升级会清除旧插件。或者在新路径下安装新的 DBeaver，请参阅升级注意事项）
  2. 获取插件，插件地址，详细请参考第2.2节。

提示

如果感觉插件安装繁琐，可参考XuguDB集成发行的DBeaver。

2.2 DBeaver 产品包获取 ​

可以从官方网站或 GitHub 下载预构建的二进制文件，前往下载

  • 点击版本说明下方的“Assets”展开安装包列表，根据需要运行 DBeaver 的操作系统版本选择对应安装包。

  • Windows 用户可选择： dbeaver-ce-25.0.5-win32.win32.x86_64.zip 压缩包，自带 JRE 运行环境，解压即可使用。

  • 执行安装程序 dbeaver-ce-25.0.5-x86_64-setup.exe 直接进行 DBeaver 安装。

  • Linux 或 MacOS 用户可根据需要选择对应程序。

2.3 DBeaver 插件下载 ​

XuguDB 提供 DBeaver 在线下载链接，可前往 XuguDB-DBeaver 插件获取最新适配的 DBeaver 版本插件。

提示

  1. JDBC 驱动跨平台兼容，所以 Linux 和 Windows 操作系统的插件包一致。
  2. JDK/JRE 17+（Windows 和 MacOS X 安装包自带了JRE 运行环境）。

2.4 部署步骤 ​

部署示例使用的插件包文件名说明见下表

插件名说明
org.jkiss.dbeaver.ext.xugu.ui_1.4.301.202505210743.jarXuguDB-DBeaver 插件的界面支持包
org.jkiss.dbeaver.ext.xugu_1.4.301.202505210743.jarXuguDB-DBeaver 插件的功能支持包

  1. 将下载的 jar 插件包放入 DBeaver 插件目录： {DBeaver 程序根目录}/plugins/。

  2. 使用文本编辑器打开 DBeaver 包信息配置文件文件路径。

    txt
    {DBeaver 程序根目录}/configuration/org.eclipse.equinox.simpleconfigurator/bundles.info

  3. 在文件末尾添加配置信息。

    text
    org.jkiss.dbeaver.ext.xugu,1.4.201.202505210743,plugins/org.jkiss.dbeaver.ext.xugu_1.4.201.202505210743.jar,4,false
org.jkiss.dbeaver.ext.xugu.ui,1.4.301.202505210743,plugins/org.jkiss.dbeaver.ext.xugu.ui_1.4.301.202505210743.jar,4,false

  4. 启动 DBeaver。

    a.通过安装程序安装的用户可从桌面或开始菜单启动 DBeaver。

    b.通过解压安装的用户可以双击 dbeaver.exe。

2.5 升级注意事项 ​

重要

由于虚谷 DBeaver 使用了专门适配的插件，若使用官方安装包覆盖升级，适配插件将丢失！
因此，推荐使用虚谷 DBeaver 新版本执行覆盖升级！若确实需要使用官方版本升级，请参阅以下步骤：

  1. 备份虚谷 DBeaver 整个目录（推荐），或者备份虚谷 DBeaver 中以下两个适配插件：
    • <XuguDBeaverDir>/plugins/org.jkiss.dbeaver.ext.xugu_1.4.201.202505210743.jar
    • <XuguDBeaverDir>/plugins/org.jkiss.dbeaver.ext.xugu.ui_1.4.301.202505210743.jar
  2. 使用官方安装包安装到虚谷 DBeaver 所在目录；
  3. 参考部署步骤重新配置虚谷插件；
  4. 启动 DBeaver 检查虚谷连接是否可以正常使用，若出现问题请换回备份的虚谷 DBeaver，或重新下载虚谷DBeaver；
  5. 若有新版本特性需要使用，请联系虚谷技术支持反馈。

三、创建虚谷数据库连接 ​

  1. 点击菜单栏“数据库”->“新建连接” 或点击工具栏新建连接图标。

  2. 在左侧分类中选择 SQL 类别并下拉列表找到 XuguDB，选中进入下一步。

  3. 首先配置驱动程序，点击页面右下角“编辑驱动设置”。

  4. 配置驱动文件

    从xugu-dbeaver插件下载地址下载驱动(xugu-jdbc)后，点击添加文件导入。

    返回dbeaver，点击“库”，点击“添加”。找到刚才下载的xugu-jdbc驱动文件。

  5. 设置数据库基本连接信息（明文信息建议全大写）

    包括数据库地址、端口、数据库名、用户名、密码、登陆角色等。

  6. 若需要设置连接串参数，请点击驱动属性，点击左下角添加连接属性，并写入对应属性值即可。

  7. 点击“Finish”。

四、工具功能 ​

使用工具均需要以成功建立连接为前提。虚谷插件为 DBeaver 提供了 6 种功能使用。使用方式为：

  • 选择工具执行对象类型（可选择库级、模式级），此处以库级为例。

  • 选中数据库实例“SYSTEM8”。
  • 右键点击数据库实例“SYSTEM8”。
  • 点击“Xugu 工具”选择使用功能。

4.1 导出数据库定义 ​

此工具的作用是将该数据库下的所有对象的定义(即DDL语句)导入到指定文件路径下，并生成一个文件。

  • 点击“Xugu 工具”中“导出数据库定义”。

  • 点击“开始导出”，即立刻执行该功能。

  • 执行成功。

4.2 备份数据对象 ​

此工具的作用是将该对象下的所有数据备份到指定文件路径下，并生成一个文件。

  • 点击“Xugu 工具”中“备份数据对象”。
  • 通过左侧复选框勾选目标对象，右下方也有快捷键操作。
  • 点击“开始备份”。
  • 进入确认窗口进行最后备份功能前的信息确认，若无误，即点击“已确认，立即开始”按钮。
  • 备份成功。

4.3 查看数据库文件 ​

此工具的作用是快速查看数据文件信息，包括实体名称以及对应操作系统路径等。

  • 点击“Xugu 工具”中“查看数据库文件”。

4.4 恢复数据对象 ​

此工具的作用是将虚谷备份文件存储的数据导入到数据库中。

  • 点击“Xugu 工具”中“恢复数据对象”。
  • 通过第一行第一个下拉框可进行对象级别选择。
  • 通过第一行第二个可编辑栏进行备份文件名编写。
  • 然后按照编辑栏提示和业务需求进行元信息编写,并点击“开始恢复”。
  • 恢复成功。

4.5 查看数据库资源 ​

此工具的作用是快速查看数据库系统参数配置信息。

  • 点击“Xugu 工具”中“查看数据资源”。

4.6 数据库事务查杀 ​

此工具的作用是快速查看数据库当前存在的事务信息，可通过“强制停止”终止异常事务（谨慎操作）。

  • 点击“Xugu 工具”中“查杀数据库事务”。
  • 点击“强制停止”，即进入确认窗口。
  • 点击“OK”，即可关闭选择查杀的事务。