DBAPI

# 升级指南

# 概述

  • 此文档主要分 3 部分，从企业版升级到企业版，个人版升级到企业版，个人版升级到个人版。
  • 升级都需要重新下载新的软件包解压安装，并填写新的许可证才能启动使用。
  • 升级的数据迁移分 2 种情况，如果旧版本系统使用的元数据库是 mysql，那么新版本可以沿用旧的元数据库地址，只需要在新版本配置修改元数据库地址即可。如果旧版本系统使用的元数据库是自带的 sqlite，那么需要先从旧版本软件系统导出数据源、分组、API 配置，再导入到新版本系统中。

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

查看版本更新日志请点击此处

# 企业版升级到企业版

# 下载软件包解压，获取许可证

  • 下载新版本企业版软件并解压

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

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

# 如果旧版本软件使用的元数据库是 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:3306/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

# 启动新版本

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

  • 启动之后即可使用，原来的 API 都在新版本中

# 如果旧版本软件使用的元数据库是自带的 sqlite，请阅读以下

# 导出配置

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



# 修改新版本配置

# 启动新版本

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

# 导入配置

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



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

# 个人版升级到个人版

# 下载软件包解压，获取许可证

  • 下载新版本个人版软件并解压

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

# 如果旧版本软件使用的元数据库是 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:3306/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

# 启动新版本

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

# 如果旧版本软件使用的元数据库是自带的 sqlite，请阅读以下

# 导出配置

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



# 修改新版本配置

# 启动新版本

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

# 导入配置

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

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

# 个人版升级到企业版

# 下载企业版软件包解压，获取许可证

  • 下载企业版软件并解压

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

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

# 导出配置

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



# 修改新版本配置

# 启动企业版软件

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

# 导入配置

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



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

# 常见升级问题

# 启动端口占用

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

# 版本兼容性问题

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

# 企业版许可证自助获取

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