Использование программного компонента в клиентском приложении для Microsoft Windows#

Основные области страниц#

Все страницы в продукте композиционно состоят из двух областей: панель основного меню (1) и рабочая область (2).

Панель основного меню#

На панели основного меню расположены основные вкладки и управляющие элементы интерфейса.

Краткое описание элементов

Кластеры#

Данная вкладка является стартовой страницей Kintsugi для Microsoft Windows.

Описание вкладки#

На рисунке представлен внешний вид рабочей области Кластеры, которая состоит из двух основных разделов:

• меню навигации с одним кластером, доступным текущему пользователю;

• основная рабочая область с SQL-редактором.

Краткое описание основных управляющих элементов:

Выполнение запросов к СУБД#

На рисунке представлен внешний вид рабочей области SQL-редактор.

Основные функции:

• выполнение произвольной команды SQL;

• отображение текущего состояние подключения и транзакции;

• просмотр плана выполнения инструкции SQL в текстовом, графическом или табличном формате (аналогично https://explain.depesz.com);

• просмотр истории выполнения команд SQL;

• просмотр структуры выбранной БД;

• просмотр уведомлений SQL-команд.

Рабочая область SQL-редактор содержит набор вкладок – подключений к выбранной БД, а также элементов, предоставляющих обзор объектов выбранной БД.

Краткое описание основных управляющих элементов:

СУБД PostgreSQL предполагает что функциональность autocommit выполняется на клиентской стороне. Стандартное поведение PostgreSQL - это фиксация каждой транзакции после ее выполнения. Поэтому для того, чтобы отключить autocommit, необходимо явным образом открыть транзакцию выполнив одну из команд (BEGIN, START TRANSACTION).

Обратите внимание, что существует список команд, запрещенных к выполнению в открытой транзакции. Для ознакомления со списком команд смотрите документацию PostgreSQL.

Дополнительная функциональность#

Просмотр общей информации о СУБД#

Для получения быстрого обзора информации о СУБД:

1. Установите подключение к СУБД.

2. В открывшемся списке доступных БД для подключения выберите пункт меню Общие.

3. В рабочей области откроется панель быстрого обзора. Панель быстрого обзора СУБД состоит из следующих элементов:

   • Топ-5 запросов по количеству строк, полученных или затронутых запросом;

   • Топ-5 запросов с наибольшим общим временем, затрачиваемым на запрос в миллисекундах.

   

Выполнение команды в БД#

Для выполнения команды в БД:

1. Выберите нужный объект кластера в навигационной области экранной формы.

2. Разверните список БД, нажав на нужный объект кластера.

3. Нажмите кнопку + SQL-редактор для открытия рабочей области.

4. В рабочей области откроется панель с рабочей областью для ввода кода.

5. Введите необходимые SQL-команды.

6. Нажмите кнопку . Команда будет выполнена, и под блоком кода в панели результатов отобразится вывод выполнения команды.

Выполнение команды с Explain#

Сценарий аналогичен сценарию «Выполнение команды в базе данных» за исключением пункта 5:

• Нажмите кнопку . Команда будет выполнена, и под блоком кода в панели результатов отобразится вывод выполнения команды с Explain в графическом, табличном и оригинальном виде.

Просмотр структуры базы данных#

На рисунке показан интерфейс для получения дерева объектов текущей базы данных. Каждая ветвь дерева ведет к объекту соответствующего типа. Доступ к объекту осуществляется согласно роли, открывшей соединение. Также каждый конечный объект дерева возможно открыть на просмотр для получения большего количества параметров объекта.

Получение информации об объектах БД#

Для получения информации об объектах БД:

1. Выберите доступную БД.

2. Нажмите кнопку + SQL-редактор.

3. В рабочей области откроется панель с рабочей областью для ввода кода.

4. Слева от рабочей области выберите вкладку Структура.

5. Откроется структура текущей БД + роли и табличные пространства.

6. Выберите один элемент из дерева и раскройте пока не дойдете до конечного элемента в ветке.

7. Нажмите правой кнопкой мыши на конечный элемент и выберите Свойства.

8. Откроется модальное окно с детальными свойствами объекта.

На скриншоте представлен пример окна с детальными свойствами таблицы «setting».

Клавиатурные сокращения#

Метрики#

Вкладка Метрики содержит кластер с одним экземпляром объекта мониторинга и панелей метрик мониторинга.

Основные функции:

• просмотр обзорной информации об объекте мониторинга;

• получение значений метрик.

Описание вкладки#

На рисунке представлен внешний вид вкладки Метрики.

Панели мониторинга#

Для доступа к панелям мониторинга нажмите левой кнопкой мышки на доступный объект мониторинга и в открывшемся меню выберите необходимую панель мониторинга:

• Autovacuum и vacuum;

• Bgwritter и checkpoints;

• Буферы;

• Взаимные блокировки;

• Информация о производительности.

Все панели мониторинга, кроме Информация о производительности, обладают схожим интерфейсом:

Краткое описание основных управляющих элементов:

Интерфейс панели мониторинга Информация о производительности представлен на картинке:

Рабочая область панели мониторинга Информация о производительности делится на три основные части:

• основные управляющие элементы (А);

• графики значений мониторинга (Б);

• табличные данные (В).

К основным управляющим элементам (А) относятся:

При нажатии в поле Период откроется окно детальной настройки временного диапазона выборки данных. Внешний вид представлен ниже:

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

В области графиков значений мониторинга (Б) содержатся:

Цветовая палитра общего и детального графиков может меняться в зависимости от выбранного типа разреза (2).

В области табличных данных (В) содержатся:

В таблице «Топ активностей БД» выводится информация:

Примечание:

* Для расшифровки аббревиатуры «СКАС» нажмите кнопку «» или ознакомьтесь с документом «Термины и сокращения».

** При задании значения в поле Поиск, фильтр применяется к открытой вкладке таблицы «Топ активностей БД» и остается активным даже при переключении между вкладками.

Получение значений метрик#

Просмотр общей информации об объекте мониторинга#

Для получения быстрого обзора информации об объекте мониторинга:

1. Нажмите левой кнопкой мышки на доступный объект мониторинга в меню второго уровня Экземпляры.

2. В открывшемся списке выберите пункт меню Общие.

3. В рабочей области откроется вкладка общей информации об объекте мониторинга, как показано на рисунке ниже.

Просмотр графиков мониторинга#

Для просмотра графиков мониторинга:

1. Перейдите во вкладку Метрики.

2. Выберите необходимый объект мониторинга в меню второго уровня из списка Экземпляры.

3. В открывшемся списке выберите необходимую панель мониторинга.

4. В рабочей области справа откроется график мониторинга, принадлежащих этой панели.