ClickHouse
Consultar e alterar dados em um banco ClickHouse.
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
- Adicione ClickHouse ao desenho a partir da aba Blocos e ligue a entrada dele à etapa anterior.
- Escolha uma conexão ou credencial já cadastrada no workspace. Nunca cole senhas ou chaves em campos de texto comuns.
- Escolha a operação. O painel mostra só os campos que essa operação usa.
- Preencha os campos obrigatórios. Para usar um dado de uma etapa anterior, digite < e escolha o bloco e o campo.
- Clique em Executar com dados de teste e confira, no terminal, o que entrou e o que saiu do bloco.
- Só publique depois de conferir o resultado da execução de teste.
Operações
| Operação | O que faz |
|---|---|
| Consulta (SELECT) | Executa a operação “Consulta (SELECT)” com o bloco ClickHouse. |
| Executar SQL livre | Executa SQL livre com o bloco ClickHouse. |
| Inserir linha | Insere linha com o bloco ClickHouse. |
| Inserir linhas (em massa) | Insere linhas (em massa) com o bloco ClickHouse. |
| Atualizar dados | Atualiza dados com o bloco ClickHouse. |
| Excluir dados | Exclui dados com o bloco ClickHouse. |
| Listar bancos de dados | Lista bancos de dados com o bloco ClickHouse. |
| Listar tabelas | Lista tabelas com o bloco ClickHouse. |
| Descrever tabela | Descreve tabela com o bloco ClickHouse. |
| Mostrar o CREATE TABLE | Mostra o CREATE TABLE com o bloco ClickHouse. |
| Contar linhas | Conta linhas com o bloco ClickHouse. |
| Inspecionar esquema | Inspeciona esquema com o bloco ClickHouse. |
| Criar banco de dados | Cria banco de dados com o bloco ClickHouse. |
| Excluir banco de dados | Exclui banco de dados com o bloco ClickHouse. |
| Criar tabela | Cria tabela com o bloco ClickHouse. |
| Excluir tabela | Exclui tabela com o bloco ClickHouse. |
| Esvaziar tabela | Esvazia tabela com o bloco ClickHouse. |
| Renomear tabela | Renomea tabela com o bloco ClickHouse. |
| Otimizar tabela | Otimiza tabela com o bloco ClickHouse. |
| Listar partições | Lista partições com o bloco ClickHouse. |
| Excluir partição | Exclui partição com o bloco ClickHouse. |
| Listar mutações | Lista mutações com o bloco ClickHouse. |
| Listar consultas em execução | Lista consultas em execução com o bloco ClickHouse. |
| Encerrar consulta | Encerra consulta com o bloco ClickHouse. |
| Ver estatísticas da tabela | Mostra estatísticas da tabela com o bloco ClickHouse. |
| Listar clusters | Lista clusters com o bloco ClickHouse. |
Campos
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órioEndereç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órioPorta 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órioBanco 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órioDefine o nome ou título usado para identificar o recurso.
- Padrão:
- default
- Exemplo:
- Exemplo de atendimento
Senha
Dado protegidoSua 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çãoTabela 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çãoInforma 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çãoInforma 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çãoInforma 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çãoDefine 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çãoDefine 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çãoInforma 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çãoColuna 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çãoNome 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çãoIdentificador 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çãoO 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ência | Tipo | O que contém |
|---|---|---|
<clickhouse.message> | string | Mensagem de sucesso ou de erro que descreve o resultado da operação. |
<clickhouse.rows> | array | Lista de linhas retornadas pela operação. |
<clickhouse.rowCount> | number | Número de linhas retornadas ou afetadas pela operação. |
<clickhouse.count> | number | Contagem de linhas (operação de contar linhas). |
<clickhouse.ddl> | string | Comando CREATE TABLE (operação Mostrar o CREATE TABLE). |
<clickhouse.tables> | array | Lista 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.
- 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
- Amazon DynamoDBConsultar, inserir, varrer, atualizar e excluir itens em tabelas do Amazon DynamoDB.
- Amazon RDSConsultar e alterar bancos Amazon RDS compatíveis por meio da Data API.
- DatabricksExecutar consultas SQL e administrar trabalhos no Databricks.
- ElasticsearchPesquisar, indexar e administrar dados no Elasticsearch.
- Google AppSheetConsultar, adicionar, editar e excluir linhas de uma tabela do Google AppSheet.
- Microsoft DataverseConsultar e administrar registros em tabelas do Microsoft Dataverse.