升级指南

概述

• 此文档主要分 3 部分：企业版升级、个人版升级、个人版升级至企业版
• 升级都需要重新下载新的软件包解压安装，并填写新的许可证才能启动使用
• 升级的数据迁移分 2 种情况：
  • 如果旧版本系统使用的元数据库是 MySQL，新版本可沿用旧的元数据库地址，只需在新版本配置中修改元数据库地址即可（除非版本跨度大，元数据表结构有变动，需要手动执行 SQL 修改表结构，请看 版本更新日志 中的不兼容版本说明）
  • 如果旧版本系统使用的元数据库是自带的 SQLite，需要先从旧版本软件系统导出数据源、分组、API 配置，再导入到新版本系统中

IMPORTANT

此文档默认在 Linux 系统下操作说明，如果是 Windows 系统，请右键点击 bin/dbapi.ps1 文件并选择 使用 powershell 运行 来启动软件

IMPORTANT

您可以 自助获取升级版本的商业许可证

---

企业版升级

1. 安装与获取许可证

• 下载 新版本企业版软件并解压
• 直接命令行 bash bin/dbapi-daemon.sh start standalone 启动，在日志文件 logs/dbapi-standalone.log 最下面找到序列号，联系客服，提供新的序列号，更换新的许可证，将新的许可证填写到 conf/key.properties 文件中

注意

如果您要安装集群版，需要将新版本的软件包复制到其它服务器，并且在每个服务器都重复执行以上步骤（获取序列号、获取新许可证、填写新许可证）

2. 数据迁移配置

场景一：元数据库为 MySQL

配置数据库连接

• 修改新版本的配置 conf/application.properties 中的元数据库地址指向旧版本的企业版软件的元数据库地址

# 元数据库地址配置旧版本使用的 mysql 地址
spring.datasource.dynamic.datasource.meta-db.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.dynamic.datasource.meta-db.url=jdbc:mysql://127.0.0.1:3300/dbapi?useSSL=false&characterEncoding=UTF-8&serverTimezone=GMT%2B8
spring.datasource.dynamic.datasource.meta-db.username=root
spring.datasource.dynamic.datasource.meta-db.password=root

access.log.writer=db

# 如果使用了日志数据库，日志数据库地址配置旧版本使用的地址
spring.datasource.dynamic.datasource.access-log-db.driver-class-name=ru.yandex.clickhouse.ClickHouseDriver
spring.datasource.dynamic.datasource.access-log-db.url=jdbc:clickhouse://127.0.0.1:8123/default
spring.datasource.dynamic.datasource.access-log-db.username=default
spring.datasource.dynamic.datasource.access-log-db.password=123456

• 按照 安装文档 说明，修改您的其它配置

启动服务

• 如果安装单机版，直接命令行 bash bin/dbapi-daemon.sh start standalone 启动
• 如果安装集群版，需要将修改了配置的配置文件复制分发到其他节点，使用命令行 bash bin/start-all.sh 启动
• 启动之后即可使用，原来的 API 都在新版本中

场景二：元数据库为 SQLite

导出旧版配置

• 需要先从旧版本软件系统中导出数据源、分组、API 配置

配置新版本

• 按照 安装文档 说明，修改您的配置

启动服务

• 如果安装单机版，直接命令行 bash bin/dbapi-daemon.sh start standalone 启动
• 如果安装集群版，需要将修改了配置的配置文件复制分发到其他节点，使用命令行 bash bin/start-all.sh 启动

导入配置

• 启动之后访问新版本软件页面 http://192.168.xx.xx:8520，使用 admin/admin 登录
• 导入数据源、分组、API 配置

• 至此，新版本的软件就可以使用了

---

个人版升级

1. 安装与获取许可证

• 下载 新版本个人版软件并解压
• 直接命令行 bash bin/dbapi-daemon.sh start standalone 启动，在日志文件 logs/dbapi-standalone.log 最下面找到序列号，使用序列号申请新的免费许可证或者购买个人版商业许可证，将新的许可证填写到 conf/key.properties 中

