Databricks

Install

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

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

Starter config

source:
  type: databricks
  config:
    workspace_url: ""    # REQUIRED — Workspace base URL, e.g.
    warehouse_id: ""    # REQUIRED — Target SQL Warehouse id.
    sql: ""    # REQUIRED — The SQL statement to run.
    auth:
      type: pat    # one of: pat, token
      config:
        token: ""    # REQUIRED — The token string (use `${env:…}` / `${vault:…}` to inject).
      # --- Alternative variants — replace the block above with one of these ---
      # type: token
      # config:
        # token: ""    # REQUIRED
    # catalog: ""    # Default Unity Catalog catalog for the statement.
    # schema: ""    # Default schema for the statement.
    # parameters: []    # Named SQL parameters (`:name` markers).
    # wait_timeout_secs: 50    # Server-side wait before the statement goes async (seconds).
    # poll_interval_secs: 1    # Client poll cadence while the statement is `PENDING`/`RUNNING` (seconds).
    # statement_timeout_secs: 3600    # Client deadline for the statement to finish, in seconds; on expiry it is cancelled and the read fails.
    # batch_size: 1000    # Page size — rows accumulated before a `StreamPage` is emitted.
    # arrow_native: false    # Fetch results as Apache Arrow instead of JSON.
    # result_disposition: null    # How the row path receives a statement's result (ignored under `arrow_native`, which always uses external links).
    # 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