Конструктор запросов в базу данных

Простой

Конструктор запросов в базу данных — это приложение для BPMSoft, которое позволяет выполнять SQL-запросы из интерфейса системы для управления информацией в базе данных. Используя функциональность приложения, можно просматривать, создавать, редактировать и удалять записи в таблицах. Приложение доступно на двух языках: русский и английский.

Установка приложения

Установите приложение «Конструктор запросов в БД». Подробнее: Установка приложений

Примечание. После установки приложения необходимо повторно авторизоваться в BPMSoft.

В результате в блоке «Конфигурирование разработчиком» дизайнера системы будет доступен раздел «Конструктор запросов в БД».

Рисунок 1 — Результат установки конструктора запросов в БД

Настройка прав доступа на раздел «Конструктор запросов в БД»

Пользователи со следующими правами на операции могут использовать конструктор запросов в БД:

«Доступ к просмотру данных в приложении «Конструктор запросов в БД» (код BpmsCanReadQueryBuilder) — позволяет просматривать данные в таблицах;
«Доступ к изменению и удалению данных в приложении «Конструктор запросов в БД» (код BpmsCanUseQueryBuilder) — позволяет просматривать, редактировать и удалять данные в таблицах;
«Доступ к просмотру системных таблиц в приложении «Конструктор запросов в БД» (код BpmsCanReadSystemTablesQueryBuilder) — позволяет просматривать данные в системных таблицах;
«Доступ к логам приложения «Конструктор запросов в БД» (код BpmsCanGenerateLogsQueryBuilder) — позволяет просматривать логи запросов в разделе «Конструктор запросов в БД».
«Доступ к экспорту результатов выполнения SQL-запросов в приложении «Конструктор запросов в БД» (код BpmsCanExportResultQueryBuilder) — позволяет экспортировать результаты выполнения SQL-запросов в приложении «Конструктор запросов в БД».
«Доступ к экспорту логов из приложения «Конструктор запросов в БД» (код BpmsCanExportLogsQueryBuilder) — позволяет экспортировать логи из приложения «Конструктор запросов в БД».

Примечание. При получении прав на выполнение любой из указанных операций пользователь получает доступ к приложению в дизайнере системы. Подробнее: Настройка доступа к операциям

Действия раздела «Конструктор запросов в БД»

В разделе «Конструктор запросов в БД» представлен набор действий, описание которых приведено в таблице.

Таблица 1 — Описание действий раздела «Конструктор запросов в БД»

Действие	Описание
Показать системные таблицы	Действия предназначены для управления отображением списка системных таблиц в общем реестре раздела. Действия доступны, если пользователь имеет права доступа на системную операцию: «Доступ к просмотру системных таблиц в приложении «Конструктор запросов в БД» (код BpmsCanReadSystemTablesQueryBuilder). Подробнее: Настройка доступа к операциям
Скрыть системные таблицы
Показать лог запросов в БД	Действие предназначено для просмотра и анализа всех запросов, которые были выполнены к базе данных. Действие доступно, если пользователь имеет право доступа на системную операцию «Доступ к логам приложения «Конструктор запросов в БД» (код BpmsCanGenerateLogsQueryBuilder). Подробнее: Настройка доступа к операциям

Работа с данными в разделе «Конструктор запросов в БД»

В разделе «Конструктор запросов в БД» можно сформировать SQL-запросы для просмотра необходимой информации, обновления данных или их удаления.

Для создания SQL-запроса:

Откройте дизайнер системы, нажав на кнопку .
Перейдите в раздел «Конструктор запросов в БД».
В реестре раздела откройте необходимую таблицу.
Нажмите на кнопку Конструктор запросов.
В открывшемся окне конструктора нажмите на « Добавить условие» и выберите необходимое условие для построения запроса.
Добавьте колонку фильтрации, нажав на кнопку « Добавить колонку»:
- В поле «Колонка» выберите код колонки, по которой будет строится таблица запроса;
- При необходимости укажите «Псевдоним» для колонки. Псевдоним заменяет код колонки в реестре на указанное название;
- При необходимости установите признак «Агрегатная функция» для определения минимального, среднего, максимального, текущего или суммарного значения.

Примечание. Использование агрегатной функции возможно для построения запросов с датами и числовыми колонками.

Нажмите кнопку «Выполнить».

После выполнения запроса отобразится результат выборки, который содержит данные, соответствующие заданным в запросе критериям. Также результаты выборки можно отсортировать по одной из колонок. Подробнее: Сортировка записей реестра

При необходимости измените критерии запроса и повторно нажмите «Выполнить». Для сброса параметров запроса нажмите «Очистить».

Для построения запроса доступны команды и условия, указанные в таблицах ниже.

Таблица 2 — Описание команд из раздела «Конструктор запросов в БД»

Команда запроса	Описание
SELECT	Используется для выборки данных из таблицы. Можно выбрать конкретные колонки, данные по которым необходимы. Если колонки не будут указаны, то в выборке отобразятся все существующие колонки объекта. Условие FROM заполняется автоматически значением таблицы, в которой выполняется запрос
INSERT INTO	Используется для добавления данных в таблицу. Укажите колонки и их значения в условии VALUES для создания новой записи в таблице
UPDATE	Позволяет изменять существующие записи в таблице. Укажите в условии SET новое значение и запись, в которой его необходимо обновить, добавив условие WHERE. Если не указать условие WHERE, то будут изменены все записи таблицы
DELETE	Используется для удаления записей из таблицы. Укажите в условии WHERE записи, которые необходимо удалить, или их характеристики

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

