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

ClickHouse Supported

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

Цель

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

Добавьте немного данных

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

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. Установка драйвера

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

   pip install clickhouse-connect
   

2. Запустите (или перезапустите) Superset.

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

1. В Superset выберите Data в верхнем меню, затем Databases в раскрывающемся меню. Добавьте новую базу данных, нажав кнопку + Database:

2. На первом шаге выберите ClickHouse Connect в качестве типа базы данных:

3. На втором шаге:

• Включите или отключите SSL.
• Введите информацию о подключении, которую вы собрали ранее.
• Укажите DISPLAY NAME: это может быть любое удобное вам имя. Если вы будете подключаться к нескольким базам данных ClickHouse, сделайте имя более описательным.

4. Нажмите кнопки CONNECT, а затем FINISH, чтобы завершить мастер настройки. После этого вы увидите свою базу данных в списке баз данных.

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

1. Чтобы работать с данными ClickHouse в Superset, необходимо определить dataset (набор данных). В верхнем меню Superset выберите Data, затем Datasets в раскрывающемся меню.

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

3. Нажмите кнопку ADD в нижней части диалогового окна, и ваша таблица появится в списке наборов данных. Теперь вы готовы создавать дашборды и анализировать данные в ClickHouse!

5. Создание диаграмм и дашборда в Superset

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

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

2. Чтобы создать новую диаграмму, выберите Charts в верхнем меню и нажмите кнопку для добавления новой диаграммы. Вам будет показано множество вариантов. В следующем примере показана диаграмма типа Pie Chart, использующая датасет uk_price_paid из выпадающего списка CHOOSE A DATASET:

3. Для круговых диаграмм (pie charts) в Superset требуются Dimension и Metric, остальные настройки являются необязательными. Вы можете выбрать свои поля для измерения (dimension) и метрики (metric); в этом примере используется поле ClickHouse district в качестве измерения и AVG(price) в качестве метрики.

5. Если вы предпочитаете кольцевые диаграммы (doughnut charts) вместо круговых, вы можете задать это и другие параметры в разделе CUSTOMIZE:

6. Нажмите кнопку SAVE, чтобы сохранить диаграмму, затем выберите UK property prices в выпадающем списке ADD TO DASHBOARD, после чего SAVE & GO TO DASHBOARD сохранит диаграмму и добавит её в дашборд:

7. На этом всё. Построение дашбордов в Superset на основе данных в ClickHouse открывает целый мир молниеносной аналитики данных!