Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs
49.6kGet Started

Conectar o Superset ao ClickHouse

View as MarkdownEdit this pageReport an issueSet up docs MCP
Suportado pelo ClickHouse

Apache Superset é 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…

Objetivo

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

Dashboard do Superset mostrando preços de imóveis do Reino Unido com várias visualizações, incluindo gráficos de pizza e tabelas

Tenha em mãos os detalhes da conexão

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:

botão Connect do serviço do ClickHouse Cloud

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

detalhes de conexão HTTPS do ClickHouse Cloud

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

Instale o driver

  1. O Superset usa o driver clickhouse-connect para se conectar ao ClickHouse. Os detalhes do clickhouse-connect estão em https://pypi.org/project/clickhouse-connect/, e ele pode ser instalado com o seguinte comando:

    pip install clickhouse-connect
  1. Inicie (ou reinicie) o Superset.

Conectar o Superset ao 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:
Interface do Superset mostrando o menu Database com o botão + Database destacado

  1. No primeiro passo, selecione ClickHouse Connect como o tipo de banco de dados:
Assistente de conexão de banco de dados do Superset mostrando a opção ClickHouse Connect selecionada

  1. 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.
Formulário de configuração de conexão do Superset mostrando os parâmetros de conexão do ClickHouse

  1. 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.

Adicionar conjunto de dados

  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:

Caixa de diálogo de criação de conjunto de dados do Superset mostrando as tabelas disponíveis do banco de dados ClickHouse

  1. 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!

Criando gráficos e um dashboard no 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:
Dashboard vazio do Superset chamado UK property prices, pronto para receber gráficos

  1. 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:
Interface de criação de gráfico do Superset com o tipo de visualização Pie Chart selecionado

  1. 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.
Configuração de dimensão mostrando o campo district selecionado para o gráfico de pizza
Configuração de métrica mostrando a função de agregação AVG(price) para o gráfico de pizza

  1. Se você prefere gráficos de rosca a gráficos de pizza, pode definir isso e outras opções em CUSTOMIZE:
Painel de personalização mostrando a opção de gráfico de rosca e outras configurações do gráfico de pizza

  1. 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:
Caixa de diálogo para salvar gráfico com menu suspenso de seleção de dashboard e botão Save & Go to Dashboard

  1. É isso. Criar dashboards no Superset com base em dados no ClickHouse abre todo um mundo de análises de dados extremamente rápidas!
Dashboard completo do Superset com várias visualizações de dados de preços de imóveis do Reino Unido no ClickHouse

Navigation