Reference
What Reference contains#
Reference is the lookup half of this documentation. The User Guide explains how to build a pipeline; Reference tells you exactly what the platform accepts, what it enforces, and where a combination is refused.
Every page here is written against the code that enforces the behaviour, not against the option lists the UI offers. Where the two disagree, Reference states the enforced reality and says so.
How to read the matrices#
Several pages lead with a capability matrix. The conventions are the same throughout:
- Yes — the combination is supported and exercised by the platform.
- No — the combination is refused. It may be refused when you save the configuration, or at run time on the first execution; each page says which.
- A capability listed for an engine is scoped to the role in that column. An engine that is a good extract source is frequently not a valid destination, and the reverse.
- Matrices are per-engine, never per-connector. Two connectors on the same engine always have identical capabilities; what differs is credentials and reachability.
Note. If the UI offers a combination that a matrix here marks as unsupported, trust the matrix. The known gaps are called out inline on the affected pages.
Pages#
- Connectors — all 14 engines, the engine × capability matrix, how the shared connection fields are repurposed per engine, per-engine limitations, and what a connection test actually probes.
- CDC strategies — the four change-capture strategies, the enforced engine matrix, delete-detection limits, and the source prerequisites each strategy needs on the database side.
- Load modes — the five ETL load modes, their required task fields, the SQL shape each one issues, and what happens to rows already in the destination.
- Schema drift policies — Reject, Evolve and Rescue: what each does per drift kind, the rescue payload and promote workflow, and the per-pipeline-family defaults.
- Stream destinations — the stream fan-out sinks and their per-destination configuration and delivery semantics.
- API — the HTTP surface, authentication, and error shapes.
- Metrics — the Prometheus metric names the platform exposes.