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

Community Maintained

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

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

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

1. Соберите детали вашего подключения

To connect to ClickHouse with HTTP(S) you need this information:

• The HOST and PORT: typically, the port is 8443 when using TLS or 8123 when not using TLS.

• The DATABASE NAME: out of the box, there is a database named default, use the name of the database that you want to connect to.

• The USERNAME and PASSWORD: out of the box, the username is default. Use the username appropriate for your use case.

The details for your ClickHouse Cloud service are available in the ClickHouse Cloud console. Select the service that you will connect to and click Connect:

Choose HTTPS, and the details are available in an example curl command.

If you are using self-managed ClickHouse, the connection details are set by your ClickHouse administrator.

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

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

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

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

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

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

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

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

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

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

Чтобы поддерживать подключение к различным базам данных для prod, qa, test и т.д. (или для поддержки различных баз данных для разных клиентов), вы можете назначить каждое подключение окружению (см. Environments API).