PostgreSQL

Последняя версия: 1.3.0

Дистрибутив: образ плагина PostgreSQL

Описание

Плагин PostgreSQL предназначен для подключения Графини к PostgreSQL и совместимым СУБД, выполнения SQL-запросов и визуализации результатов. Поддерживается работа с Postgres 9+, Postgres PRO 13+ и Pangolin 4+.

В интерфейсе создания источника данных плагин отображается как Postgres.

Настройка

Ниже приведены реальные состояния формы создания источника данных Postgres в тёмной теме интерфейса Графини.

Базовая форма

Поля источника данных

Название в UI	Код поля	Тип	Обязательность	Значение по умолчанию	Примечание
Адрес	url	text	обязательно	пусто	Указывается адрес PostgreSQL-сервера. Практически удобно вводить host и порт в одном значении, например db.internal.example:5432.
Имя базы данных	dbName	text	обязательно	пусто	Имя целевой базы данных.
Режим ввода запросов пользователем	codeMode	radio	обязательно	Запрещен	Дополнительный режим. Управляет возможностью выполнять произвольные SQL-запросы из редактора запросов.
Пользователь	username	text	обязательно	пусто	Логин пользователя БД.
Пароль	password	password	обязательно	пусто	Пароль пользователя БД.
Пропустить проверку TLS	skipTls	radio	обязательно	Игнорировать	Триггерное поле. Управляет режимом TLS-проверки.
Время жизни кэша	ttl	number	необязательно	600	В секундах. 0 отключает кэширование.
SQL limit по умолчанию	defaultLimit	number	необязательно	500	Ограничение количества строк, если в запросе явно не указан LIMIT.
Код языка запросов	codeLang	text	необязательно	sql	Служебное поле только для чтения. Используется для подсветки SQL-синтаксиса.
Время ожидания подключения из пула	connectionTimeout	number	необязательно	30000	В миллисекундах. Диапазон 250..60000.
Частота опроса активного соединения	keepaliveTime	number	необязательно	1000	В миллисекундах. Должно быть меньше Максимальный срок присутствия соединения в пуле.
Максимальный срок присутствия соединения в пуле	maxLifetime	number	необязательно	1800000	В миллисекундах. Диапазон 30000..172800000.
Максимальный размер пула	maximumPoolSize	number	необязательно	5	Количество соединений в пуле. Диапазон 1..10.
Максимальное время простоя соединения в пуле	idleTimeout	number	необязательно	600000	В миллисекундах. Диапазон 10000..172800000.
Минимальное количество простаивающих соединений	minimumIdle	number	необязательно	1	Диапазон 1..10.

Динамические поля и зависимости

У формы источника данных есть одно триггерное поле: Пропустить проверку TLS.

1. Если выбрано Игнорировать, дополнительных TLS-полей не появляется.
2. Если выбрано Проверять, появляется поле Tls сертификат.
3. Поле Tls сертификат принимает сертификат в текстовом формате PEM.
4. Подсказка в поле: Начинается с --- BEGIN CERTIFICATE ---.

Проверка TLS

Дополнительный режим ввода SQL и пример заполнения

Для Postgres доступен дополнительный режим Режим ввода запросов пользователем:

• Запрещен: произвольный SQL из редактора запросов недоступен, работа строится через конструктор запроса.
• Разрешен: пользователь может выполнять SQL-запросы напрямую, а также использовать SQL при получении значений переменных.

Ниже показан пример заполненной формы с включённым режимом Разрешен, проверкой TLS и изменёнными параметрами пула соединений.

Правила заполнения, важные для проверки подключения

• Для запуска проверки в форме должны быть выбраны тип источника данных и заполнено имя источника.
• Для успешной проверки подключения обязательно заполните Адрес, Имя базы данных, Пользователь и Пароль.
• Плагин использует единственный вариант аутентификации: логин и пароль пользователя PostgreSQL.
• При значении Пропустить проверку TLS = Игнорировать подключение выполняется без проверки сертификата.
• При значении Пропустить проверку TLS = Проверять используется проверка TLS. Для серверов с собственным или самоподписанным сертификатом обычно требуется заполнить Tls сертификат.
• Если в Tls сертификат вставлен некорректный текст, проверка подключения завершится ошибкой обработки TLS-сертификата.
• Значение Частота опроса активного соединения должно быть меньше значения Максимальный срок присутствия соединения в пуле.
• Если SQL limit по умолчанию оставить пустым, по умолчанию применяется значение 500.
• Значение SQL limit по умолчанию = 0 снимает ограничение по количеству строк, но может привести к перегрузке адаптера при тяжёлых запросах.

Порядок создания источника данных

1. Откройте раздел Источники данных.
2. Нажмите Добавить источник данных.
3. В поле Источник данных укажите понятное имя подключения.
4. В поле Тип выберите Postgres.
5. Заполните Адрес и Имя базы данных.
6. Укажите Пользователь и Пароль учетной записи PostgreSQL.
7. В поле Пропустить проверку TLS выберите нужный режим: Игнорировать, если сертификат проверять не нужно; Проверять, если требуется TLS-проверка, и при необходимости вставьте сертификат в Tls сертификат.
8. При необходимости включите Режим ввода запросов пользователем = Разрешен, если пользователям нужен прямой ввод SQL.
9. При необходимости скорректируйте Время жизни кэша, SQL limit по умолчанию и параметры пула соединений.
10. Нажмите Проверить соединение.
11. После успешной проверки нажмите Сохранить.

Пример заполнения без проверки TLS

• Источник данных: понятное имя подключения, например Postgres Demo
• Тип: Postgres
• Адрес: db.internal.example:5432
• Имя базы данных: metrics
• Режим ввода запросов пользователем: Запрещен или Разрешен в зависимости от политики доступа к SQL
• Пользователь: grafina_reader
• Пароль: пароль пользователя БД
• Пропустить проверку TLS: Игнорировать

Пример заполнения с проверкой TLS

• Источник данных: Postgres Demo
• Тип: Postgres
• Адрес: db.internal.example:5432
• Имя базы данных: metrics
• Пользователь: grafina_reader
• Пароль: пароль пользователя БД
• Пропустить проверку TLS: Проверять
• Tls сертификат: сертификат CA или серверный сертификат в формате PEM

Пример заполнения с дополнительными параметрами

• Режим ввода запросов пользователем: Разрешен, если нужно разрешить прямой SQL
• Время жизни кэша: 900
• SQL limit по умолчанию: 1000
• Время ожидания подключения из пула: 15000
• Частота опроса активного соединения: 5000
• Максимальный срок присутствия соединения в пуле: 900000
• Максимальный размер пула: 8
• Максимальное время простоя соединения в пуле: 300000
• Минимальное количество простаивающих соединений: 2