Skip to content

Automatic translation — the Portuguese version is the reference. View in Portuguese

Updated on 2026-10-04

ClickHouse — connector

Reads the tables of a ClickHouse database via the HTTP interface (paginated SQL queries) and loads them into the Bronze layer.

On this page (15)

Read before: ../conectores.md (state map) and fichas.md (index of sheets).


What it is#

Reads the tables of a ClickHouse database via the HTTP interface (paginated SQL queries) and loads them into the Bronze layer.

Supported ingestion modes:

  • We pull — We pull the data from your source.

What it's for#

Bring data from ClickHouse into your datalake and make it available to the Bronze/Silver/Gold layers, BI models, and the natural language question wizard.

When to use / when not to use#

Use when you need to consolidate this source into the datalake on a scheduled basis, with isolation per workspace.

Remember that the first run with a real credential is followed by our team before the connector is fully released.

Plan and permissions#

  • Plan: core of the product (connectors are part of all plans; the limit is the number of sources of the plan).
  • Access: requires an active workspace — with the subscription overdue, suspended or canceled, the run is blocked.
  • Disabling: ingestion runs can be temporarily disabled (maintenance or incident). When that happens, the screen indicates that the feature is unavailable at the moment.

Prerequisites#

  • A ClickHouse account with access to the data you want to ingest.
  • Provide the URL of the ClickHouse HTTP interface (port 8443 with TLS on ClickHouse Cloud; 8123 without TLS) and a user with SELECT permission on the database. Prefer a read-only user. The password is encrypted (AES-256-GCM) and never shown again; leave it blank if the user has no password.

Credentials#

Authentication method: Username and password (or key and secret) using Basic authentication.

Sensitive fields. They are encrypted (AES-256-GCM) and never remain in the connection's config, in the pipeline definition, in the export or in the DAG. By default the encrypted value stays in the database; moving this connection's credential to the external credential vault is an explicit choice, made per connection after saving — see ../../administracao/credenciais-e-rotacao.md.

  • Password (senha) — Optional: leave blank if the user has no password (e.g.: default in local installation).

Secrets are never re-displayed and are redacted in every error/log (raw token, URL-encoded and in JSON).

Form fields#

FieldLabelTypeRequiredNotes
urlServidorServer URL (HTTP)textyesClickHouse HTTP interface, accessible from the internet or from an allowed IP.
bancoDatabasetextyesdefault: default; Only tables from this database are listed.
usuarioUsertextyesdefault: default
senha 🔒Passwordpassword/secretnosecret (encrypted; external vault optional); Optional: leave blank if the user has no password (e.g.: default in local installation).

Step by step#

  1. In the menu Dados → Conexões, use Nova conexão.
  2. Choose ClickHouse in the catalog.
  3. Fill the form fields (see the table above).
  4. Use Testar conexão. The result is shown separately for Network (server reachability), Authentication (user and password) and Read (list tables) — each with OK, Failed, Not applicable or Not tested.
  5. Use Salvar conexão. Saving DOES NOT start any ingestion.
  6. On the connection card, use Montar extração (or go to Orquestração → Pipelines and use Conectar fonte). The pipeline points to the saved connection — the credential is not copied.
  7. In the review, Publicar (agenda desligada) creates version 1 without executing anything. Afterwards, Ativar agenda and Executar agora are separate actions.

Example — connection test#

Sample configuration (all values are fictitious; secrets appear masked):

text
# Exemplo sintético (valores fictícios — não são credenciais reais)
urlServidor = <urlServidor>
banco = default
usuario = default
senha = •••••• (cifrado — nunca exibido)

Expected result#

The Testar conexão returns the list of discovered tables/resources. After the first load, the rows appear in the Bronze layer of your workspace, ready for the pipeline.

Limits and costs#

  • Pagination: hard cap per run (default 10,000 pages / 5,000,000 rows); anti-loop guard.
  • SaaS load: default batchSize 5,000, maxRows 200,000 per resource.
  • Estimated volume: ~1 GB/month (catalog estimate, not measurement).
  • Cost: the extraction itself is not charged by the platform; the Bronze load consumes datalake processing (billable).

Security#

  • Workspace scope: each customer reads and writes only into their own datalake (<prefixo>_bronze / _silver / _gold); there is never leakage between workspaces.
  • Secrets encrypted: sensitive material is encrypted with AES-256-GCM before being stored. The external credential vault is optional and enabled per connection; without it, the encrypted value stays in the database. Changing the value here DOES NOT revoke the credential at the source.
  • Redaction: all errors/logs go through secret redaction (raw, URL-encoded and in JSON).
  • Production does not mock: a path that would fall into a mock triggers the production guard (explicit failure instead of simulating success).

Common errors#

  • Credential rejected (401/403) — the provider did not accept the credential: expired, revoked or lacking the required permission. Reconnect the source (the source and its history are preserved; do not recreate the source).
  • Rate limit (429) — the provider asked to wait. The extraction respects Retry-After and retries; if it repeats, wait and reduce the schedule frequency.
  • Resource not found — check the resource identifier (account, object, report) and the permissions granted.
  • Pagination cursor stuck — the extraction stops when the API cursor does not advance (anti-loop guard). If this happens in consecutive runs, open a support ticket providing the connector and the resource.
  • Empty records path — the response arrived without records in the expected location. Check the selected resource and the filters (period, account, status) before assuming there is no data.

Troubleshooting#

  • Use Testar conexão to isolate credential/network problems before scheduling.
  • Monitor runs in the connector observability (error rate, p50/p95, freshness).
  • A schema change at the source is flagged by the schema drift (new column = info; removed/changed type column = attention).

Related#


Last review: 2026-10-04. Sheet automatically generated from the product connectors catalog.

Related links