> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-home-button.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> Apache Superset — платформа с открытым исходным кодом для анализа и визуализации данных.

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

export const ClickHouseSupportedBadge = () => {
  return <div className="ClickHouseSupportedBadge">
            <div className="ClickHouseSupportedIcon">
                <svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg">
                    <path d="M1.30762 1.39073C1.30762 1.3103 1.37465 1.22986 1.46849 1.22986H2.64824C2.72868 1.22986 2.80912 1.29689 2.80912 1.39073V14.4886C2.80912 14.5691 2.74209 14.6495 2.64824 14.6495H1.46849C1.38805 14.6495 1.30762 14.5825 1.30762 14.4886V1.39073Z" fill="currentColor" />
                    <path d="M4.2832 1.39073C4.2832 1.3103 4.35023 1.22986 4.44408 1.22986H5.62383C5.70427 1.22986 5.7847 1.29689 5.7847 1.39073V14.4886C5.7847 14.5691 5.71767 14.6495 5.62383 14.6495H4.44408C4.36364 14.6495 4.2832 14.5825 4.2832 14.4886V1.39073Z" fill="currentColor" />
                    <path d="M7.25977 1.39073C7.25977 1.3103 7.3268 1.22986 7.42064 1.22986H8.60039C8.68083 1.22986 8.76127 1.29689 8.76127 1.39073V14.4886C8.76127 14.5691 8.69423 14.6495 8.60039 14.6495H7.42064C7.3402 14.6495 7.25977 14.5825 7.25977 14.4886V1.39073Z" fill="currentColor" />
                    <path d="M10.2354 1.39073C10.2354 1.3103 10.3024 1.22986 10.3962 1.22986H11.576C11.6564 1.22986 11.7369 1.29689 11.7369 1.39073V14.4886C11.7369 14.5691 11.6698 14.6495 11.576 14.6495H10.3962C10.3158 14.6495 10.2354 14.5825 10.2354 14.4886V1.39073Z" fill="currentColor" />
                    <path d="M13.2256 6.6057C13.2256 6.52526 13.2926 6.44482 13.3865 6.44482H14.5662C14.6466 6.44482 14.7271 6.51186 14.7271 6.6057V9.27354C14.7271 9.35398 14.6601 9.43442 14.5662 9.43442H13.3865C13.306 9.43442 13.2256 9.36739 13.2256 9.27354V6.6057Z" fill="currentColor" />
                </svg>
            </div>
            ClickHouse Supported
        </div>;
};

export const Image = ({img, alt, size}) => {
  return <Frame>
      <img src={img} alt={alt} />
    </Frame>;
};

<a href="https://superset.apache.org/" target="_blank">Apache Superset</a> — это платформа с открытым исходным кодом для анализа и визуализации данных, написанная на Python. Superset подключается к ClickHouse с помощью Python-драйвера от ClickHouse. Давайте посмотрим, как это работает...

<div id="goal">
  ## Цель
</div>

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

<Image size="md" img="https://mintcdn.com/private-7c7dfe99-home-button/8vRlAzTPu3QtBgl8/images/integrations/data-visualization/superset_12.png?fit=max&auto=format&n=8vRlAzTPu3QtBgl8&q=85&s=6e00e5d6d8fab15a80c5fb817803ced0" alt="Панель мониторинга Superset с ценами на недвижимость в Великобритании и несколькими визуализациями, включая круговые диаграммы и таблицы" border width="640" height="551" data-path="images/integrations/data-visualization/superset_12.png" />

<br />

<Tip>
  **Добавьте данные**

  Если у вас нет датасета для работы, вы можете добавить один из примеров. В этом руководстве используется датасет [UK Price Paid](/ru/get-started/sample-datasets/uk-price-paid), поэтому можно выбрать именно его. В этом же разделе документации есть и другие варианты.
</Tip>

<div id="1-gather-your-connection-details">
  ## 1. Подготовьте сведения о подключении
</div>

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

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

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

