Local files

Install

cargo install faucet-cli --features sink-file
faucet init --sink file

# Cargo.toml — use it as a library
cargo add faucet-sink-file

Starter config

sink:
  type: file
  config:
    path: ""    # REQUIRED — The file to write, as a template.
    # format: null    # Which format a file is in: resolved from its extension (`auto`) or fixed.
    # compression: null    # User-facing compression config.
    # if_exists: null    # What happens when a file this run writes already exists (`if_exists`).
    # write_mode: null    # Pipeline-level write mode (`write_mode`).
    # max_records_per_file: 0    # Roll to a new file after this many records.
    # max_bytes_per_file: 0    # Roll to a new file once the current one reaches about this many bytes, counted on the records' JSON length before compression (on the columnar Parquet path, their in-memory Arrow size).
    # create_dirs: true    # Create missing parent directories (default `true`).
    # batch_size: 1000    # Records per upstream page.
    # csv: { ... }    # CSV dialect.
    # excel: { ... }    # Excel worksheet selection.
    # xml: { ... }    # XML record framing.
    # avro: { ... }    # Avro read/write options.
    # parquet: { ... }    # Parquet write options.
    # json_lines: { ... }    # JSON Lines write options.
    # encryption: null    # Encrypt the output at rest (AES-256-GCM).

Capabilities

Config fields