Skip to content

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

Updated on 2026-10-04

Neon — connector

Connects to the endpoint of your Neon branch (serverless Postgres, TLS required) and extracts tables on schedule. Supports incremental load by watermark.

On this page (15)

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


What it is#

Connects to the endpoint of your Neon branch (serverless Postgres, TLS required) and extracts tables on schedule. Supports incremental load by watermark.

Supported ingestion modes:

  • Nós buscamos — Nós buscamos os dados na sua fonte.

What it's for#

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

When to use / when not to use#

Use when you need to consolidate this source into the datalake on a schedule, with isolation by workspace.

Avoid unnecessary full loads on large tables: prefer incremental load by watermark (see Limits and the incremental guide).

Plan and permissions#

  • Plan: core product (connectors are part of all plans; the limit is the number of sources allowed by the plan).
  • Access: requires an active workspace — with the subscription overdue, suspended or cancelled, the run is blocked.
  • Shutdown: the ingestion run can be turned off temporarily (maintenance or incident). When that happens, the UI indicates the resource is unavailable at the moment.

Prerequisites#

  • A database user with read-only permissions on the desired schema/tables.
  • Network: choose how we reach the database — public IP + allowlist, SSH tunnel (bastion), cloudsql or VPN.

Credentials#

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

  • Password (password) — Stored encrypted. After saving, no one can view it again — not even you.
  • SSH private key (sshPrivateKey)

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

Form fields#

FieldLabelTypeRequiredNote
hostServer addresstextyesServer name or IP of the database. Your system administrators (IT or ERP provider) can provide this.
portPortnumberyesdefault: 5432; comes prefilled with the default port (5432). Only change if your IT says otherwise.
databaseDatabase nametextyesThe name of the database inside the server.
schemaSchematextnoOptional. Leave blank to see all tables the user can access.
userUsertextyesPrefer a READ-ONLY user created for BI.
password 🔒Passwordpassword/secretyessecret (encrypted; external vault optional); Stored encrypted. After saving, no one can view it again — not even you.
sslmodeConnection security (SSL)selectionnodefault: require; options: disable / require / verify-ca / verify-full; Leave at “require” (protected connection). Only change if your IT asks.
networkHow we reach the databaseselectionnodefault: direct; options: direct / ssh / cloudsql / vpn; In most cases it is “direct over the internet”. Use SSH tunnel if the database only accepts access from the internal network.
sshHostBastion host (SSH)textnoappears when network = ssh
sshPortBastion portnumbernodefault: 22; appears when network = ssh
sshUserBastion usertextnoappears when network = ssh
sshPrivateKey 🔒SSH private keypassword/secretnosecret (encrypted; external vault optional); appears when network = ssh

Step by step#

  1. In the menu Dados → Conexões, use Nova conexão.
  2. Choose Neon in the catalog.
  3. Fill the form fields (see the table above).
  4. Use Testar conexão. The result is shown broken down into Conectividade, Autenticação and Listagem/leitura — each with OK, Failed, Not applicable or Not tested. A capability with no test of its own for this connector shows as Not applicable, and Not applicable never counts as success.
  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 running anything. Afterwards, Ativar agenda and Executar agora are separate actions.

Example — connection test#

Sample configuration (all values fictional; secrets appear masked):

text
# Exemplo sintético (valores fictícios — não são credenciais reais)
host = db.exemplo.invalid
port = 5432
database = vendas
schema = public
user = leitura_bi
password = •••••• (cifrado — nunca exibido)
sslmode = require
network = direct

Expected result#

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 ceiling per run (default 10,000 pages / 5,000,000 rows); anti-loop guard.
  • Incremental by watermark: append/keyset by key-column. Not CDC — does not capture deletes or UPDATEs outside the watermark window. True CDC (WAL/redo/binlog) is on the Roadmap.
  • Estimated volume: ~5 GB/month (catalog estimate, not measurement).
  • Cost: the extraction itself is not charged by the platform; the Bronze load consumes datalake processing (billable).

Security#

  • Scope by workspace: each customer reads and writes only to their own datalake (<prefixo>_bronze / _silver / _gold); there is never leakage between workspaces.
  • Encrypted secrets: 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. Rotating the value here does NOT revoke the credential at the source.
  • Redaction: every error/log goes 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#

  • Connection refused / timeout — host, port or network rule (allowlist/SSH/VPN) incorrect. Check the chosen network mode in Como conectamos.
  • Authentication failed — invalid user/password or user without read permission on the schema.
  • SSL/handshake — adjust sslmode (PostgreSQL) or encrypt (SQL Server) according to the server's requirement.
  • Large table/query — extraction respects the pages/rows ceiling; use incremental load by watermark to reduce volume.

Troubleshooting#

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

Related#


Last review: 2026-10-04. Fact sheet automatically generated from the product's connectors catalog.

Related links