Documentation Index
Fetch the complete documentation index at: https://docs.springtail.io/llms.txt
Use this file to discover all available pages before exploring further.
FDW Node Architecture Overview
An FDW node is a managed replication-and-query endpoint that hosts a dedicated Postgres instance and a small set of Springtail services responsible for keeping that instance synchronized with the primary system. The node is designed to be self-starting, self-monitoring, and capable of controlled shutdown to avoid disrupting active client traffic.Core components
Postgres (FDW database instance)
The local Postgres service on the FDW node is the execution environment for:- FDW-side databases and schemas
- Foreign tables that reference primary-side data
- Select locally-created objects required to support schema shape, partitioning, and metadata consistency
FDW extension (query interface inside Postgres)
The FDW node’s Postgres instance is extended with a Springtail-provided Foreign Data Wrapper implemented as a shared library loaded into Postgres (installed as a Postgres extension). This extension provides the read path by:- Integrating with Postgres’ FDW APIs so queries can reference foreign tables normally.
- Interpreting and planning read-only access through the foreign-table definitions created during schema import.
- Acting as the boundary where SQL executed on the FDW node is translated into remote reads against the primary-side data source(s), while preserving Postgres semantics for query parsing and execution.
Coordinator (process supervisor)
The coordinator is the control-plane process on the node. It is responsible for:- Starting the node’s components in the correct order
- Waiting for upstream dependencies to be available before enabling replication services
- Monitoring liveness/health and restarting components when failures occur
- Orchestrating controlled state transitions (including draining before shutdown)
XID Subscriber
The XID Subscriber is a background service that participates in the system’s transaction/XID coordination. On an FDW node it runs alongside the DDL Manager and supports consistent progress tracking and coordination with the rest of the platform.DDL Manager
The DDL Manager is the data-plane replication worker for schema and access-control state on the FDW node. It is responsible for:- Bootstrapping FDW-side databases (creating databases/schemas, installing prerequisites, and importing foreign schema)
- Applying ongoing DDL change batches delivered asynchronously
- Running periodic synchronization of roles, role memberships, policies, and ownership metadata from the primary into the FDW node