Conecta-seEntrar na plataforma

ClickHouse

Consultar e alterar dados em um banco ClickHouse.

Integrações e ferramentasBancos de dadosConexão: Credencial protegida

O que faz

Integre o ClickHouse ao fluxo. Consulte e insira dados, gerencie bancos e tabelas, inspecione esquemas, acompanhe mutações e consultas em execução, gerencie partições e execute SQL livre pela interface HTTP do ClickHouse.

Quando usar: Use quando o seu fluxo precisar consultar e alterar dados em um banco ClickHouse.

Exemplo de situação: Localizar um cadastro e aproveitar seus dados nas etapas seguintes.

Antes de começar

Conexão necessária: Credencial protegida.

Escolha uma conexão ou credencial já cadastrada no workspace. Nunca cole senhas ou chaves em campos de texto comuns.

Passo a passo

  1. Adicione ClickHouse ao desenho a partir da aba Blocos e ligue a entrada dele à etapa anterior.
  2. Escolha uma conexão ou credencial já cadastrada no workspace. Nunca cole senhas ou chaves em campos de texto comuns.
  3. Escolha a operação. O painel mostra só os campos que essa operação usa.
  4. Preencha os campos obrigatórios. Para usar um dado de uma etapa anterior, digite < e escolha o bloco e o campo.
  5. Clique em Executar com dados de teste e confira, no terminal, o que entrou e o que saiu do bloco.
  6. Só publique depois de conferir o resultado da execução de teste.

Operações

OperaçãoO que faz
Consulta (SELECT)Executa a operação “Consulta (SELECT)” com o bloco ClickHouse.
Executar SQL livreExecuta SQL livre com o bloco ClickHouse.
Inserir linhaInsere linha com o bloco ClickHouse.
Inserir linhas (em massa)Insere linhas (em massa) com o bloco ClickHouse.
Atualizar dadosAtualiza dados com o bloco ClickHouse.
Excluir dadosExclui dados com o bloco ClickHouse.
Listar bancos de dadosLista bancos de dados com o bloco ClickHouse.
Listar tabelasLista tabelas com o bloco ClickHouse.
Descrever tabelaDescreve tabela com o bloco ClickHouse.
Mostrar o CREATE TABLEMostra o CREATE TABLE com o bloco ClickHouse.
Contar linhasConta linhas com o bloco ClickHouse.
Inspecionar esquemaInspeciona esquema com o bloco ClickHouse.
Criar banco de dadosCria banco de dados com o bloco ClickHouse.
Excluir banco de dadosExclui banco de dados com o bloco ClickHouse.
Criar tabelaCria tabela com o bloco ClickHouse.
Excluir tabelaExclui tabela com o bloco ClickHouse.
Esvaziar tabelaEsvazia tabela com o bloco ClickHouse.
Renomear tabelaRenomea tabela com o bloco ClickHouse.
Otimizar tabelaOtimiza tabela com o bloco ClickHouse.
Listar partiçõesLista partições com o bloco ClickHouse.
Excluir partiçãoExclui partição com o bloco ClickHouse.
Listar mutaçõesLista mutações com o bloco ClickHouse.
Listar consultas em execuçãoLista consultas em execução com o bloco ClickHouse.
Encerrar consultaEncerra consulta com o bloco ClickHouse.
Ver estatísticas da tabelaMostra estatísticas da tabela com o bloco ClickHouse.
Listar clustersLista clusters com o bloco ClickHouse.

Campos

