Перейти к основному содержимому
Перейти к основному содержимому

Подключение Встраиваемого к ClickHouse

В Встраиваемом вы определяете Модели Данных и Компоненты в коде (хранящемся в вашем собственном репозитории) и используете наш SDK, чтобы сделать их доступными для вашей команды в мощном безкодовом конструкторе Встраиваемого.

Конечный результат - возможность предоставлять быстрые, интерактивные аналитические решения, ориентированные на клиента, непосредственно в вашем продукте; разработанные вашей продуктовой командой; созданные вашей инженерной командой; поддерживаемые вашими командами, работающими с клиентами и данными. Именно так, как и должно быть.

Встроенная безопасность на уровне строк означает, что каждый пользователь видит только те данные, которые ему разрешено видеть. А два уровня полностью настраиваемого кэширования позволяют предоставлять быстрые, актуальные аналитические данные в большом масштабе.

1. Соберите данные для подключения​

Чтобы подключиться к ClickHouse с помощью HTTP(S), вам нужна следующая информация:

  • ХОСТ и ПОРТ: обычно порт 8443 при использовании TLS или 8123 при его отсутствии.

  • НАЗВАНИЕ БАЗЫ ДАННЫХ: по умолчанию есть база данных с именем default, используйте имя базы данных, к которой вы хотите подключиться.

  • ИМЯ ПОЛЬЗОВАТЕЛЯ и ПАРОЛЬ: по умолчанию имя пользователя default. Используйте имя пользователя, подходящее для вашего случая использования.

Данные для вашей службы ClickHouse Cloud доступны в консоли ClickHouse Cloud. Выберите службу, к которой вы будете подключаться, и нажмите Подключиться:

Кнопка подключения к службе ClickHouse Cloud

Выберите HTTPS, и детали будут доступны в примере команды curl.

Детали подключения ClickHouse Cloud через HTTPS

Если вы используете self-managed ClickHouse, детали подключения задаются вашим администратором ClickHouse.

2. Создайте тип подключения к ClickHouse​

Вы добавляете подключение к базе данных с помощью API Встраиваемого. Это соединение используется для подключения к вашей службе ClickHouse. Вы можете добавить соединение, используя следующий вызов API:

Выше представлено действие CREATE, но все операции CRUD доступны.

apiKey можно найти, кликнув на "Опубликовать" на одной из ваших панелей инструментов Встраиваемого.

name - это уникальное имя для идентификации этого соединения.

  • По умолчанию ваши модели данных будут искать соединение с именем "default", но вы можете снабдить ваши модели различными именами data_source, чтобы поддерживать подключение различных моделей данных к различным соединениям (просто укажите имя data_source в модели)

type сообщает Встраиваемому, какой драйвер использовать

  • Здесь вы захотите использовать clickhouse, но вы можете подключить несколько различных источников данных к одной рабочей области Встраиваемого, так что вы можете использовать и другие, такие как: postgres, bigquery, mongodb и т.д.

credentials - это объект JavaScript, содержащий необходимые учетные данные, ожидаемые драйвером

  • Эти данные надежно зашифрованы и используются только для извлечения именно тех данных, которые вы описали в ваших моделях данных. Встраиваемый настоятельно рекомендует создать пользователя базы данных только для чтения для каждого соединения (Встраиваемый будет только читать из вашей базы данных, а не запись).

Для поддержки подключения к различным базам данных для продакшна, QA, тестирования и т.д. (или для поддержки различных баз данных для разных клиентов) вы можете присвоить каждое соединение окружению (см. API Окружений).