REST API

Содержание раздела
  1. Методы по управлению запросами SQL+
  2. Методы по управлению дельтами
  3. Методы по управлению схемой данных
  4. Методы по управлению компонентами
  5. Методы по управлению статистикой запросов
  6. Методы по управлению спецификацией

Методы по управлению запросами SQL+

POST /api/v1/datamarts[/{datamart}]/query
Выполняет запрос SQL+, указанный в теле сообщения

Методы по управлению дельтами

Дельта по номеру
GET /api/v1/datamarts/{datamart}/deltas/{deltaNum}
Возвращает информацию о дельте с номером {deltaNum}
Текущая/последняя дельта
GET /api/v1/datamarts/{datamart}/deltas/current
Возвращает информацию о текущей дельте по серверному времени
GET /api/v1/datamarts/{datamart}/deltas/latest
Возвращает информацию о последней закрытой дельте и горячей дельте
GET /api/v1/datamarts/{datamart}/deltas/latest/hot
Возвращает информацию о горячей дельте
GET /api/v1/datamarts/{datamart}/deltas/latest/ok
Возвращает информацию о последней закрытой дельте

Методы по управлению схемой данных

Все логические базы данных
GET /api/v1/datamarts
Возвращает список имен логических БД в текущем окружении
Логическая база данных
GET /api/v1/datamarts/{datamart}/entities
Возвращает список имен сущностей в логической БД {datamart}
POST /api/v1/datamarts/{datamart}/sync
Обновляет кэш по логической БД {datamart}, синхронизируя его с сервисной базой данных
Логическая сущность: таблица или представление
GET /api/v1/datamarts/{datamart}/entities/{entity}
Возвращает метаданные логической сущности {entity}
GET /api/v1/datamarts/{datamart}/entities/{entity}/ddl
Возвращает DDL-запрос на создание логической сущности {entity} в текущем состоянии

Методы по управлению компонентами

GET /api/v1/versions
Возвращает информацию о версиях программных компонентов: компонентов ноды Prostore и внешних компонентов

Методы по управлению статистикой запросов

Статистика всех логических баз данных
GET/POST /api/v1/datamarts/all/statistics
Возвращает/обнуляет статистику выполнения запросов по всем сущностям всех логических БД текущего окружения
Статистика логической базы данных
GET/POST /api/v1/datamarts/{datamart}/statistics
Возвращает/обнуляет статистику выполнения запросов по всем сущностям логической БД {datamart}
Статистика логической сущности: таблицы или представления
GET/POST /api/v1/datamarts/{datamart}/entities/{entity}/statistics
Возвращает/обнуляет статистику выполнения запросов по сущности {entity}

Методы по управлению спецификацией

GET /api/v1/swagger-ui
Возвращает HTML-страницу с OpenAPI-спецификацией в формате Swagger UI