MySQL CDC

Install

cargo install faucet-cli --features source-mysql-cdc
faucet init --source mysql-cdc

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

Starter config

source:
  type: mysql-cdc
  config:
    connection_url: ""    # REQUIRED — Connection URL, e.g.
    server_id: 0    # REQUIRED — Replica server id.
    # include_tables: []    # Optional client-side allowlist of `db.table` names.
    # exclude_tables: []    # Optional client-side blocklist of `db.table` names (allowlist wins).
    # start_position: { type: current }    # one of: current, earliest, gtid_set, file_pos
      # --- Alternative variants — replace the block above with one of these ---
      # type: earliest
      #
      # type: gtid_set
      # value: ""    # REQUIRED
      #
      # type: file_pos
      # file: ""    # REQUIRED
      # pos: 0    # REQUIRED
    # include_columns: true    # Emit the pre-image (`before`) on updates/deletes.
    # emit_schema_changes: false    # Emit DDL statements as `{op:"ddl"}` records.
    # tls: { type: disable }    # one of: disable, require, verify_ca, verify_full
      # --- Alternative variants — replace the block above with one of these ---
      # type: require
      #
      # type: verify_ca
      # ca_path: ""
      #
      # type: verify_full
      # ca_path: ""
    # idle_timeout: 30    # Terminator: end the fetch cycle after this much quiet.
    # max_staged_records: 1000000    # Max records buffered for a single in-progress transaction before abort.
    # batch_size: 1000    # Advisory per-page record count.

Capabilities

Config fields