SFTP

Install

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

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

Starter config

sink:
  type: sftp
  config:
    host: ""    # REQUIRED — Server hostname or IP address.
    # port: 22    # Server port (default: 22).
    username: ""    # REQUIRED — SSH username.
    # known_hosts: { type: strict }    # one of: strict, accept_new, insecure
      # --- Alternative variants — replace the block above with one of these ---
      # type: accept_new
      #
      # type: insecure
    # connect_timeout_secs: 30    # Seconds the TCP connect, SSH handshake and authentication together may take, and then each SFTP channel's start (default 30).
    # keepalive_interval_secs: 15    # Seconds between SSH keepalives on a quiet connection (default 15); the connection is dropped after three go unanswered.
    path: ""    # REQUIRED — Remote directory the files are written in.
    # file_name: ""    # File-name template inside `path` — the file sink's `path` file name (#777).
    # if_exists: null    # What happens when a file this run writes already exists (`if_exists`).
    # write_mode: null    # Pipeline-level write mode (`write_mode`).
    # compression: null    # User-facing compression config.
    # format: null    # On-the-wire format of files written by the SFTP sink (#604).
    # file_extension: ".jsonl"    # File extension for written objects (default: `.jsonl`).
    # batch_size: 1000    # Records per file when `max_records_per_file` is not set (without `file_name`).
    # concurrency: 4    # Maximum number of file uploads in flight over the SSH session (default 4): a page that rolls into several files uploads them concurrently while the next file is encoded.
    # max_records_per_file: 0    # Maximum records per file before rolling to a new one (#618).
    # max_bytes_per_file: 0    # Maximum **bytes** per file before rolling to a new one (#618).
    # 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 files at rest (#777; the `encryption` feature).
    # scratch_dir: ""    # Directory the sink builds each file in before uploading it (default: the system temporary directory).
    # max_listed_entries: 1000000    # Entries one directory listing may scan (default 1,000,000).

Capabilities

Config fields