Соединение Встраиваемого с ClickHouse
В Встраиваемом вы определяете Модели Данных и Компоненты в коде (хранятся в вашем собственном репозитории кода) и используете наш 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
Вы добавляете подключение к базе данных, используя API Встраиваемого. Это соединение используется для подключения к вашему сервису ClickHouse. Вы можете добавить соединение с помощью следующего вызова API:
Выше представлено действие CREATE
, но доступны все операции CRUD
.
apiKey
можно найти, нажав "Опубликовать" на одной из ваших панелей инструментов Встраиваемого.
name
- это уникальное имя для идентификации этого соединения.
- По умолчанию ваши модели данных будут искать соединение с именем "default", но вы можете предоставить своим моделям разные имена
data_source
, чтобы подключить разные модели данных к разным соединениям (просто укажите имя data_source в модели)
type
сообщает Встраиваемому, какой драйвер использовать.
- Здесь вам потребуется использовать
clickhouse
, но вы можете подключить несколько разных источников данных к одному рабочему пространству Встраиваемого, так что вы можете использовать и другие, такие как:postgres
,bigquery
,mongodb
и т.д.
credentials
- это объект JavaScript, содержащий необходимые учетные данные, ожидаемые драйвером.
- Они надежно шифруются и используются только для получения ровно тех данных, которые вы описали в ваших моделях данных. Встраиваемый настоятельно рекомендует создать пользователя базы данных только для чтения для каждого соединения (Встраиваемый будет только читать из вашей базы данных, а не записывать).
Чтобы поддерживать соединения с разными базами данных для prod, qa, test и т.д. (или поддерживать разные базы данных для разных клиентов), вы можете присвоить каждому соединению среду (см. Environments API).