Leia antes:
../conectores.md(mapa de estados) efichas.md(índice das fichas).
What it is#
Reads documents from a Cloud Firestore collection (typed values unwrapped) and the list of root collections, and loads them into the Bronze layer.
Supported ingestion modes:
- Nós buscamos — Nós buscamos os dados na sua fonte.
What it's for#
Bring data from Cloud Firestore 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 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 that happens, the screen indicates that the resource is unavailable at the moment.
Prerequisites#
- A Cloud Firestore account with access to the data you want to ingest.
- In the project IAM (the Firestore project), grant the Cloud Datastore Viewer role (roles/datastore.viewer) to the service account email. Provide the project ID and the name of the collection to read (subcollections accept the full path, e.g.: clientes/abc/pedidos). We do not ask for your Google password.
Credentials#
Authentication method: Sharing with a conta de serviço: you share the resource (the spreadsheet) with the service account email as a Reader. We do not ask for your Google password or access to your entire Drive.
Sensitive fields. They are encrypted (AES-256-GCM) and are never stored in the config of the connection, 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.
- Chave JSON da conta de serviço (
serviceAccountJson)
Secrets are never re-displayed and go through redaction in all errors/logs (raw token, URL-encoded and in JSON).
Form fields#
| Campo | Rótulo | Tipo | Obrigatório | Observação |
|---|---|---|---|---|
projectId | Project ID | text | yes | ID of the Firebase project that hosts the Firestore (database (default)). |
colecao | Collection | text | yes | Collection whose documents become the Bronze table. |
saMode | Conta de serviço | selection | no | default: plataforma; options: plataforma / propria; With ours, you only add the service account email as a reader in the Firestore project. |
serviceAccountJson 🔒 | Service account JSON key | password/secret | no | secret (encrypted; external vault optional); appears when saMode = propria |
Step by step#
- In the menu Dados → Conexões, use Nova conexão.
- Choose Cloud Firestore in the catalog.
- Fill in the form fields (see 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 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)
projectId = meu-projeto-exemplo
colecao = <colecao>
saMode = plataformaExpected result#
Testar conexão returns the list of discovered tables/resources. After the first load, 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.
- SaaS load: default
batchSize5,000,maxRows200,000 per resource. - Estimated volume: ~0.3 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 written. 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: every error/log goes through secret redaction (raw, URL-encoded and in JSON).
- Production does not fake: 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 missing the necessary permission. Reconnect the source (the source and history are preserved; do not recreate the source).
- Rate limit (429) — the provider asked to wait. The extraction respects
Retry-Afterand retries; if it repeats, wait and reduce the schedule frequency. - Resource not found — check the resource identifier (account, object, report) and the granted permissions.
- Pagination cursor stuck — the extraction stops when the API cursor does not advance (anti-loop guard). If it happens in consecutive runs, open a support ticket indicating the connector and the resource.
- Empty record path — the response arrived without records in the expected place. Check the selected resource and filters (period, account, status) before assuming there is no data.
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 column/type changed = 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. Sheet automatically generated from the product connector catalog.