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

Partner Integration

Metabase — это простой в использовании UI‑инструмент с открытым исходным кодом для формирования запросов к вашим данным. Metabase — это Java‑приложение, которое можно запустить, просто скачав JAR‑файл и выполнив его командой java -jar metabase.jar. Metabase подключается к ClickHouse с помощью JDBC‑драйвера, который нужно скачать и поместить в папку plugins:

Цель

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

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

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

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

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

Параметр(ы)	Описание
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're using self-managed ClickHouse, the connection details are set by your ClickHouse administrator.

2. Загрузите плагин ClickHouse для Metabase

1. Если у вас нет папки plugins, создайте её как подпапку в каталоге, где сохранён файл metabase.jar.

2. Плагин представляет собой JAR‑файл с именем clickhouse.metabase-driver.jar. Загрузите последнюю версию JAR‑файла по адресу https://github.com/clickhouse/metabase-clickhouse-driver/releases/latest.

3. Сохраните clickhouse.metabase-driver.jar в папку plugins.

4. Запустите (или перезапустите) Metabase, чтобы драйвер корректно загрузился.

5. Откройте Metabase по адресу http://hostname:3000. При первом запуске вы увидите приветственный экран и вам потребуется ответить на ряд вопросов. Если будет предложено выбрать базу данных, выберите вариант "I'll add my data later":

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

1. Нажмите на значок шестерёнки в правом верхнем углу и выберите Admin Settings, чтобы открыть страницу администрирования Metabase.

2. Нажмите Add a database. Также вы можете открыть вкладку Databases и нажать кнопку Add database.

3. Если установка драйвера прошла успешно, вы увидите ClickHouse в выпадающем меню Database type:

   

4. Укажите для базы данных Display name — это настройка Metabase, поэтому можно использовать любое удобное имя.

5. Введите параметры подключения к вашей базе данных ClickHouse. Включите защищённое соединение, если ваш сервер ClickHouse настроен на использование SSL. Например:

   

6. Нажмите кнопку Save, после чего Metabase просканирует вашу базу данных на наличие таблиц.

4. Выполните SQL-запрос

1. Выйдите из Admin settings, нажав кнопку Exit admin в правом верхнем углу.

2. В правом верхнем углу нажмите меню + New и обратите внимание, что вы можете задавать вопросы, выполнять SQL-запросы и создавать дашборды:

   

3. Например, вот SQL-запрос, выполняемый для таблицы uk_price_paid, который возвращает среднюю цену по годам с 1995 по 2022:

   

5. Задайте вопрос

1. Нажмите + New и выберите Question. Обратите внимание, что вы можете сформировать вопрос, начав с базы данных и таблицы. Например, следующий вопрос задаётся к таблице uk_price_paid в базе данных default. Вот простой вопрос, который вычисляет среднюю цену по городам в графстве Большой Манчестер:

   

2. Нажмите кнопку Visualize, чтобы увидеть результаты в табличном представлении.

   

3. Ниже результатов нажмите кнопку Visualization, чтобы изменить визуализацию на столбчатую диаграмму (или любой другой доступный вариант):

   

Узнайте больше

Чтобы узнать больше о Metabase и создании дашбордов, обратитесь к документации Metabase.