Skip to content

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

Updated on 2026-10-04

MySQL — connector

Connects to your MySQL database and extracts tables to our cloud on a schedule. Supports incremental load by watermark.

On this page (15)

Leia antes: ../conectores.md (map of states) and fichas.md (index of the cards).


What it is#

Connects to your MySQL database and extracts tables to our cloud on a schedule. Supports incremental load by watermark.

Supported ingestion modes:

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

What it’s for#

Bring data from MySQL 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 workspace isolation.

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 in the plan).
  • Access: requires an active workspace — with a past-due, suspended or canceled subscription, the run is blocked.
  • Shutdown: the ingestion run can be turned off temporarily (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 never stored in the connection config, pipeline definition, export or DAG. By default the encrypted value is stored 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 (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#

CampoRótuloTipoObrigatórioObservação
hostServer addresstextyesServer name or IP of the database. Your system admin (IT or ERP vendor) can provide this.
portPortnumberyesdefault: 3306; Comes prefilled with the default port (3306). Only change if your IT says otherwise.
databaseDatabase nametextyesThe database name on the server.
schemaSchematextnoOptional. Leave empty to see all tables the user can see.
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.
oracleConnectByIdentify the DB byselectionnodefault: service; options: service / sid; Your IT knows if the Oracle database uses Service Name (more common) or SID.
serviceNameService Nametextnoappears when oracleConnectBy = service
sidSIDtextnoappears when oracleConnectBy = sid
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; optional external vault); appears when network = ssh

Step by step#

  1. In the menu Dados → Conexões, use Nova conexão.
  2. Choose MySQL in 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. Afterwards, Ativar agenda and Executar agora are separate actions.

Example — connection test#

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

text
# Exemplo sintético (valores fictícios — não são credenciais reais)
host = db.exemplo.invalid
port = 3306
database = vendas
schema = public
user = leitura_bi
password = •••••• (cifrado — nunca exibido)
oracleConnectBy = service
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); includes 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#

  • Workspace scoping: each client reads and writes only to its 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 stays in the database. Changing the value here DOES NOT revoke the credential at the origin.
  • Redaction: all errors/logs go through secret redaction (raw, URL-encoded and in JSON).
  • Production does not mock: a path that would hit a mock triggers 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 How we reach the database.
  • 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 — the extraction respects the pages/rows cap; use incremental load by watermark to reduce volume.

Troubleshooting#

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

Related#


Last review: 2026-10-04. Card automatically generated from the product connector catalog.

Related links