> ## Documentation Index
> Fetch the complete documentation index at: https://clickhouse.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> Apache Superset é uma plataforma open source de exploração e visualização de dados.

# Conectar o Superset ao 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>
            Suportado pelo ClickHouse
        </div>;
};

export const Image = ({img, alt, size = "lg"}) => {
  const normalizedSize = ["sm", "md", "lg"].includes(size) ? size : "lg";
  return <div className={`ch-image-${normalizedSize}`}>
      <Frame>
        <img src={img} alt={alt} />
      </Frame>
    </div>;
};

<ClickHouseSupportedBadge />

<a href="https://superset.apache.org/" target="_blank">Apache Superset</a> é uma plataforma open source de exploração e visualização de dados, escrita em Python. O Superset se conecta ao ClickHouse usando um driver em Python fornecido pelo ClickHouse. Vamos ver como isso funciona...

<div id="goal">
  ## Objetivo
</div>

Neste guia, você vai criar um dashboard no Superset com dados de um banco de dados do ClickHouse. O dashboard ficará assim:

<Image size="md" img="https://mintcdn.com/private-7c7dfe99/etDiFo_9fGSe5rMN/images/integrations/data-visualization/superset_12.webp?fit=max&auto=format&n=etDiFo_9fGSe5rMN&q=85&s=679288076599288c1852e3848bb4037e" alt="Dashboard do Superset mostrando preços de imóveis do Reino Unido com várias visualizações, incluindo gráficos de pizza e tabelas" border width="640" height="551" data-path="images/integrations/data-visualization/superset_12.webp" />

<br />

<Tip>
  **Adicione alguns dados**

  Se você não tiver um conjunto de dados para usar, pode adicionar um dos exemplos. Este guia usa o conjunto de dados [UK Price Paid](/docs/pt-BR/get-started/sample-datasets/uk-price-paid), então essa pode ser uma boa opção. Há vários outros para consultar na mesma categoria da documentação.
</Tip>

