Skip to main content
Version: Next

Example catalog

These examples are maintained with the repository and checked by pnpm docs:check. Service-backed examples require the corresponding local service; use the quickstart first when learning the configuration shape.

WorkflowExampleUse it for
Quickstartgenerate_example.yamlA local source-to-stdout pipeline
Kafkakafka_example.yamlKafka input configuration
SQL outputsql_output_example.yamlDatabase sink configuration
Durabilitydurability_example.yamlPer-stream WAL durability
S3 durabilitydurability_example_s3.yamlObject-storage-backed recovery
Control planecontrol_plane_example.yamlHub and compute-node operation
Control plane hubcontrol_plane_hub.yamlFleet-level configuration
Debezium CDCcdc_debezium.yamlCDC envelope decoding

For each service-backed example, validate credentials and endpoints before running it in a shared environment.