2. 数据迁移配置

场景一：元数据库为 MySQL

配置数据库连接

• 修改新版本的配置 conf/application.properties 中的元数据库地址指向旧版本的软件的元数据库地址

# 元数据库地址配置旧版本使用的 mysql 地址
spring.datasource.dynamic.datasource.meta-db.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.dynamic.datasource.meta-db.url=jdbc:mysql://127.0.0.1:3300/dbapi?useSSL=false&characterEncoding=UTF-8&serverTimezone=GMT%2B8
spring.datasource.dynamic.datasource.meta-db.username=root
spring.datasource.dynamic.datasource.meta-db.password=root

access.log.writer=db

# 如果使用了日志数据库，日志数据库地址配置旧版本使用的地址
spring.datasource.dynamic.datasource.access-log-db.driver-class-name=ru.yandex.clickhouse.ClickHouseDriver
spring.datasource.dynamic.datasource.access-log-db.url=jdbc:clickhouse://127.0.0.1:8123/default
spring.datasource.dynamic.datasource.access-log-db.username=default
spring.datasource.dynamic.datasource.access-log-db.password=123456

• 按照 安装文档 说明，修改您的其它配置

启动服务

• 直接命令行 bash bin/dbapi-daemon.sh start standalone 启动
• 启动之后即可使用，原来的 API 都在新版本中

场景二：元数据库为 SQLite

导出旧版配置

• 需要先从旧版本软件系统中导出数据源、分组、API 配置

配置新版本

• 按照 安装文档 说明，修改您的配置

启动服务

• 直接命令行 bash bin/dbapi-daemon.sh start standalone 启动

导入配置

• 启动之后访问新版本软件页面 http://192.168.xx.xx:8520，使用 admin/admin 登录
• 导入数据源、分组、API 配置

• 至此，新版本的软件就可以使用了

---

个人版升级至企业版

1. 安装与获取许可证

• 下载 企业版软件并解压
• 直接命令行 bash bin/dbapi-daemon.sh start standalone 启动，在日志文件 logs/dbapi-standalone.log 最下面找到序列号，使用序列号购买许可证，将新的许可证填写到 conf/key.properties 中

注意

如果您要安装集群版，需要将企业版软件包复制到其它服务器，并且在每个服务器都重复执行以上步骤（获取序列号、获取新许可证、填写新许可证）

2. 导出旧版配置

• 需要先从旧的个人版软件中导出数据源、分组、API 配置

3. 配置与启动新版

• 按照 安装文档 说明，修改企业版软件的配置
• 如果安装单机版，直接命令行 bash bin/dbapi-daemon.sh start standalone 启动
• 如果安装集群版，需要将修改了配置的配置文件复制分发到其他节点，使用命令行 bash bin/start-all.sh 启动

4. 导入配置

• 启动之后访问新的企业版管理页面 http://192.168.xx.xx:8520，使用 admin/admin 登录
• 导入数据源、分组、API 配置

• 至此，新版本的软件就可以使用了

---

常见问题

启动端口占用

• 升级过程中，如果端口被占用，请先停止正在使用的旧版本软件服务，或者修改新版本软件的端口号并重新启动
• 端口在 conf/application-standalone.properties 文件中修改

版本兼容性

• 旧版本软件版本号过低，导出的数据源、分组、API 配置文件可能无法在新版本软件中导入，这是因为元数据结构变化了
• 付费用户可联系客服寻求技术支持，免费许可证用户请自行解决，或者在新版软件中重新手动创建

许可证自助获取

• 如果您是企业版用户，需要升级到新版本的企业版，可以联系客服获取新的许可证，也可以在官网自助获取新的企业版许可证
• 点击 这里，先填写您的序列号和旧版本的许可证（可在邮件中获取旧版本的许可证）来验证您的身份，然后按照提示填写邮箱和新的软件版本号，点击按钮即可获得新的许可证