Mostrar campos de
  • Operação

    Escolhe qual ação este bloco executará.

    Opções:
    Consulta (SELECT) · Executar SQL livre · Inserir linha · Inserir linhas (em massa) · Atualizar dados · Excluir dados · Listar bancos de dados · Listar tabelas · Descrever tabela · Mostrar o CREATE TABLE · Contar linhas · Inspecionar esquema · Criar banco de dados · Excluir banco de dados · Criar tabela · Excluir tabela · Esvaziar tabela · Renomear tabela · Otimizar tabela · Listar partições · Excluir partição · Listar mutações · Listar consultas em execução · Encerrar consulta · Ver estatísticas da tabela · Listar clusters
    Padrão:
    Consulta (SELECT)
  • Servidor

    Obrigatório

    Endereço do servidor ClickHouse ao qual o bloco se conecta, como aparece no painel do ClickHouse Cloud ou na sua instalação (ex.: sua-instancia.clickhouse.cloud).

    Exemplo:
    sua-instancia.clickhouse.cloud
  • Porta

    Obrigatório

    Porta de conexão com o ClickHouse; 8443 é a porta segura padrão do ClickHouse Cloud, e servidores próprios sem TLS costumam usar 8123.

    Padrão:
    8443
  • Nome do banco de dados

    Obrigatório

    Banco de dados do ClickHouse em que as operações são feitas; mantenha default se você não criou outro.

    Padrão:
    default
  • Nome de usuário

    Obrigatório

    Define o nome ou título usado para identificar o recurso.

    Padrão:
    default
    Exemplo:
    Exemplo de atendimento
  • Senha

    Dado protegido

    Sua senha do ClickHouse.

    Padrão:
    Segredo protegido
  • Usar HTTPS

    Ativa ou desativa este comportamento.

    Padrão:
    true
  • Nome da tabela

    Obrigatório conforme a operação

    Tabela do ClickHouse em que a operação atua (ex.: eventos); nas operações em que o campo é opcional, deixe vazio para considerar todas as tabelas.

    Aparece em:
    Inserir linha, Inserir linhas (em massa), Atualizar dados, Excluir dados, Descrever tabela, Mostrar o CREATE TABLE, Contar linhas, Listar partições, Criar tabela, Excluir tabela, Esvaziar tabela, Renomear tabela, Otimizar tabela, Excluir partição
    Exemplo:
    eventos
  • Consulta SQL

    Obrigatório conforme a operação

    Informa a consulta usada para localizar ou transformar dados.

    Aparece em:
    Consulta (SELECT)
    Exemplo:
    SELECT * FROM clientes WHERE status = 'ativo'
  • Dados (JSON)

    Obrigatório conforme a operação

    Informa dados estruturados ou código no formato exigido pelo campo.

    Aparece em:
    Inserir linha
    Exemplo:
    { "chave": "valor" }
  • Linhas (lista JSON)

    Obrigatório conforme a operação

    Informa dados estruturados ou código no formato exigido pelo campo.

    Aparece em:
    Inserir linhas (em massa)
    Exemplo:
    { "chave": "valor" }
  • Condição WHERE

    Obrigatório conforme a operação

    Define a consulta ou o filtro aplicado aos dados.

    Aparece em:
    Atualizar dados
    Exemplo:
    status = 'ativo'
  • Nome do banco de dados

    Obrigatório conforme a operação

    Define o nome ou título usado para identificar o recurso.

    Aparece em:
    Criar banco de dados, Excluir banco de dados
    Exemplo:
    Exemplo de atendimento
  • Colunas (array JSON)

    Obrigatório conforme a operação

    Informa dados estruturados ou código no formato exigido pelo campo.

    Aparece em:
    Criar tabela
    Exemplo:
    { "chave": "valor" }
  • Engine

    Engine de armazenamento da nova tabela, que define como os dados são gravados e organizados; MergeTree atende à maioria dos casos.

    Aparece em:
    Criar tabela
    Padrão:
    MergeTree
  • Ordenar por

    Obrigatório conforme a operação

    Coluna ou colunas que formam a chave de ordenação da nova tabela (ex.: id ou (cliente_id, data)); prefira as colunas mais usadas nos filtros das consultas.

    Aparece em:
    Criar tabela
    Exemplo:
    id ou (id, ts)
  • Particionar por (opcional)

    Expressão opcional que divide a nova tabela em partições (ex.: toYYYYMM(data) cria uma partição por mês), o que facilita apagar ou arquivar períodos inteiros.

    Aparece em:
    Criar tabela
    Exemplo:
    toYYYYMM(ts)
  • Novo nome da tabela

    Obrigatório conforme a operação

    Nome que a tabela vai passar a ter depois de renomeada (ex.: eventos_arquivo).

    Aparece em:
    Renomear tabela
    Exemplo:
    eventos_arquivo
  • Forçar mesclagem final

    Ativa ou desativa este comportamento.

    Aparece em:
    Otimizar tabela
    Exemplo:
    false
  • Partição

    Obrigatório conforme a operação

    Identificador da partição que será excluída, conforme o particionamento da tabela (ex.: 202401 para janeiro de 2024 em uma tabela particionada por mês).

    Aparece em:
    Excluir partição
    Exemplo:
    202401 ou '2024-01'
  • ID da consulta

    Obrigatório conforme a operação

    O query_id da consulta a encerrar.

    Aparece em:
    Encerrar consulta
    Exemplo:
    id-do-recurso
  • Só mutações em andamento

    Ativa ou desativa este comportamento.

    Aparece em:
    Listar mutações
    Exemplo:
    false

