DBAPI

# Upgrade Guide

# Overview

  • This document is mainly divided into 3 parts: Enterprise Edition upgrade to Enterprise Edition, Personal Edition upgrade to Enterprise Edition, and Personal Edition upgrade to Personal Edition.
  • All upgrades require downloading and extracting the new software package, and filling in a new license to start using it.
  • Data migration during upgrades falls into 2 scenarios. If the old version system uses mysql as the metadata database, the new version can continue using the old metadata database address by simply modifying the metadata database address in the new version configuration (unless there is a large version gap and the metadata table structure has changed, requiring manual execution of SQL to modify the table structure, please see the incompatible version notes in Version Update Log). If the old version system uses the built-in sqlite, you need to first export the data sources, groups, and API configurations from the old version software system, and then import them into the new version system.

Note that this document defaults to operation instructions under Linux system. If it's a Windows system, please right-click the bin/dbapi.ps1 file and select Run with PowerShell to start the software

You can self-service obtain commercial licenses for upgrade versions (opens new window)

# Enterprise Edition Upgrade to Enterprise Edition

# Download Software Package and Extract, Obtain License

  • Download the new version Enterprise Edition software and extract it

  • Start directly with command line bash bin/dbapi-daemon.sh start standalone, find the serial number at the bottom of the log file logs/dbapi-standalone.log, contact customer service, provide the new serial number, replace with a new license, and fill the new license into the conf/key.properties file

Note that if you want to install the cluster version, you need to copy the new version software package to other servers, and repeat the above steps on each server (obtain serial number, obtain new license, fill in new license)

# If the Old Version Software Uses MySQL as Metadata Database, Please Read the Following

# Modify New Version Configuration

  • Modify the metadata database address in the new version configuration conf/application.properties to point to the metadata database address of the old version Enterprise Edition software

# Metadata database address configured to use the mysql address of the old version
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

# If a log database is used, configure the log database address to use the address of the old version
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

# Start New Version

  • If installing standalone version, start directly with command line bash bin/dbapi-daemon.sh start standalone. If installing cluster version, you need to copy and distribute the modified configuration files to other nodes, and start with command line bash bin/start-all.sh

  • After startup, you can use it, and all original APIs are in the new version

# If the Old Version Software Uses Built-in SQLite, Please Read the Following

# Export Configuration

  • Need to first export data sources, groups, and API configurations from the old version software system



# Modify New Version Configuration

# Start New Version

  • If installing standalone version, start directly with command line bash bin/dbapi-daemon.sh start standalone. If installing cluster version, you need to copy and distribute the modified configuration files to other nodes, and start with command line bash bin/start-all.sh

# Import Configuration

  • After startup, access the new version software page http://192.168.xx.xx:8520, log in with admin/admin
  • Import data sources, groups, and API configurations



  • At this point, the new version software can be used.

# Personal Edition Upgrade to Personal Edition

# Download Software Package and Extract, Obtain License

  • Download the new version Personal Edition software and extract it

  • Start directly with command line bash bin/dbapi-daemon.sh start standalone, find the serial number at the bottom of the log file logs/dbapi-standalone.log, use the serial number to apply for a new free license or purchase a Personal Edition commercial license, and fill the new license into conf/key.properties

# If the Old Version Software Uses MySQL as Metadata Database, Please Read the Following

# Modify Configuration

  • Modify the metadata database address in the new version configuration conf/application.properties to point to the metadata database address of the old version software
# Metadata database address configured to use the mysql address of the old version
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

# If a log database is used, configure the log database address to use the address of the old version
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

# Start New Version

  • Start directly with command line bash bin/dbapi-daemon.sh start standalone.
  • After startup, you can use it, and all original APIs are in the new version

# If the Old Version Software Uses Built-in SQLite, Please Read the Following

# Export Configuration

  • Need to first export data sources, groups, and API configurations from the old version software system



# Modify New Version Configuration

# Start New Version

  • Start directly with command line bash bin/dbapi-daemon.sh start standalone.

# Import Configuration

  • After startup, access the new version software page http://192.168.xx.xx:8520, log in with admin/admin
  • Import data sources, groups, and API configurations

  • At this point, the new version software can be used.

# Personal Edition Upgrade to Enterprise Edition

# Download Enterprise Edition Software Package and Extract, Obtain License

  • Download Enterprise Edition software and extract it

  • Start directly with command line bash bin/dbapi-daemon.sh start standalone, find the serial number at the bottom of the log file logs/dbapi-standalone.log, use the serial number to purchase a license, and fill the new license into conf/key.properties

Note that if you want to install the cluster version, you need to copy the Enterprise Edition software package to other servers, and repeat the above steps on each server (obtain serial number, obtain new license, fill in new license)

# Export Configuration

  • Need to first export data sources, groups, and API configurations from the old Personal Edition software



# Modify New Version Configuration

# Start Enterprise Edition Software

  • If installing standalone version, start directly with command line bash bin/dbapi-daemon.sh start standalone. If installing cluster version, you need to copy and distribute the modified configuration files to other nodes, and start with command line bash bin/start-all.sh

# Import Configuration

  • After startup, access the new Enterprise Edition management page http://192.168.xx.xx:8520, log in with admin/admin
  • Import data sources, groups, and API configurations



  • At this point, the new version software can be used.

# Common Upgrade Issues

# Port Occupation on Startup

  • During the upgrade process, if the port is occupied, please first stop the currently used old version software service, or modify the port number of the new version software and restart. The port can be modified in the conf/application-standalone.properties file

# Version Compatibility Issues

  • If the old version software version number is too low, the exported data sources, groups, and API configuration files may not be importable in the new version software due to metadata structure changes. Paid users can contact customer service for technical support, free license users should resolve it themselves, or manually recreate in the new version software

# Enterprise Edition License Self-Service Acquisition

  • If you are an Enterprise Edition user and need to upgrade to a new version of Enterprise Edition, you can contact customer service to obtain a new license, or self-service obtain a new Enterprise Edition license on the official website. Click here (opens new window), first fill in your serial number and old version license (can be obtained from email) to verify your identity, then follow the prompts to fill in email and new software version number, click the button to obtain a new license