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

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

Community Maintained

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

Цель

В этом руководстве вы создадите панель инструментов в Superset с данными из базы данных ClickHouse. Панель будет выглядеть следующим образом:

Панель инструментов Superset, показывающая цены на недвижимость в Великобритании с несколькими визуализациями, включая круговые диаграммы и таблицы

Добавьте данные

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

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

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

  • ХОСТ и ПОРТ: как правило, порт 8443 при использовании TLS или 8123 при отсутствии TLS.

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

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

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

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

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

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

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

2. Установите драйвер

  1. Superset использует драйвер clickhouse-connect для подключения к ClickHouse. Подробности о clickhouse-connect можно найти по адресу https://pypi.org/project/clickhouse-connect/, и его можно установить с помощью следующей команды:
pip install clickhouse-connect
  1. Запустите (или перезапустите) Superset.

3. Подключите Superset к ClickHouse

  1. В Superset выберите Данные в верхнем меню, а затем Базы данных в выпадающем меню. Добавьте новую базу данных, нажав кнопку + База данных:
Интерфейс Superset, показывающий меню База данных с выделенной кнопкой + База данных

  1. На первом этапе выберите ClickHouse Connect в качестве типа базы данных:
Визард подключения базы данных Superset, показывающий выбранный вариант ClickHouse Connect

  1. На втором этапе:
  • Включите или отключите SSL.
  • Введите информацию о подключении, которую вы собрали ранее.
  • Укажите ИМЯ ДИСПЛЕЯ: это может быть любое имя, которое вы предпочитаете. Если вы будете подключаться к нескольким базам данных ClickHouse, сделайте имя более описательным.
Форма конфигурации подключения Superset, показывающая параметры подключения ClickHouse

  1. Нажмите кнопки ПОДКЛЮЧИТЬ и затем ЗАВЕРШИТЬ, чтобы завершить мастер настройки, и вы должны увидеть вашу базу данных в списке баз данных.

4. Добавьте набор данных

  1. Чтобы взаимодействовать с данными ClickHouse с помощью Superset, необходимо определить набор данных. В верхнем меню Superset выберите Данные, затем Наборы данных в выпадающем меню.

  2. Нажмите кнопку для добавления набора данных. Выберите вашу новую базу данных в качестве источника данных, и вы увидите таблицы, определенные в вашей базе данных:

Диалог создания набора данных Superset, показывающий доступные таблицы из базы данных ClickHouse

  1. Нажмите кнопку ДОБАВИТЬ внизу окна диалога, и ваша таблица появится в списке наборов данных. Вы готовы создать панель инструментов и проанализировать ваши данные ClickHouse!

5. Создание диаграмм и панели инструментов в Superset

Если вы знакомы с Superset, вы будете чувствовать себя как дома в этом следующем разделе. Если вы новичок в Superset, ну... это похоже на многие другие классные инструменты визуализации, доступные в мире — для начала не требуется много времени, но детали и нюансы осваиваются со временем, по мере работы с инструментом.

  1. Вы начинаете с панели инструментов. В верхнем меню Superset выберите Панели инструментов. Нажмите кнопку в правом верхнем углу, чтобы добавить новую панель инструментов. Следующая панель называется Цены на недвижимость в Великобритании:
Пустая панель инструментов Superset, названная Цены на недвижимость в Великобритании, готовая для добавления диаграмм

  1. Чтобы создать новую диаграмму, выберите Диаграммы в верхнем меню и нажмите кнопку для добавления новой диаграммы. Вам будет показано много вариантов. Следующий пример показывает диаграмму Круговая диаграмма, использующую набор данных uk_price_paid из выпадающего списка ВЫБРАТЬ НАБОР ДАННЫХ:
Интерфейс создания диаграммы Superset с выбранным типом визуализации Круговая диаграмма

  1. Круговые диаграммы Superset нуждаются в Размере и Метрике, остальные параметры являются необязательными. Вы можете выбрать свои поля для размера и метрики, в этом примере используется поле ClickHouse district в качестве размера и AVG(price) в качестве метрики.
Конфигурация размера, показывающая выбранное поле района для круговой диаграммы
Конфигурация метрики, показывающая агрегатную функцию AVG(price) для круговой диаграммы

  1. Если вам больше нравятся кольцевые диаграммы, чем круговые, вы можете установить это и другие параметры в разделе КОНФИГУРИРОВАТЬ:
Панель настройки, показывающая опцию кольцевой диаграммы и другие параметры конфигурации круговой диаграммы

  1. Нажмите кнопку СОХРАНИТЬ, чтобы сохранить диаграмму, затем выберите Цены на недвижимость в Великобритании в выпадающем списке ДОБАВИТЬ НА ПАНЕЛЬ; затем СОХРАНИТЬ И ПЕРЕЙТИ К ПАНЕЛИ сохраняет диаграмму и добавляет ее на панель инструментов:
Диалог сохранения диаграммы с выпадающим списком выбора панели и кнопкой Сохранить и перейти к панели

  1. Вот и всё. Создание панелей инструментов в Superset на основе данных ClickHouse открывает целый мир молниеносной аналитики данных!
Завершенная панель инструментов Superset с множеством визуализаций данных цен на недвижимость в Великобритании из ClickHouse