Saídas

Para usar um resultado deste bloco em uma etapa seguinte, digite < no campo e escolha o bloco e o campo. A referência tem o formato <clickhouse.message>: antes do ponto vai o nome do bloco no seu fluxo, em minúsculas, sem espaços e sem acentos.

ReferênciaTipoO que contém
<clickhouse.message>stringMensagem de sucesso ou de erro que descreve o resultado da operação.
<clickhouse.rows>arrayLista de linhas retornadas pela operação.
<clickhouse.rowCount>numberNúmero de linhas retornadas ou afetadas pela operação.
<clickhouse.count>numberContagem de linhas (operação de contar linhas).
<clickhouse.ddl>stringComando CREATE TABLE (operação Mostrar o CREATE TABLE).
<clickhouse.tables>arrayLista dos esquemas das tabelas, com colunas e engines (operação de inspeção do esquema).

Exemplo de uso

Objetivo: Localizar um cadastro e aproveitar seus dados nas etapas seguintes.

InícioClickHousepróxima etapa
Operação
Consulta (SELECT)
Servidor
sua-instancia.clickhouse.cloud
Porta
8443
Nome do banco de dados
default
Nome de usuário
Exemplo de atendimento
Usar HTTPS
true

Os valores são ilustrativos. Teste primeiro com dados fictícios ou de homologação.

Erros comuns e como resolver

O bloco não executa
Confira se existe um caminho de setas que parte do gatilho (ou do Início) até este bloco. Blocos soltos no desenho são ignorados.
Aparece “Validação do fluxo” no terminal
Há campo obrigatório vazio. Clique no aviso, abra o bloco indicado e preencha o campo marcado.
Um campo chega vazio na etapa seguinte
Confira se a referência aponta para um bloco que já executou e para um campo que existe, como <clickhouse.message>. O nome antes do ponto é o nome do bloco no seu fluxo, em minúsculas, sem espaços e sem acentos.
O campo que eu procuro não aparece
Os campos mudam conforme a operação escolhida. Escolha a operação primeiro; campos menos usados ficam em “Mostrar campos adicionais”.
Credencial ausente ou recusada
Escolha uma conexão válida do workspace. Se a senha ou a chave mudou no serviço, atualize a conexão cadastrada em vez de colar o segredo no bloco.
Não foi possível conectar ao banco
Confira endereço, porta, nome do banco e usuário da conexão, e se o banco aceita conexões vindas da plataforma (firewall e lista de IPs liberados).
O serviço recusou a chamada ou devolveu erro
Leia a mensagem no terminal: ela traz o motivo informado pelo serviço. Confira IDs, limites de uso e permissões, e teste antes com um recurso de homologação.

Blocos relacionados