Skip to content

Braidplane documentation

Braidplane is a declarative, contract-based data integration platform. Define ETL pipelines in Git, connect databases, APIs and file stores, and inspect each run's version and results.

Explore the platform

Start with the question your team needs to answer: which system holds the records, what needs to change or move, and where should the result go? Then choose the UI tutorial or CLI tutorial to connect a system you already use and run one connector-appropriate safe read.

If you do not have infrastructure, How Braidplane works is a reading tour that needs no account, CLI, database, or cloud bucket.

Then explore the connectors: see which systems you can connect, what each connector reads and writes, and its current limitations. When you are ready to connect a system, follow Connect a system.

Choose a complete synthetic workflow from Pipeline examples. Each recipe includes a pipeline definition, sample data, connection bindings, expected results and setup commands.

Common workflow patterns

Use these patterns to plan how data moves between your systems.

  • Database orders → mapped HubSpot properties: read order or customer records from a database such as MongoDB, normalize document objects to rows, then use a HubSpot upsert with a stable unique key and an explicit input-field-to-property mapping. The HubSpot guide shows the required property setup and mapping.
  • Joined JSON → S3: join compatible database rows or CSV files from GitHub, then write the result as a JSON object. The synthetic PostgreSQL-to-S3 walkthrough includes the pipeline file, expected rows, and prerequisites.
  • HTTP JSON → scheduled CSV in FTP: read an HTTP API response containing an object or array of objects, normalize it to rows, and attach an enabled schedule trigger to a deployed pipeline whose sink writes CSV to FTP. Schedule resources are managed for a project environment; the FTP guide documents CSV output and the connector's plain-FTP limits.
  • Snowflake ledger rows → CSV in S3: query the period's rows in Snowflake, keep the output contract row-shaped, and write CSV to a dedicated S3 key. The S3 guide documents structured row output and the explicit write format.

The pipeline specification reference explains how to define steps, bind connections and deploy a pipeline.

See the Core issue tracker for planned work and proposals.

The API reference describes the API available in this environment.

Help and contributions

Use GitHub Issues for bugs, questions and connector proposals. See the contribution guide for setup, checks and review, and support and maintenance for current version coverage and conduct guidance. Report security concerns privately to contact@braidplane.com, following the security policy. Remove credentials, tenant data and private URLs from public reports.