Таблица 3 — Описание условий доступных в разделе «Конструктор запросов в БД»

Условия запроса		Описание
JOIN	INNER	Выбирает записи, имеющие совпадающие значения в обеих таблицах
	LEFT OUTER	Возвращает все записи из левой таблицы (table1) и совпадающие записи из правой таблицы (table2). При отсутствии совпадений в правой таблице (table2) запрос ничего не возвращает
	RIGHT OUTER	Возвращает все записи из правой таблицы (table2) и совпадающие записи из левой таблицы (table1). При отсутствии совпадений в левой таблице (table1) запрос ничего не возвращает
	FULL OUTER	Возвращает все записи, когда есть совпадение в записях таблицы left (table1) или right (table2). При отсутствии совпадений в обеих таблицах как с одной стороны, так и с другой, запрос ничего не возвращает
	CROSS	Объединяет каждую запись из таблицы left (table1) с каждой записью из таблицы right (table2)
GROUP BY		Группирует строки, которые имеют одинаковые значения в указанных колонках, и позволяет применять агрегатные функции, например, для определения количества контактов каждого возраста
WHERE		Используется для фильтрации строк в запросах, что позволяет выбирать только те данные, которые соответствуют заданным критериям

Если в выпадающем списке не выбран конкретный тип соединения «JOIN», BPMSoft автоматически применит «INNER JOIN» как значение по умолчанию.

Примечание. Предел длительности получения ответа на запрос определяется системной настройкой «Таймаут для сервисов конструктора запросов(мс)» (код BpmsServiceTimeout). Значение по умолчанию — 60000 мс.

Сохранение запросов

Вы можете сохранить настроенный запрос для последующего использования. Для сохранения запроса нажмите «Сохранить как», в открывшемся окне введите его название и нажмите «Сохранить».

Рисунок 2 — Кнопка «Сохранить как» в интерфейсе Конструктора запросов в БД

Рисунок 2 — Кнопка Сохранить как в интерфейсе Конструктора запросов в БД

Сохраненные запросы будут доступны по кнопке «Сохраненные запросы» в панели конструктора запросов в БД.

Рисунок 3 — Кнопка «Сохраненные запросы» и блок запросов

Рисунок 3 — Кнопка Сохраненные запросы и блок запросов

Для работы с сохраненными запросами нажмите кнопку «Сохраненные запросы». Слева откроется блок со списком ранее сохраненных запросов. Нажмите на справа от названия запроса для появления выпадающего меню действий:

«Выполнить» — выполняет запрос и отображает результат;
«Изменить» — открывает блок с параметрами запроса. Внесенные изменения можно сохранить в данную запись по кнопке «Сохранить»;
«Переименовать» — изменяет название запроса;
«Удалить» — удаляет запрос из списка сохраненных;
«Копировать» — дублирует запрос с сохранением параметров.

Рисунок 4 — Действия меню для выбранного сохраненного запроса

Примечание. Максимальное количество сохраненных SQL запросов ограничено системной настройкой «Максимальное количество сохраненных SQL запросов» (код BpmsQueryBuilderMaxSavedQueriesCount). Значение по умолчанию: 10000.

Примечание. Для переноса сохраненных запросов требуется привязка данных к объекту BpmsQueryBuilderSavedQuery.

История запросов

Для просмотра история запросов:

Нажмите на кнопку «Действия» в разделе «Конструктор запросов в БД»
Выберите «Показать лог запросов в БД».

Рисунок 5 — Действия доступные в разделе «Конструктор запросов в БД»

На странице логирования отображается информация о запросе:

ID запроса;
Статус;
Дата и время выполнения;
Пользователь, выполнивший запрос;
Текст запроса или текст ошибки при условии, если запрос завершился не успешно.

Рисунок 6 — Страница логирования

Для анализа истории выполненных запросов воспользуйтесь функциональностью конструктора SQL-запросов. Сформируйте нужный запрос с помощью команды SELECT и необходимых условий.

Экспорт логов и истории запросов

BPMSoft позволяет экспортировать историю запросов в разделе «Конструктор запросов в БД». Для экспорта необходимо настроить доступ к операциям «Доступ к экспорту логов из приложения «Конструктор запросов в БД» (код BpmsCanExportLogsQueryBuil) и «Доступ к экспорту результатов выполнения SQL-запросов в приложении «Конструктор запросов в БД» (код BpmsCanExportResultQueryBuilder).

Экспорт истории запросов доступен в форматах «CSV» и «Excel». Для этого:

Перейдите в раздел «Конструктор запросов в БД» и откройте необходимую таблицу из реестра.
Нажмите на кнопку «Экспорт» и выберите необходимый формат.

Экспорт логов запросов доступен в форматах «CSV» и «Excel». Для этого:

Перейдите в раздел «Конструктор запросов в БД».
Нажмите на кнопку «Действия» → «Показать лог запросов в БД».
Установите необходимые условия фильтрация для записей.
Нажмите на кнопку «Экспорт» и выберите необходимый формат.

Примечание. При экспорте в «CSV» можно установить необходимый разделитель, используя системную настройку «Разделитель при экспорте в “.csv”» (код CSVDelimiter). Значение по умолчанию: «;».

Примечание. Количество экспортируемых записей логов настраивается в системной настройке «Максимальное количество экспортируемых записей логов и результата SQL-запросов» (код BpmsQueryBuilderMaxExportRecordsCount). Значение по умолчанию: 2000.