GraphQL

Install

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

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

Starter config

source:
  type: graphql
  config:
    endpoint: ""    # REQUIRED — GraphQL endpoint URL.
    query: ""    # REQUIRED — The GraphQL query string.
    # variables: {}    # Variables to pass with the query.
    auth:
      type: none    # one of: none, bearer, custom
      # --- Alternative variants — replace the block above with one of these ---
      # type: bearer
      # config:
        # token: ""    # REQUIRED
      #
      # type: custom
      # config:
        # headers: {}    # REQUIRED
    # records_path: ""    # JSONPath expression to extract records from the response.
    # pagination: null    # Pagination configuration.
    # max_pages: 0    # Maximum number of pages to fetch.
    # batch_size: 1000    # Records per emitted `StreamPage`, and the value injected as the GraphQL `first:` cursor argument (or whatever variable name `GraphqlPagination::page_size_variable` specifies).
    # tls: null    # Optional client-certificate (mutual TLS) config.
    # replication_method: { type: FullTable }    # one of: FullTable, Incremental
      # --- Alternative variants — replace the block above with one of these ---
      # type: Incremental
    # replication_key: ""    # Field used for incremental replication bookmarking: a top-level field (`updatedAt`), a dot path into nested objects (`node.updatedAt`), or a JSON Pointer (`/node/updatedAt`).
    # on_missing_key: null    # What to do with a record whose replication key is missing or `null` (#747).
    # start_replication_value: null    # Initial bookmark used when no stored bookmark exists: records whose `replication_key` is not greater than it are filtere…
    # state_key: ""    # Identifier the pipeline persists this stream's bookmark under.
    # replication_bind: null    # Bind the bookmark into a GraphQL variable (see `GraphqlReplicationBind`).
    # replication_key_ordered: false    # Declares that the query returns records in ascending `replication_key` order.
    # retry_on_response: []    # Responses to treat as throttling and retry — including a `200` whose body reports it (`match_success: true` with `body_path: "$.errors[*].extensions.code"`, `values: [THROTTLED]`).
    # timeout: 30    # Per-request timeout in seconds.
    # connect_timeout: 10    # Timeout for establishing a connection, in seconds.

Capabilities

Config fields