ClickHouse

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

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

Описание

Плагин ClickHouse предназначен для подключения Графини к ClickHouse и выполнения аналитических SQL-запросов.

В интерфейсе создания источника данных плагин отображается как ClickHouse. Для подключения используются параметры сервера ClickHouse, настройки TLS, пользовательские учётные данные и служебные параметры таймаутов и ограничений.

Настройка

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

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

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

Название в UI	Код поля	Тип	Обязательность	Значение по умолчанию / примечание
Хост	host	text	обязательно	127.0.0.1
Порт	port	number	обязательно	8123, диапазон 1..65535
Протокол	protocol	radio	обязательно	HTTP или Native, по умолчанию HTTP
Безопасное соединение	secure	radio	обязательно	Выключено или Включено, по умолчанию Выключено
Пропустить проверку TLS	skipTls	radio	обязательно	Проверять или Игнорировать, по умолчанию Игнорировать
Пользователь	username	text	обязательно	default
Пароль	password	password	необязательно	Можно оставить пустым, если это допускает ClickHouse
TLS-аутентификация	tlsAuth	radio	обязательно	Выключена или Включена, по умолчанию Выключена
База данных по умолчанию	defaultDatabase	text	обязательно	default
Таблица по умолчанию	defaultTable	text	необязательно	Используется как стартовое значение в конструкторе запросов
Таймаут подключения (сек)	dialTimeout	number	необязательно	10, диапазон 1..600
Таймаут запроса (сек)	queryTimeout	number	необязательно	60, диапазон 1..3600
TTL кэша (сек)	ttl	number	необязательно	600, диапазон 0..43200, значение 0 отключает кэш
SQL-лимит по умолчанию	defaultLimit	number	необязательно	500, диапазон 0..50000
Режим SQL-кода	codeMode	radio	обязательно	Выключен или Включен, по умолчанию Включен
Язык запроса	codeLang	text	автоматически	Только чтение, значение sql

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

Триггерных полей в форме два.

1. Поле Пропустить проверку TLS:

• если выбрано Проверять, появляется поле TLS-сертификат
• поле TLS-сертификат предназначено для вставки сертификата в текстовом виде
• плейсхолдер поля: Начинается с --- BEGIN CERTIFICATE ---

2. Поле TLS-аутентификация:

• если выбрано Включена, появляются поля Клиентский сертификат и Клиентский ключ
• эти поля используются для mTLS-подключения, если сервер ClickHouse требует клиентский сертификат

Дополнительно в форме есть режимные, но не триггерные настройки:

• Протокол: можно выбрать HTTP или Native
• Безопасное соединение: включает TLS для подключения
• Режим SQL-кода: включает или отключает режим SQL-кода, поле Язык запроса остаётся фиксированным и показывает sql

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

• для создания источника данных заполните поле Источник данных и выберите тип ClickHouse
• для успешной проверки подключения должны быть корректно заполнены Хост, Порт, Пользователь и База данных по умолчанию
• поле Пароль можно оставить пустым только если сервер ClickHouse допускает подключение выбранного пользователя без пароля
• значение База данных по умолчанию должно существовать на сервере и быть доступно указанному пользователю
• Протокол, Безопасное соединение и Порт должны соответствовать реальному способу публикации ClickHouse
• типовые порты: 8123 для HTTP, 8443 для HTTPS, 9000 для Native, 9440 для Native + TLS
• если включено Безопасное соединение и выбрано Проверять, для окружений с собственным CA-сертификатом обычно требуется заполнить TLS-сертификат
• если сервер требует взаимную TLS-аутентификацию, включите TLS-аутентификация и заполните Клиентский сертификат и Клиентский ключ
• слишком маленькие значения Таймаут подключения (сек) и Таймаут запроса (сек) могут приводить к неуспешной проверке на медленном соединении

Проверка соединения выполняет реальное подключение к ClickHouse и проверяет доступность сервера с указанными параметрами.

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

1. Откройте раздел Источники данных.
2. Нажмите Добавить источник данных.
3. В поле Источник данных укажите понятное имя подключения.
4. В поле Тип выберите ClickHouse.
5. Заполните Хост, Порт, Протокол, Пользователь и База данных по умолчанию.
6. При необходимости включите Безопасное соединение.
7. Если нужно проверять TLS-сертификат сервера, выберите Проверять и вставьте сертификат в поле TLS-сертификат.
8. Если ClickHouse требует клиентский сертификат, включите TLS-аутентификация и заполните поля Клиентский сертификат и Клиентский ключ.
9. При необходимости настройте Таблица по умолчанию, таймауты, TTL кэша (сек) и SQL-лимит по умолчанию.
10. Нажмите Проверить соединение.
11. После успешной проверки нажмите Сохранить.

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

• Источник данных: ClickHouse HTTP
• Тип: ClickHouse
• Хост: адрес сервера ClickHouse
• Порт: 8123
• Протокол: HTTP
• Безопасное соединение: Выключено
• Пропустить проверку TLS: Игнорировать
• Пользователь: пользователь ClickHouse
• Пароль: пароль пользователя, если он задан
• База данных по умолчанию: нужная база ClickHouse

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

• Источник данных: ClickHouse HTTPS
• Тип: ClickHouse
• Хост: адрес сервера ClickHouse
• Порт: 8443
• Протокол: HTTP
• Безопасное соединение: Включено
• Пропустить проверку TLS: Проверять
• TLS-сертификат: сертификат удостоверяющего центра или сервера в PEM-виде
• Пользователь: пользователь ClickHouse
• Пароль: пароль пользователя
• База данных по умолчанию: нужная база ClickHouse

Пример заполнения с TLS-аутентификацией клиента

• Источник данных: ClickHouse mTLS
• Тип: ClickHouse
• Хост: адрес сервера ClickHouse
• Порт: 9440 или другой TLS-порт сервера
• Протокол: Native или HTTP в зависимости от опубликованного интерфейса сервера
• Безопасное соединение: Включено
• Пропустить проверку TLS: Проверять
• TLS-сертификат: сертификат CA или сервера
• Пользователь: пользователь ClickHouse
• Пароль: пароль пользователя
• TLS-аутентификация: Включена
• Клиентский сертификат: клиентский сертификат в PEM-виде
• Клиентский ключ: клиентский приватный ключ в PEM-виде
• База данных по умолчанию: нужная база ClickHouse