Skip to main content

Module explain

Module explain 

Source
Expand description

faucet explain — plain-English narration of what a pipeline does (#389).

Where faucet plan is structured and machine-oriented, explain reads like prose: “Reads orders from S3 → applies flatten, rename_keys → writes to BigQuery with upsert on id. Expands to 4 matrix rows; delivery: effectively-once.” It is built entirely from the already-resolved ExpandedNodes — fully offline, zero I/O, no source is touched.

Secrets are never printed: connectors are described by their kind plus a curated allowlist of structural, non-secret fields (table, path, topic, …). url / connection_url / auth and friends are deliberately excluded, and the rendered output is run through the secret scrubber as a backstop.

Functions§

run
Execute the explain subcommand.