Документация

СУБД «Енисей»

Краткая характеристика СУБД

Программное изделие СУБД «Енисей» представляет собой систему управления базами данных, относящуюся к типу «NoSQL» и реализующую следующие целевые функции:

  1. Предоставление прикладного программного интерфейса стандарта «REST API», основанного на протоколе HTTP, обеспечивающем простоту и функциональность взаимодействия с СУБД.
  2. Обеспечение легкости освоения и использования СУБД за счет простотой структуры документов и небольшого числа методов протокола HTTP (GET, PUT, DELETE).
  3. Хранение данных в виде гибкой, основанной на JSON-формате, структуре.
  4. Предоставление пользователям эффективных средств сопоставления данных, позволяющих запрашивать, комбинировать и фильтровать информацию.
  5. Обеспечение простой в использовании репликации данных с несколькими инициаторами (multi-master replication), с помощью которой можно копировать, распределять и синхронизировать данные между несколькими серверами, объединенными в группу средств вычислительной техники (СВТ).
  6. Использование модели данных со следующими ключевыми особенностями:
    • База данных является самой внешней структурой данных / контейнером в СУБД «Енисей».
    • Каждая база данных представляет собой набор независимых документов.
    • Каждый документ поддерживает свои собственные данные и автономную схему.
    • Метаданные документа содержат информацию о редакции, что позволяет объединить различия, возникшие при отключении баз данных.
    • СУБД «Енисей» реализует управление несколькими версиями параллелизма, чтобы избежать необходимости блокировать поле базы данных во время записи.

Установка

СУБД "Енисей" может устанавливаться на серверах и рабочих станциях, работающих под управлением ОС Linux. Поддерживаются дистрибутивы Astra Linux 2.12, REDOS 7.3, Debian 11 и Ubuntu 20.04.

Для запуска процесса установки СУБД "Енисей" необходимо наличие у пользователя прав на выполнение команды sudo и предварительно установленных программных пакетов: git, curl и wget.

Чтобы установить СУБД "Енисей" достаточно из домашнего каталога пользователя выполнить в командной строке ОС Linux следующие команды:

curl -fsSL http://docs.yeniseidb.ru/run.sh | sh

cd distrib

sudo ./install.sh

Альтернативно можно загрузить экземпляр ПО СУБД "Енисей" по ссылке: https://docs.yeniseidb.ru/distrib.tar.gz
Для установки СУБД "Енисей" из архивного файла distrib.tar.gz необходимо выполнить в командной строке ОС Linux следующие команды: 

sudo -i

wget https://docs.yeniseidb.ru/distrib.tar.gz

tar xf distrib.tar.gz

cd distrib

./install.sh

Процесс установки занимает от нескольких минут до нескольких десятков минут, в зависимости от количества обновляемых пакетов и скорости интернет-канала.

По окончании установки инсталляционный сценарий будет ожидать запуска веб-интерфейса консоли управления Imagenarium, выводя на экран сообщения вида:

[IMAGENARIUM]: Ожидание запуска консоли управления ...

В случае успешного запуска консоли управления на экране появится надпись:

[IMAGENARIUM]: Выполнено

Для подключения к консоли управления СУБД "Енисей" в адресной строке браузера ввести:

http://<IP адрес>:5555/

где <IP адрес> - адрес сетевого интерфейса сервера, на который установлено ПО СУБД "Енисей"

Учетные данные для входа в консоль управления по умолчанию - (admin / YeniPass#123).

Далее в пользовательском интерфейсе консоли администратора СУБД "Енисей" необходимо выбрать вариант развертывания (single - однонодовое развертывание, или cluster - развертывание на предварительно сформированном Docker Swarm кластере). Более подробная информация об установке ПО СУБД "Енисей" в Руководстве системного программиста (Руководство_системного_программиста_RU_врмн.582913-01-32-01-30.08.2022-08.pdf)

Техническая документация на ПО СУБД «Енисей» состоит из:

Руководства системного программиста, в котором определены требования к техническим характеристикам аппаратного обеспечения, на котором возможен запуск ПО, перечислено программное обеспечение необходимое для функционирования СУБД «Енисей», описан процесс установки и начальной настройки ПО, приведены методы проверки работоспособности установленного ПО;

Руководства оператора, содержащем информацию о назначении ПО, технических требованиях к аппаратному обеспечению, описание пользовательского интерфейса и основных функций;

Руководства программиста, в котором приведена информация о программном интерфейсе (API) платформы, характеристиках ПО, способах обращения к методам программного интерфейса ПО.

Руководства по поддержанию жизненного цикла ПО, в котором описаны процессы разработки, тестирования и сопровождения ПО СУБД «Енисей».

Руководство системного программиста - Руководство_системного_программиста_RU_врмн.582913-01-32-01-30.08.2022-08.pdf

Руководство оператора - Руководство_оператора_RU_ВРМН.528913-01-34-01-29.08.2022-13.pdf

Руководство программиста - Руководство_программиста_RU_ВРМН.528913-01-33-01-30.08.2022-02.pdf

Руководство по поддержанию жизненного цикла ПО - Руководство_по_поддержанию_жизненного_цикла_ПО_RU_ВРМН.528913-01-34-01-30.08.2022-01.pdf

©2022 ООО "Эквирон"