Подключиться
Yandex DataLens

Создание подключения к ClickHouse

Статья создана

Примечание

  • Подключение к ClickHouse выполняется только по HTTP-интерфейсу.
  • Все запросы к данным выполняются с включенным флагом join_use_nulls. Ознакомьтесь с разделом Особенности работы с подключением к ClickHouse, если вы используете представления (VIEW) или подзапросы с секцией JOIN в DataLens.

Важно

Подключая внешнюю БД, которая не является ресурсом Yandex Cloud, предоставьте доступ к БД для следующих диапазонов IP-адресов сервиса DataLens (через / указана длина маски подсети):

  • 178.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
  • 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

Чтобы создать подключение к ClickHouse:

  1. Перейдите на страницу подключений.

  2. Нажмите кнопку Создать подключение.

  3. Выберите подключение ClickHouse.

  4. Задайте Имя подключения. Имя может быть произвольным.

  5. Выберите тип подключения:

    Укажите параметры подключения для БД ClickHouse, доступной в Yandex Cloud:

    • Кластер. Укажите кластер из списка доступных кластеров ClickHouse. В настройках кластера должен быть активирован флаг Доступ из DataLens. Если у вас нет доступного кластера, нажмите кнопку Создать новый.

      Примечание

      В списке кластеров отображаются кластеры ClickHouse:

      • с правами доступа для пользователя создающего подключение;
      • созданные в том же каталоге, что и экземпляр DataLens.

    • Имя хоста. Выберите имя хоста из списка доступных в кластере ClickHouse. Вы можете выбрать несколько хостов. Если к первому хосту подключиться не получится, DataLens выберет следующий из списка.

    • Порт HTTP-интерфейса. Укажите порт подключения к ClickHouse. Порт по умолчанию — 8443.

    • Имя пользователя. Укажите имя пользователя для подключения к ClickHouse.

      Важно

      У пользователя должно быть установлено одно из следующих значений параметра readonly:

      • 0 — разрешены все запросы;
      • 2 — разрешены запросы на чтение данных и изменение настроек.

    • Пароль. Укажите пароль для пользователя.

    • Время жизни кэша в секундах. Укажите время жизни кеша или оставьте значение по умолчанию. Рекомендованное значение — 300 секунд (5 минут).

    • Уровень доступа SQL запросов. Позволяет использовать произвольный SQL-запрос для формирования датасета.

    • HTTPS. Проверьте, что опция безопасного подключения активирована.

    Укажите параметры подключения для внешней БД ClickHouse:

    • Имя хоста. Укажите путь до хоста-мастера или IP-адрес хоста-мастера ClickHouse. Вы можете указать несколько хостов через запятую. Если к первому хосту подключиться не получится, DataLens выберет следующий из списка.
    • Порт HTTP-интерфейса. Укажите порт подключения к ClickHouse. Порт по умолчанию — 8443.
    • Имя пользователя. Укажите имя пользователя для подключения к ClickHouse.

    Важно

    У пользователя должно быть установлено одно из следующих значений параметра readonly:

    • 0 — разрешены все запросы;
    • 2 — разрешены запросы на чтение данных и изменение настроек.
    • Пароль. Укажите пароль для пользователя.
    • Время жизни кэша в секундах. Укажите время жизни кеша или оставьте значение по умолчанию. Рекомендованное значение — 300 секунд (5 минут).
    • Уровень доступа SQL запросов. Позволяет использовать произвольный SQL-запрос для формирования датасета.
    • HTTPS. Активируйте опцию безопасного подключения, если ваш сервер поддерживает протокол HTTPS.

  6. Нажмите Сохранить. Подключение появится в списке.

Примечание

Вы можете проверить подключение к хосту перед созданием. Для этого нажмите кнопку Проверить подключение.

Особенности работы с подключением к 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.

В этой статье: