Skip to content

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

Updated on 2026-10-04

SQL Server — connector

Connects to your SQL Server and extracts tables to our cloud on schedule. Supports incremental load by watermark.

On this page (15)

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


What it is#

Connects to your SQL Server and extracts tables to our cloud on schedule. Supports incremental load by watermark.

Supported ingestion modes:

  • Nós buscamos — We pull the data from your source.

What it's for#

Bring data from SQL Server 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.

Avoid unnecessary full loads on large tables: prefer the 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 — if the subscription is overdue, suspended or cancelled, the run is blocked.
  • Disablement: the ingestion run can be temporarily disabled (maintenance or incident). When this happens, the screen indicates the feature is unavailable at the moment.

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 exports or in the DAG. By default the encrypted value is stored in the database; moving the credential for this connection to an external credentials vault is an explicit choice, made 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 across any error/log (raw token, URL-encoded and in JSON).

Form fields#

FieldLabelTypeRequiredNote
hostServer addresstextyesName or IP of the database server. Your IT or ERP vendor can provide this.
portPortnumberyesdefault: 1433; comes prefilled with the default port (1433). Change only if your IT says it's different.
databaseDatabase nametextyesThe name of the database on the server.
schemaSchematextnoOptional. Leave empty to see all tables the user can access.
userUsertextyesPrefer a READ-ONLY user created for BI.
password 🔒Passwordpassword/secretyessecret (encrypted; optional external vault); Stored encrypted. After saving, no one can view it again — not even you.
encryptProtected connection (encryption)yes/nonodefault: yes
networkHow we reach the databaseselectionnodefault: direct; options: direct / ssh / cloudsql / vpn; In most cases this is “direct over the internet”. Use an 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; optional external vault); appears when network = ssh

Step by step#

  1. In the menu Dados → Conexões, use Nova conexão.
  2. Choose SQL Server from the catalog.
  3. Fill in 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. After that, Ativar agenda and Executar agora are separate actions.

Example — connection test#

Example configuration (all values fictitious; secrets appear masked):

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

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.
  • 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 a measurement).
  • Cost: the extraction itself is not charged by the platform; the Bronze load consumes datalake processing (billable).

Security#

  • Scope by workspace: each client 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 persisted. The external credentials vault is optional and enabled per connection; without it, the encrypted value is stored in the database. Changing the value here DOES NOT revoke the credential at the source.
  • Redaction: every error/log passes through secret redaction (raw, URL-encoded and in JSON).
  • Production does not fake: a path that would hit a mock triggers the production guard (explicit failure instead of simulating success).

Common errors#

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

Troubleshooting#

  • Use Testar conexão to isolate credential/network problems before scheduling.
  • Monitor the 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 column/type change = attention).

Related#


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

Related links