PostgreSQL

Install

cargo install faucet-cli --features source-postgres
faucet init --source postgres

# Cargo.toml — use it as a library
cargo add faucet-source-postgres

Starter config

source:
  type: postgres
  config:
    connection_url: ""    # REQUIRED — PostgreSQL connection URL (e.g.
    query: ""    # REQUIRED — SQL query to execute.
    # params: []    # Bind parameters for the query.
    # max_connections: 10    # Maximum number of connections in the pool.
    # batch_size: 1000    # Records per emitted `StreamPage`.
    # shard: null    # Optional primary-key range sharding for clustered (Mode B) execution.
    # read_timeout_secs: 3600    # Longest the source waits on the server for the next row (or for a whole result in `fetch_all`), in seconds, before the read fails.
    # json_big_numbers: null    # What to do with a number inside a JSON / JSONB column that a 64-bit float cannot hold exactly.
    # replication: { type: full }    # one of: full, incremental
      # --- Alternative variants — replace the block above with one of these ---
      # type: incremental
      # column: ""    # REQUIRED
      # initial_value: null    # REQUIRED
    # state_key: ""    # Explicit state-store key for the incremental bookmark.

Capabilities

Config fields