<Image img="https://mintcdn.com/private-7c7dfe99-home-button/kULrYc6Yc_Td1RKY/images/_snippets/cloud-connect-button.png?fit=max&auto=format&n=kULrYc6Yc_Td1RKY&q=85&s=f8f30304147d67b79b22a095be5c28d9" size="md" alt="Кнопка подключения сервиса ClickHouse Cloud" border width="998" height="932" data-path="images/_snippets/cloud-connect-button.png" />

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

<Image img="https://mintcdn.com/private-7c7dfe99-home-button/kULrYc6Yc_Td1RKY/images/_snippets/connection-details-https.png?fit=max&auto=format&n=kULrYc6Yc_Td1RKY&q=85&s=e0ad7ca41bc3d183bee88082e548cd76" size="md" alt="Сведения о подключении к ClickHouse Cloud по HTTPS" border width="1320" height="1184" data-path="images/_snippets/connection-details-https.png" />

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

<div id="2-install-the-driver">
  ## 2. Установите драйвер
</div>

1. Superset использует драйвер `clickhouse-connect` для подключения к ClickHouse. Подробнее о `clickhouse-connect` см. на странице <a href="https://pypi.org/project/clickhouse-connect/" target="_blank">[https://pypi.org/project/clickhouse-connect/](https://pypi.org/project/clickhouse-connect/)</a>. Установить его можно следующей командой:

   ```console theme={null}
   pip install clickhouse-connect
   ```

<Info>
  **Настройка Docker Compose**

  Для установок на базе Docker см. [руководство по настройке базы данных в Superset](https://superset.apache.org/docs/configuration/databases/#clickhouse), где описано, как добавить `clickhouse-connect` в контейнер.
</Info>

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

<div id="3-connect-superset-to-clickhouse">
  ## 3. Подключите Superset к ClickHouse
</div>

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

<Image size="lg" img="https://mintcdn.com/private-7c7dfe99-home-button/8vRlAzTPu3QtBgl8/images/integrations/data-visualization/superset_01.png?fit=max&auto=format&n=8vRlAzTPu3QtBgl8&q=85&s=602ed1c9cf22320976483a24232ae252" alt="Интерфейс Superset с меню Database, в котором выделена кнопка + Database" border width="1572" height="243" data-path="images/integrations/data-visualization/superset_01.png" />

<br />

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

<Image size="sm" img="https://mintcdn.com/private-7c7dfe99-home-button/8vRlAzTPu3QtBgl8/images/integrations/data-visualization/superset_02.png?fit=max&auto=format&n=8vRlAzTPu3QtBgl8&q=85&s=32504090bc2c450133a5352be78138df" alt="Мастер подключения к базе данных в Superset, в котором выбран вариант ClickHouse Connect" border width="622" height="920" data-path="images/integrations/data-visualization/superset_02.png" />

<br />

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

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

<Image size="sm" img="https://mintcdn.com/private-7c7dfe99-home-button/8vRlAzTPu3QtBgl8/images/integrations/data-visualization/superset_03.png?fit=max&auto=format&n=8vRlAzTPu3QtBgl8&q=85&s=4467e2fa7a9fd4ac4e2468c17cd1ab79" alt="Форма настройки подключения в Superset с параметрами подключения ClickHouse" border width="499" height="838" data-path="images/integrations/data-visualization/superset_03.png" />

<br />

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

<div id="4-add-a-dataset">
  ## 4. Добавьте датасет
</div>

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

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

<Image size="sm" img="https://mintcdn.com/private-7c7dfe99-home-button/8vRlAzTPu3QtBgl8/images/integrations/data-visualization/superset_04.png?fit=max&auto=format&n=8vRlAzTPu3QtBgl8&q=85&s=5dacecc50e1c01904a031075d9397b4b" alt="Диалог создания датасета в Superset с доступными таблицами из базы данных ClickHouse" border width="412" height="323" data-path="images/integrations/data-visualization/superset_04.png" />

<br />

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

<div id="5--creating-charts-and-a-dashboard-in-superset">
  ## 5.  Создание диаграмм и панели мониторинга в Superset
</div>

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

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

<Image size="md" img="https://mintcdn.com/private-7c7dfe99-home-button/8vRlAzTPu3QtBgl8/images/integrations/data-visualization/superset_05.png?fit=max&auto=format&n=8vRlAzTPu3QtBgl8&q=85&s=9239a2a3fd010892c660145c867c20fa" alt="Пустая панель мониторинга Superset с именем UK property prices, готовая к добавлению диаграмм" border width="959" height="445" data-path="images/integrations/data-visualization/superset_05.png" />

<br />

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

<Image size="md" img="https://mintcdn.com/private-7c7dfe99-home-button/8vRlAzTPu3QtBgl8/images/integrations/data-visualization/superset_06.png?fit=max&auto=format&n=8vRlAzTPu3QtBgl8&q=85&s=00d20d027c9584714d05ac1a92bca56d" alt="Интерфейс создания диаграммы в Superset с выбранным типом визуализации Pie Chart" border width="1098" height="998" data-path="images/integrations/data-visualization/superset_06.png" />

<br />

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

<Image size="md" img="https://mintcdn.com/private-7c7dfe99-home-button/8vRlAzTPu3QtBgl8/images/integrations/data-visualization/superset_08.png?fit=max&auto=format&n=8vRlAzTPu3QtBgl8&q=85&s=0dacabae3342bba5bd3cfc896c4d7dfc" alt="Конфигурация Dimension с выбранным полем district для круговой диаграммы" border width="657" height="633" data-path="images/integrations/data-visualization/superset_08.png" />

<Image size="md" img="https://mintcdn.com/private-7c7dfe99-home-button/8vRlAzTPu3QtBgl8/images/integrations/data-visualization/superset_09.png?fit=max&auto=format&n=8vRlAzTPu3QtBgl8&q=85&s=dd27629697543295e93a7dd4005edc08" alt="Конфигурация Metric с агрегатной функцией AVG(price) для круговой диаграммы" border width="657" height="605" data-path="images/integrations/data-visualization/superset_09.png" />

<br />

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

<Image size="sm" img="https://mintcdn.com/private-7c7dfe99-home-button/8vRlAzTPu3QtBgl8/images/integrations/data-visualization/superset_10.png?fit=max&auto=format&n=8vRlAzTPu3QtBgl8&q=85&s=c33132020aab985b03dd353cf148f404" alt="Панель Customize с параметром кольцевой диаграммы и другими настройками круговой диаграммы" border width="320" height="929" data-path="images/integrations/data-visualization/superset_10.png" />

<br />

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

<Image size="md" img="https://mintcdn.com/private-7c7dfe99-home-button/8vRlAzTPu3QtBgl8/images/integrations/data-visualization/superset_11.png?fit=max&auto=format&n=8vRlAzTPu3QtBgl8&q=85&s=eb7f8a6f743d910ce8672024fd1903d9" alt="Диалог сохранения диаграммы с выпадающим списком выбора панели мониторинга и кнопкой Save & Go to Dashboard" border width="1442" height="792" data-path="images/integrations/data-visualization/superset_11.png" />

<br />

7. Вот и всё. Создание панелей мониторинга в Superset на основе данных из ClickHouse открывает целый мир невероятно быстрой аналитики данных!

<Image size="md" img="https://mintcdn.com/private-7c7dfe99-home-button/8vRlAzTPu3QtBgl8/images/integrations/data-visualization/superset_12.png?fit=max&auto=format&n=8vRlAzTPu3QtBgl8&q=85&s=6e00e5d6d8fab15a80c5fb817803ced0" alt="Готовая панель мониторинга Superset с несколькими визуализациями данных о ценах на недвижимость в Великобритании из ClickHouse" border width="640" height="551" data-path="images/integrations/data-visualization/superset_12.png" />

<br />
