Создание подключения к ClickHouse®
Примечание
Все запросы к данным выполняются с включенным флагом join_use_nulls
Важно
Подключая внешнюю БД, которая не является ресурсом Yandex Cloud:
-
При использовании собственного SSL-сертификата проверьте, что он совпадает с сертификатом на стороне БД.
-
Предоставьте доступ к БД для следующих диапазонов IP-адресов сервиса DataLens (через
/
указана длина маски подсети):ipv4ipv6178.154.242.176/28
178.154.242.192/28
178.154.242.208/28
178.154.242.128/28
178.154.242.144/28
178.154.242.160/28
130.193.60.0/28
2a02:6b8:c03:500:0:f83d:a987:0/112
2a02:6b8:c02:900:0:f83d:a987:0/112
2a02:6b8:c0e:500:0:f83d:a987:0/112
Чтобы создать подключение к ClickHouse®:
Важно
Если вы работаете с новой объектной моделью DataLens, включающей воркбуки и коллекции:
- Перейдите на главную страницу
DataLens. На панели слева выберите - Откройте воркбук, в правом верхнем углу нажмите Создать и выберите нужный объект.
Продолжайте инструкцию с шага 3.
-
Перейдите на страницу подключений
. -
Нажмите кнопку Создать подключение.
-
Выберите подключение ClickHouse®.
-
Выберите тип подключения:
Выбрать в организацииУказать вручнуюВыберите управляемую БД в текущей организации Yandex Cloud и укажите для нее параметры, чтобы подключиться по внутренней сети:
-
Кластер. Укажите кластер из списка доступных кластеров ClickHouse®. В настройках кластера должна быть активирована опция Доступ из DataLens. Если у вас нет доступного кластера, нажмите кнопку Создать новый.
Примечание
В списке отображаются кластеры:
- с правами доступа для пользователя, создающего подключение;
- созданные в той же организации, что и экземпляр DataLens.
-
Имя хоста. Выберите имя хоста из списка доступных в кластере ClickHouse®. Вы можете выбрать несколько хостов. Если к первому хосту подключиться не получится, DataLens выберет следующий из списка.
-
Порт HTTP-интерфейса. Укажите порт подключения к ClickHouse®. Порт по умолчанию — 8443.
-
Имя пользователя. Укажите имя пользователя для подключения к ClickHouse®.
Важно
У пользователя должно быть установлено одно из следующих значений параметра readonly
:0
— разрешены все запросы;2
— разрешены запросы на чтение данных и изменение настроек.
-
Пароль. Укажите пароль для пользователя.
-
Время жизни кеша в секундах. Укажите время жизни кеша или оставьте значение по умолчанию. Рекомендованное значение — 300 секунд (5 минут).
-
Уровень доступа SQL запросов. Позволяет использовать произвольный SQL-запрос для формирования датасета.
Вручную укажите реквизиты внешней БД, чтобы подключиться через публичную сеть:
-
Имя хоста. Укажите путь до хоста-мастера или IP-адрес хоста-мастера ClickHouse®. Вы можете указать несколько хостов через запятую. Если к первому хосту подключиться не получится, DataLens выберет следующий из списка.
-
Порт HTTP-интерфейса. Укажите порт подключения к ClickHouse®. Порт по умолчанию — 8443.
-
Имя пользователя. Укажите имя пользователя для подключения к ClickHouse®.
Важно
У пользователя должно быть установлено одно из следующих значений параметра readonly
:0
— разрешены все запросы;2
— разрешены запросы на чтение данных и изменение настроек.
-
Пароль. Укажите пароль для пользователя.
-
Время жизни кеша в секундах. Укажите время жизни кеша или оставьте значение по умолчанию. Рекомендованное значение — 300 секунд (5 минут).
-
Уровень доступа SQL запросов. Позволяет использовать произвольный SQL-запрос для формирования датасета.
-
-
Нажмите кнопку Создать подключение.
-
Укажите название подключения и нажмите кнопку Создать.
Примечание
Вы можете проверить подключение к хосту перед созданием. Для этого нажмите кнопку Проверить подключение.
Дополнительные настройки
Вы можете указать дополнительные параметры подключения в разделе Продвинутые настройки подключения:
-
TLS — когда опция включена, при взаимодействии с БД используется протокол
HTTPS
, когда выключена —HTTP
. -
CA Certificate — чтобы загрузить сертификат, нажмите кнопку Прикрепить файл и укажите файл сертификата. Когда сертификат загружен, поле отображает название файла.
-
Запрет на экспорт данных — когда опция включена, в чартах на базе этого подключения будет скрыта кнопка экспорта данных. При этом останется возможность копировать данные из чартов, а также снимать скриншоты.
Особенности работы с подключением к ClickHouse®
Вы можете создавать датасеты поверх представлений (VIEW
) в ClickHouse®, содержащих секцию JOIN
. Для этого представление должно быть создано с включенной опцией join_use_nulls
. Рекомендуется выставлять настройку join_use_nulls = 1
в секции SETTINGS
:
CREATE VIEW ... (
...
) AS
SELECT
...
FROM
...
SETTINGS join_use_nulls = 1
Также следует включать эту опцию для подзапросов raw-sql, которые используются как источник данных в датасете.
Чтобы избежать ошибок при работе с представлениями в DataLens, содержащими секцию JOIN, создайте заново все представления с настройкой join_use_nulls = 1
. Пустые ячейки при этом заполнятся значениями NULL
, а тип соответствующих полей преобразуется в Nullable
ClickHouse® является зарегистрированным товарным знаком ClickHouse, Inc