<Steps>
  <Step title="Tenha em mãos os detalhes da conexão" id="1-gather-your-connection-details">
    Para se conectar ao ClickHouse via HTTP(S), você precisa das seguintes informações:

    | Parâmetro(s)              | Descrição                                                                                                         |
    | ------------------------- | ----------------------------------------------------------------------------------------------------------------- |
    | `HOST` and `PORT`         | Normalmente, a porta é 8443 ao usar TLS ou 8123 quando não se usa TLS.                                            |
    | `DATABASE NAME`           | Por padrão, há um banco de dados chamado `default`; use o nome do banco de dados ao qual você deseja se conectar. |
    | `USERNAME` and `PASSWORD` | Por padrão, o nome de usuário é `default`. Use o nome de usuário apropriado para o seu caso de uso.               |

    Os detalhes do seu serviço do ClickHouse Cloud estão disponíveis no console do ClickHouse Cloud.
    Selecione um serviço e clique em **Connect**:

    <div className="ch-image-md">
      <Frame>
        <img src="https://mintcdn.com/private-7c7dfe99/CFFsa2agBPbviR4r/images/_snippets/cloud-connect-button.webp?fit=max&auto=format&n=CFFsa2agBPbviR4r&q=85&s=ec0a298a33ca841e947fa5e8bae47362" alt="botão Connect do serviço do ClickHouse Cloud" width="998" height="932" data-path="images/_snippets/cloud-connect-button.webp" />
      </Frame>
    </div>

    Escolha **HTTPS**. Os detalhes de conexão são exibidos em um comando `curl` de exemplo.

    <div className="ch-image-md">
      <Frame>
        <img src="https://mintcdn.com/private-7c7dfe99/CFFsa2agBPbviR4r/images/_snippets/connection-details-https.webp?fit=max&auto=format&n=CFFsa2agBPbviR4r&q=85&s=cb0fbd98aa2b5b7ca484c9f53395ee07" alt="detalhes de conexão HTTPS do ClickHouse Cloud" width="1320" height="1184" data-path="images/_snippets/connection-details-https.webp" />
      </Frame>
    </div>

    Se você estiver usando ClickHouse autogerenciado, os detalhes de conexão são definidos pelo administrador do seu ClickHouse.
  </Step>

  <Step title="Instale o driver" id="2-install-the-driver">
    1. O Superset usa o driver `clickhouse-connect` para se conectar ao ClickHouse. Os detalhes do `clickhouse-connect` estão em <a href="https://pypi.org/project/clickhouse-connect/" target="_blank">[https://pypi.org/project/clickhouse-connect/](https://pypi.org/project/clickhouse-connect/)</a>, e ele pode ser instalado com o seguinte comando:

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

    <Info>
      **Setup do Docker Compose**

      Para instalações baseadas em Docker, consulte o [guia de configuração de banco de dados do Superset](https://superset.apache.org/user-docs/6.0.0/configuration/databases/) para obter instruções sobre como adicionar o `clickhouse-connect` ao seu contêiner.
    </Info>

    2. Inicie (ou reinicie) o Superset.
  </Step>

  <Step title="Conectar o Superset ao ClickHouse" id="3-connect-superset-to-clickhouse">
    1. No Superset, selecione **Data** no menu superior e depois **Databases** no menu suspenso. Adicione um novo banco de dados clicando no botão **+ Database**:

    <Image size="lg" img="https://mintcdn.com/private-7c7dfe99/etDiFo_9fGSe5rMN/images/integrations/data-visualization/superset_01.webp?fit=max&auto=format&n=etDiFo_9fGSe5rMN&q=85&s=4eec14a85a54563cdbb20676610ceeed" alt="Interface do Superset mostrando o menu Database com o botão + Database destacado" border width="1572" height="243" data-path="images/integrations/data-visualization/superset_01.webp" />

    <br />

    2. No primeiro passo, selecione **ClickHouse Connect** como o tipo de banco de dados:

    <Image size="sm" img="https://mintcdn.com/private-7c7dfe99/etDiFo_9fGSe5rMN/images/integrations/data-visualization/superset_02.webp?fit=max&auto=format&n=etDiFo_9fGSe5rMN&q=85&s=e4b7b80fe77e598e2cd8d8b327375f44" alt="Assistente de conexão de banco de dados do Superset mostrando a opção ClickHouse Connect selecionada" border width="622" height="920" data-path="images/integrations/data-visualization/superset_02.webp" />

    <br />

    3. No segundo passo:

    * Ative ou desative o SSL.
    * Insira as informações de conexão que você coletou anteriormente
    * Especifique o **DISPLAY NAME**: pode ser qualquer nome de sua preferência. Se você for se conectar a vários bancos de dados do ClickHouse, escolha um nome mais descritivo.

    <Image size="sm" img="https://mintcdn.com/private-7c7dfe99/etDiFo_9fGSe5rMN/images/integrations/data-visualization/superset_03.webp?fit=max&auto=format&n=etDiFo_9fGSe5rMN&q=85&s=e9a3e57aa8330a2d8a949c67d8d46206" alt="Formulário de configuração de conexão do Superset mostrando os parâmetros de conexão do ClickHouse" border width="499" height="838" data-path="images/integrations/data-visualization/superset_03.webp" />

    <br />

    4. Clique nos botões **CONNECT** e depois **FINISH** para concluir o assistente de configuração. Em seguida, você deverá ver seu banco de dados na lista de bancos de dados.
  </Step>

  <Step title="Adicionar conjunto de dados" id="4-add-a-dataset">
    1. Para interagir com seus dados do ClickHouse no Superset, você precisa definir um ***conjunto de dados***. No menu superior do Superset, selecione **Data** e, em seguida, **Datasets** no menu suspenso.

    2. Clique no botão para adicionar um conjunto de dados. Selecione seu novo banco de dados como fonte de dados, e você verá as tabelas definidas nele:

    <Image size="sm" img="https://mintcdn.com/private-7c7dfe99/etDiFo_9fGSe5rMN/images/integrations/data-visualization/superset_04.webp?fit=max&auto=format&n=etDiFo_9fGSe5rMN&q=85&s=fccbd7aeab8b516c2ab804f2095a6f59" alt="Caixa de diálogo de criação de conjunto de dados do Superset mostrando as tabelas disponíveis do banco de dados ClickHouse" border width="412" height="323" data-path="images/integrations/data-visualization/superset_04.webp" />

    <br />

    3. Clique no botão **ADD** na parte inferior da caixa de diálogo, e sua tabela aparecerá na lista de conjuntos de dados. Você está pronto para criar um dashboard e analisar seus dados do ClickHouse!
  </Step>

  <Step title="Criando gráficos e um dashboard no Superset" id="5--creating-charts-and-a-dashboard-in-superset">
    Se você já conhece o Superset, vai se sentir em casa nesta próxima seção. Se ainda não conhece, bem... ele é como muitas outras ferramentas legais de visualização por aí: não leva muito tempo para começar, mas os detalhes e nuances você aprende com o tempo, à medida que usa a ferramenta.

    1. Você começa com um dashboard. No menu superior do Superset, selecione **Dashboards**. Clique no botão no canto superior direito para adicionar um novo dashboard. O dashboard a seguir se chama **UK property prices**:

    <Image size="md" img="https://mintcdn.com/private-7c7dfe99/etDiFo_9fGSe5rMN/images/integrations/data-visualization/superset_05.webp?fit=max&auto=format&n=etDiFo_9fGSe5rMN&q=85&s=c78c472da68986e3038ae35aadfcb4ee" alt="Dashboard vazio do Superset chamado UK property prices, pronto para receber gráficos" border width="959" height="445" data-path="images/integrations/data-visualization/superset_05.webp" />

    <br />

    2. Para criar um novo gráfico, selecione **Charts** no menu superior e clique no botão para adicionar um novo gráfico. Você verá várias opções. O exemplo a seguir mostra um gráfico **Pie Chart** usando o conjunto de dados **uk\_price\_paid** no menu suspenso **CHOOSE A DATASET**:

    <Image size="md" img="https://mintcdn.com/private-7c7dfe99/etDiFo_9fGSe5rMN/images/integrations/data-visualization/superset_06.webp?fit=max&auto=format&n=etDiFo_9fGSe5rMN&q=85&s=a75ae3e391a146023ba46f2f3fcc2527" alt="Interface de criação de gráfico do Superset com o tipo de visualização Pie Chart selecionado" border width="1098" height="998" data-path="images/integrations/data-visualization/superset_06.webp" />

    <br />

    3. Os gráficos de pizza do Superset precisam de uma **Dimension** e uma **Metric**; o restante das configurações é opcional. Você pode escolher seus próprios campos para a dimensão e a métrica; este exemplo usa o campo `district` do ClickHouse como dimensão e `AVG(price)` como métrica.

    <Image size="md" img="https://mintcdn.com/private-7c7dfe99/etDiFo_9fGSe5rMN/images/integrations/data-visualization/superset_08.webp?fit=max&auto=format&n=etDiFo_9fGSe5rMN&q=85&s=8904d36cde3ff39ddac578257817eed5" alt="Configuração de dimensão mostrando o campo district selecionado para o gráfico de pizza" border width="657" height="633" data-path="images/integrations/data-visualization/superset_08.webp" />

    <Image size="md" img="https://mintcdn.com/private-7c7dfe99/etDiFo_9fGSe5rMN/images/integrations/data-visualization/superset_09.webp?fit=max&auto=format&n=etDiFo_9fGSe5rMN&q=85&s=e846384c93bb111a9e658f3d734486a3" alt="Configuração de métrica mostrando a função de agregação AVG(price) para o gráfico de pizza" border width="657" height="605" data-path="images/integrations/data-visualization/superset_09.webp" />

    <br />

    5. Se você prefere gráficos de rosca a gráficos de pizza, pode definir isso e outras opções em **CUSTOMIZE**:

    <Image size="sm" img="https://mintcdn.com/private-7c7dfe99/etDiFo_9fGSe5rMN/images/integrations/data-visualization/superset_10.webp?fit=max&auto=format&n=etDiFo_9fGSe5rMN&q=85&s=0568cde0a54513227d9ade0d6958bda5" alt="Painel de personalização mostrando a opção de gráfico de rosca e outras configurações do gráfico de pizza" border width="320" height="929" data-path="images/integrations/data-visualization/superset_10.webp" />

    <br />

    6. Clique no botão **SAVE** para salvar o gráfico, depois selecione **UK property prices** no menu suspenso **ADD TO DASHBOARD**; em seguida, **SAVE & GO TO DASHBOARD** salva o gráfico e o adiciona ao dashboard:

    <Image size="md" img="https://mintcdn.com/private-7c7dfe99/etDiFo_9fGSe5rMN/images/integrations/data-visualization/superset_11.webp?fit=max&auto=format&n=etDiFo_9fGSe5rMN&q=85&s=ccca62277d5c0c6899ec2a8933d4f8ae" alt="Caixa de diálogo para salvar gráfico com menu suspenso de seleção de dashboard e botão Save & Go to Dashboard" border width="1442" height="792" data-path="images/integrations/data-visualization/superset_11.webp" />

    <br />

    7. É isso. Criar dashboards no Superset com base em dados no ClickHouse abre todo um mundo de análises de dados extremamente rápidas!

    <Image size="md" img="https://mintcdn.com/private-7c7dfe99/etDiFo_9fGSe5rMN/images/integrations/data-visualization/superset_12.webp?fit=max&auto=format&n=etDiFo_9fGSe5rMN&q=85&s=679288076599288c1852e3848bb4037e" alt="Dashboard completo do Superset com várias visualizações de dados de preços de imóveis do Reino Unido no ClickHouse" border width="640" height="551" data-path="images/integrations/data-visualization/superset_12.webp" />

    <br />
  </Step>
</Steps>
