DBAPI

Русский

简体中文
English
日本語
한국어
Français
Deutsch
Español
Português

Русский

简体中文
English
日本語
한국어
Français
Deutsch
Español
Português

Appearance

Руководство по обновлению ​

Общие сведения ​

  • Документ разделён на три основные части: обновление корпоративной версии, обновление персональной версии, переход с персональной версии на корпоративную.
  • При любом обновлении необходимо заново скачать новый пакет, распаковать его и установить, а также ввести новую лицензию для запуска.
  • Миграция данных при обновлении осуществляется в двух случаях:
    • Если в старой версии использовалась метабаза MySQL, то в новой версии можно оставить прежний адрес метабазы — достаточно изменить этот параметр в конфигурации новой версии (за исключением случаев значительного перехода между версиями, когда структура таблиц метаданных изменилась; в таких ситуациях потребуется вручную выполнить SQL‑запросы для изменения структуры — см. примечания о несовместимости в журнале обновлений).
    • Если в старой версии использовалась встроенная база данных SQLite, необходимо сначала экспортировать данные о источниках, группах и конфигурации API из старой системы, а затем импортировать их в новую систему.

[!ВАЖНО] Этот документ предполагает работу в среде Linux. Если вы используете Windows, щёлкните правой кнопкой мыши по файлу bin/dbapi.ps1 и выберите пункт «Запустить с помощью PowerShell», чтобы запустить программу.

[!ВАЖНО] Вы можете самостоятельно получить коммерческую лицензию для обновления.

Обновление корпоративной версии ​

1. Установка и получение лицензии ​

  • Скачайте новую версию корпоративной версии и распакуйте её.
  • Запустите программу командой bash bin/dbapi-daemon.sh start standalone. В конце лог‑файла logs/dbapi-standalone.log найдите серийный номер, свяжитесь со службой поддержки, предоставьте новый серийный номер, получите новую лицензию и укажите её в файле conf/key.properties.

[!ПРЕДУПРЕЖДЕНИЕ] Если вы планируете установить кластерную версию, скопируйте новый пакет на другие серверы и повторите вышеуказанные шаги (получение серийного номера, получение новой лицензии, ввод новой лицензии) на каждом из них.

2. Настройка миграции данных ​

Сценарий 1: Метабаза — MySQL ​

Настройка подключения к базе данных ​
  • Измените в конфигурационном файле новой версии conf/application.properties строку подключения к метабазе, указав адрес метабазы, используемый в старой версии:
properties
# Адрес метабазы, используемый в старой версии
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 доступны в новой версии.

Сценарий 2: Метабаза — SQLite ​

Экспорт конфигурации старой версии ​
  • Необходимо сначала экспортировать данные об источниках, группах и конфигурации API из старой версии.



Настройка новой версии ​
  • Следуйте инструкции по установке ([./install]) и внесите соответствующие изменения в конфигурацию.
Запуск службы ​
  • Для одиночной установки запустите командой 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. Настройка миграции данных ​

Сценарий 1: Метабаза — MySQL ​

Настройка подключения к базе данных ​
  • Измените в конфигурационном файле новой версии conf/application.properties строку подключения к метабазе, указав адрес метабазы, используемый в старой версии:
properties
# Адрес метабазы, используемый в старой версии
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 будут доступны в новой версии.

Сценарий 2: Метабаза — SQLite ​

Экспорт конфигурации старой версии ​
  • Необходимо сначала экспортировать данные об источниках, группах и конфигурации API из старой версии.



Настройка новой версии ​
  • Следуйте инструкции по установке ([./install]) и внесите соответствующие изменения в конфигурацию.
Запуск службы ​
  • Просто запустите командой 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. Настройка и запуск новой версии ​

  • Следуйте инструкции по установке ([./install]) и внесите соответствующие изменения в конфигурацию корпоративной версии.
  • Для одиночной установки запустите командой 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 могут не импортироваться в новую версию из‑за изменений в структуре метаданных.
  • Платные пользователи могут обратиться за технической поддержкой; владельцы бесплатных лицензий должны самостоятельно решить проблему либо заново создать соответствующие объекты в новой версии.

Самостоятельное получение лицензии ​

  • Если вы являетесь пользователем корпоративной версии и хотите обновиться до новой версии, свяжитесь со службой поддержки для получения новой лицензии или получите её самостоятельно на официальном сайте.
  • Перейдите по ссылке, введите свой серийный номер и данные старой лицензии (их можно найти в электронном письме), подтвердите свою личность, укажите адрес электронной почты и номер новой версии, после чего нажмите кнопку, чтобы получить новую лицензию.