Подключение Embeddable к ClickHouse

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

В Embeddable вы определяете модели данных и компоненты в коде (который хранится в вашем собственном репозитории) и используете наш SDK, чтобы сделать их доступными вашей команде в мощном no-code builder Embeddable.

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

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

​

1. Подготовьте сведения о подключении

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

Параметр(ы)	Описание
HOST and PORT	Обычно используется порт 8443 при использовании TLS и 8123 без TLS.
DATABASE NAME	По умолчанию есть база данных default; используйте имя базы данных, к которой хотите подключиться.
USERNAME and PASSWORD	По умолчанию имя пользователя — default. Используйте имя пользователя, подходящее для вашего сценария использования.

Сведения о подключении для вашего сервиса ClickHouse Cloud доступны в консоли ClickHouse Cloud. Выберите сервис и нажмите Connect:

Выберите HTTPS. Сведения о подключении будут показаны в примере команды curl.

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

​

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

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

Query

// из соображений безопасности это *никогда* не должно вызываться на стороне клиента
fetch('https://api.embeddable.com/api/v1/connections', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    Accept: 'application/json',
    Authorization: `Bearer ${apiKey}` /* храните ваш API Key в безопасности */,
  },
  body: JSON.stringify({
    name: 'my-clickhouse-db',
    type: 'clickhouse',
    credentials: {
      host: 'my.clickhouse.host',
      user: 'clickhouse_user',
      port: 8443,
      password: '*****',
    },
  }),
});

Response

Status 201 { errorMessage: null }

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

apiKey можно найти, нажав “Publish” на одной из панелей мониторинга Embeddable.

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

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

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

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

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

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

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