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

Community Maintained

Databrain — это встраиваемая аналитическая платформа, которая позволяет создавать и предоставлять вашим клиентам интерактивные дашборды, метрики и визуализации данных. Databrain подключается к ClickHouse с использованием HTTPS-интерфейса, что упрощает визуализацию и анализ данных ClickHouse с помощью современного и удобного интерфейса.

В этом руководстве пошагово описано, как подключить Databrain к вашему инстансу ClickHouse.

Предварительные требования

• База данных ClickHouse, развернутая как в вашей собственной инфраструктуре, так и в ClickHouse Cloud.
• Учетная запись Databrain.
• Рабочее пространство Databrain для подключения вашего источника данных.

Шаги по подключению Databrain к ClickHouse

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

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

Parameter(s)	Description
HOST and PORT	Typically, the port is 8443 when using TLS or 8123 when not using TLS.
DATABASE NAME	Out of the box, there is a database named default, use the name of the database that you want to connect to.
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 a service and click Connect:

Choose HTTPS. Connection details are displayed in an example curl command.

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

2. Разрешите IP-адреса Databrain (если требуется)

Если в вашем экземпляре ClickHouse включена фильтрация по IP, вам нужно добавить IP-адреса Databrain в список разрешённых.

Для пользователей ClickHouse Cloud:

1. Перейдите к своему сервису в консоли ClickHouse Cloud
2. Откройте Settings → Security
3. Добавьте IP-адреса Databrain в список разрешённых

Совет

Обратитесь к документации по добавлению IP-адресов Databrain в список разрешённых для получения актуального списка IP-адресов, которые нужно разрешить.

3. Добавьте ClickHouse как источник данных в Databrain

1. Войдите в свою учётную запись Databrain и перейдите в рабочее пространство, в котором вы хотите добавить источник данных.

2. Нажмите Data Sources в навигационном меню.

3. Нажмите Add a Data Source или Connect Data Source.

4. Выберите ClickHouse из списка доступных коннекторов.

5. Заполните данные для подключения:
   • Destination Name: Укажите понятное имя для этого подключения (например, "Production ClickHouse" или "Analytics DB")
   • Host: Укажите URL хоста ClickHouse (например, https://your-instance.region.aws.clickhouse.cloud)
   • Port: Укажите 8443 (порт HTTPS по умолчанию для ClickHouse)
   • Username: Укажите имя пользователя ClickHouse
   • Password: Укажите пароль пользователя ClickHouse

6. Нажмите Test Connection, чтобы проверить, что Databrain может подключиться к вашему экземпляру ClickHouse.

7. После успешного подключения нажмите Save или Connect, чтобы добавить источник данных.

4. Настройте пользовательские права

Убедитесь, что у пользователя ClickHouse, с которым вы выполняете подключение, есть необходимые права доступа:

-- Предоставить права на чтение информации о схеме
GRANT SELECT ON information_schema.* TO your_databrain_user;

-- Предоставить права на чтение для вашей базы данных и таблиц
GRANT SELECT ON your_database.* TO your_databrain_user;

Замените your_databrain_user и your_database на фактические имя пользователя и имя базы данных.

Использование Databrain с ClickHouse

Исследуйте данные

1. После подключения перейдите в своё рабочее пространство Databrain.

2. В обозревателе данных Databrain вы увидите свои таблицы ClickHouse.

3. Нажмите на таблицу, чтобы изучить её схему и просмотреть данные.

Создание метрик и визуализаций

1. Нажмите Create Metric, чтобы начать построение визуализаций на основе данных ClickHouse.

2. Выберите источник данных ClickHouse и таблицу, которую вы хотите визуализировать.

3. Используйте интуитивный интерфейс Databrain, чтобы:

   • выбирать измерения и показатели;
   • применять фильтры и агрегации;
   • выбирать типы визуализаций (гистограммы, линейные графики, круговые диаграммы, таблицы и т. д.);
   • добавлять произвольные SQL-запросы для продвинутого анализа.

4. Сохраните метрику, чтобы повторно использовать её на разных дашбордах.

Создание дашбордов

1. Нажмите Create Dashboard, чтобы начать создание дашборда.

2. Добавляйте метрики на дашборд, перетаскивая сохранённые метрики.

3. Настройте компоновку и внешний вид дашборда.

4. Поделитесь дашбордом с вашей командой или встроите его в приложение.

Расширенные возможности

Databrain предлагает несколько расширенных возможностей при работе с ClickHouse:

• Пользовательская SQL-консоль: пишите и выполняйте произвольные SQL-запросы напрямую к вашей базе данных ClickHouse
• Многотенантная и однотенантная архитектуры (multi-tenancy и single-tenancy): подключайте вашу базу данных ClickHouse как с однотенантной, так и с многотенантной архитектурой
• Планирование отчётов: планируйте автоматическую генерацию отчётов и отправляйте их по электронной почте заинтересованным сторонам
• Инсайты на основе ИИ: используйте ИИ для генерации сводок и инсайтов из ваших данных
• Встраиваемая аналитика: встраивайте дашборды и метрики напрямую в ваши приложения
• Семантический уровень: создавайте повторно используемые модели данных и бизнес-логику

Устранение неполадок

Ошибка подключения

Если не удаётся подключиться к ClickHouse:

1. Проверьте учётные данные: Ещё раз проверьте имя пользователя, пароль и URL хоста
2. Проверьте порт: Убедитесь, что используется порт 8443 для HTTPS (или 8123 для HTTP, если не используется SSL)
3. Белый список IP-адресов: Убедитесь, что IP-адреса Databrain внесены в белый список в настройках файервола/безопасности ClickHouse
4. SSL/TLS: Убедитесь, что SSL/TLS корректно настроен, если используется HTTPS
5. Права пользователя: Убедитесь, что у пользователя есть привилегии SELECT на information_schema и целевые базы данных

Низкая производительность запросов

Если запросы выполняются медленно:

1. Оптимизируйте запросы: Эффективно используйте фильтры и агрегирующие функции
2. Создавайте материализованные представления: Для часто используемых агрегаций рассмотрите возможность создания материализованных представлений в ClickHouse
3. Используйте подходящие типы данных: Убедитесь, что в схеме ClickHouse используются оптимальные типы данных
4. Оптимизируйте индексы: Используйте первичные ключи и пропускающие индексы ClickHouse

Подробнее

Дополнительные сведения о возможностях Databrain и создании эффективной аналитики:

• Документация по Databrain
• Руководство по интеграции с ClickHouse
• Создание дашбордов
• Построение метрик