English

DBeaver Agent for 24.x

该分支该针对 24.x 版本，其他低版本可以参考 master 分支

支持的版本

• 24.3
• 24.2
• 24.1.x
• 24.0.x

依赖

由于单元测试使用了来自 DBeaver 的代码,所以你需要准备好 DBeaver 的一些包 把下列的包放入到 libs 文件夹

• com.dbeaver.ee.runtime 基础运行时,获取密钥等信息在里面
• com.dbeaver.lm.api 许可核心
• org.jkiss.utils 提供一些组件供许可生成
• 对于 DbeaverUltimate 其公钥位于 com.dbeaver.app.ultimate
• 对于 Cloudeaver 其公钥位于 io.cloudbeaver.product.ee

怎么用?

首先执行 mvn package 来构建项目，生成 target/dbeaver-agent-1.0-SNAPSHOT-jar-with-dependencies.jar 文件

然后将生成的 dbeaver-agent-1.0-SNAPSHOT-jar-with-dependencies.jar 放到任何你喜欢的地方（比如 /usr/share/dbeaver/dbeaver-agent.jar）

cp target/dbeaver-agent-1.0-SNAPSHOT-jar-with-dependencies.jar /usr/share/dbeaver/dbeaver-agent.jar

但还是推荐放到安装目录

修改 DBeaver 安装目录的 dbeaver.ini 给他加点参数 在 -vmargs 下面一行加 -javaagent:{你的jar路径} 以及 -Xbootclasspath/a:{你的jar路径} 就像这样

-startup
plugins/org.eclipse.equinox.launcher_1.6.100.v20201223-0822.jar
--launcher.library
plugins/org.eclipse.equinox.launcher.gtk.linux.x86_64_1.2.100.v20210209-1541
-vmargs
-javaagent:/usr/share/dbeaver/dbeaver-agent.jar
-Xbootclasspath/a:/usr/share/dbeaver/dbeaver-agent.jar
-XX:+IgnoreUnrecognizedVMOptions
--add-modules=ALL-SYSTEM
-Dosgi.requiredJavaVersion=11
-Xms128m
-Xmx2048m

最后，删除 DBeaver 自带的 jre 文件夹， 如果你系统默认的 JRE 就是 17 的话，且能在系统路径中找到，那就不用做其他操作。否则你需要把你安装的 JRE 17 拷贝到 DBeaver 安装目录下，和它自带的 jre 文件夹同级。 如果是非 Windows 系统，你也可以采取软链接的方式。

生成密钥

现已支持命令行生成密钥，运行方式如下：

java -cp libs/\*:./target/dbeaver-agent-1.0-SNAPSHOT-jar-with-dependencies.jar \
    dev.misakacloud.dbee.License

默认生成的密钥是针对 Dbeaver Enterprise Edition 24.0，如果需要其他类型的密钥，可以使用下面的参数来指定

java -cp libs/\*:./target/dbeaver-agent-1.0-SNAPSHOT-jar-with-dependencies.jar \
    dev.misakacloud.dbee.License -h

Usage: gen-license [-h] [-p=<productName>] [-t=<licenseType>]
                   [-v=<productVersion>]
Generate DBeaver license
  -h, --help
  -p, --product=<productName>
                             Product name, you can choose dbeaver or
                               cloudbeaver, default is dbeaver
  -t, --type=<licenseType>   License type, you can choose Lite version(le),
                               Enterprise version(ee) or Ultimate version(ue)
                               default is ue
  -v, --version=<productVersion>
                             Product version, default is 24

首次倒入注册码时，建议通过命令行启动 dbeaver，这样可以看到详细的日志信息，方便排查问题。