Основные этапы настройки SQL Backend

Основные этапы настройки SQL Backend:

1. Создание в ViQube таблиц, идентичных в используемой SQL-СУБД
2. Подготовка и применение структуры маппинга с помощью API

Создание таблиц, идентичных SQL-СУБД

В ViQube необходимо создать такие же таблицы, как и в используемой SQL-СУБД. 

1. ViQube берет запрос и транслирует в SQL, запрос выполняется и возвращаются данные. Эти данные попадают в таблицу с результатом. Поэтому в ViQube должна быть точно такая же структура таблицы с точно такими же типами полей, чтобы можно было вывести результирующую таблицу.
2. Наименования таблицы и столбцов могут отличаться, но типы данных должны быть одинаковыми. Это необходимо для корректного маппинга при трансляции запросов в SQL-СУБД.
3. Если в таблице в SQL-СУБД есть дополнительные столбцы, которых нет в таблице в ViQube и их использовать не планируется, то такое расхождение а таблицах допустимо. ViQube просто будет их игнорировать, если не указывать их в настройках SQL Backend.

Работа с SQL Backend на ViQube происходит с помощью запросов по API. 

Проверка текущих настроек - GET

1. Чтобы просмотреть текущие настройки SQL Backend необходимо отправить GET-запрос:

   curl --location --request GET 'http://192.168.4.101/viqube/sqlbackend' \
   --header 'X-API-VERSION: 3.8' \
   --header 'Authorization: 'Bearer <token>'

   IP адрес, HTTP/HTTPS и <Bearer token> необходимо заменить на свои. Как получить <Bearer token> описано в разделе Получение токена аутентификации. 
   X-API-VERSION 3.8 актуальна для 2.27, и может быть другой для вашей версии платформы.
   На время тестирования авторизацию на ViQube можно отключить, в таком случае заголовок Authorization не нужен.

2. В ответе получаем следующие настройки SQL Backend (по умолчанию):

   {
     "enabled": false,
     "jdbcOptions": {
       "connection": ""
     },
     "sqlMapping": {}
   }

Применение новых настроек - PUT

1. Чтобы применить новые настройки SQL Backend необходимо отправить PUT-запрос с подготовленными настройками. Подробное описание структуры настроек приведено в разделе "Структура настроек SQL Backend".
2. В случае успешного применения настроек будет возвращено "200".
3. После успешного применения настроек все таблицы, которые были настроены на SQL-СУБД при запросах будут обращаться напрямую в SQL-СУБД, а не ViQube.

Структура настроек SQL Backend

Настройки SQL Backend состоят из:

• строки подключения, параметров подключения
• описания соответствия таблиц и колонок в ViQube и SQL-СУБД

"name_in_viqube": {"OFF": "name_in_sql"}

Отключение SQL Backend

1. Чтобы полностью выключить режим SQL Backend необходимо отправить PUT-запрос:

   {
       "enabled": false,
       "jdbcOptions": {
           "connection": ""
       },
       "sqlMapping": {}
   }

2. В случае успешного применения настроек будет возвращено "200".

3. Теперь при запросе настроек с помощью GET-запроса, будут возвращены исходные настройки:

   {
     "enabled": false,
     "jdbcOptions": {
       "connection": ""
     },
     "sqlMapping": {}
   }

Пример настройки

Пример настройки SQL Backend на ClikHouse: