Leia antes:
../conectores.md(map of states) andfichas.md(index of datasheets).
What it is#
Connects to your AlloyDB instance (managed Postgres, private IP via VPN or SSH bastion) and extracts tables on a schedule. Supports incremental load by watermark.
Supported ingestion modes:
- We pull — We pull the data from your source.
What it's for#
Bring data from AlloyDB 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 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 in the plan).
- Access: requires an active workspace — with the subscription overdue, suspended or canceled, the run is blocked.
- Shutdown: the ingestion run can be turned off temporarily (maintenance or incident). When this happens, the UI indicates the resource is currently unavailable.
Prerequisites#
- A read-only user on the database, with access to the desired schema/tables.
- Network: choose how we reach the database — public IP + allowlist, SSH tunnel (bastion), Cloud SQL 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 this connection's credential to the external credential vault is an explicit choice, made per connection after saving — see ../../administracao/credenciais-e-rotacao.md.
- Senha (
password) — Stored encrypted. Once saved, no one can see it again — not even you. - Chave privada SSH (
sshPrivateKey)
Secrets are never re-displayed and are redacted in every error/log (raw token, URL-encoded and in JSON).
Form fields#
| Campo | Rótulo | Tipo | Obrigatório | Observação |
|---|---|---|---|---|
host | Server address | text | yes | Name or IP of the database server. Your system administrator (IT or ERP vendor) can provide this. |
port | Port | number | yes | default: 5432; Comes prefilled with the default port (5432). Only change if your IT says otherwise. |
database | Database name | text | yes | The database name inside the server. |
schema | Schema | text | no | Optional. Leave empty to see all tables the user can access. |
user | User | text | yes | Prefer a READ-ONLY user created for BI. |
password 🔒 | Password | password/secret | yes | secret (encrypted; external vault optional); Stored encrypted. Once saved, no one can see it again — not even you. |
sslmode | Connection security (SSL) | selection | no | default: require; options: disable / require / verify-ca / verify-full; Leave set to “require” (protected connection). Only change if your IT asks. |
network | How we reach the database | selection | no | default: direct; options: direct / ssh / cloudsql / vpn; In most cases it is “direct” (over the internet). Use an SSH tunnel if the database only accepts access from the internal network. |
sshHost | Bastion host (SSH) | text | no | appears when network = ssh |
sshPort | Bastion port | number | no | default: 22; appears when network = ssh |
sshUser | Bastion user | text | no | appears when network = ssh |
sshPrivateKey 🔒 | SSH private key | password/secret | no | secret (encrypted; external vault optional); appears when network = ssh |
Step-by-step#
- In the menu Dados → Conexões, use Nova conexão.
- Choose AlloyDB in the catalog.
- Fill in the form fields (see the table above).
- 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.
- Use Salvar conexão. Saving does NOT start any ingestion.
- 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.
- In the review, Publicar (agenda desligada) creates version 1 without running anything. Then, Ativar agenda and Executar agora are separate actions.
Example — connection test#
Example configuration (all values are fictitious; secrets appear masked):
# 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 = directExpected 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 carga Bronze consumes datalake processing (chargeable).
Security#
- Scope by workspace: each customer reads and writes only to their own datalake (
<prefix>_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 is kept in the database. Changing 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 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) orencrypt(SQL Server) according to the server 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 observabilidade por conector (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#
../conectores.md— connector catalog by state../ingestao-incremental-backfill.md— full, incremental by watermark, backfill and checkpoint../pipeline-medalhao.md— Bronze/Silver/Gold layers and quality../agendamento-retry-dlq.md— scheduling, retry/backoff and DLQ../custo-limites-seguranca.md— cost, ceilings and workspace security
Last review: 2026-10-04. Datasheet automatically generated from the product's connector catalog.