Struct GraphqlStreamConfig 

pub struct GraphqlStreamConfig {
    pub endpoint: String,
    pub query: String,
    pub variables: Value,
    pub auth: AuthSpec<GraphqlAuth>,
    pub headers: HeaderMap,
    pub records_path: Option<String>,
    pub pagination: Option<GraphqlPaginationSpec>,
    pub max_pages: Option<usize>,
    pub batch_size: usize,
    pub tls: Option<TlsClientConfig>,
}

Configuration for the GraphQL source.

Fields

endpoint: String

GraphQL endpoint URL.

query: String

The GraphQL query string.

variables: Value

Variables to pass with the query.

auth: AuthSpec<GraphqlAuth>

Authentication: either inline ({ type, config }) or a { ref: <name> } pointer to a shared provider in the CLI’s top-level auth: catalog.

headers: HeaderMap

Additional request headers.

records_path: Option<String>

JSONPath expression to extract records from the response.

pagination: Option<GraphqlPaginationSpec>

Pagination configuration. None for single-page queries. Accepts either the Relay cursor block (no type:) or an offset block (type: Offset) — see GraphqlPaginationSpec.

max_pages: Option<usize>

Maximum number of pages to fetch.

batch_size: usize

Records per emitted StreamPage, and the value injected as the GraphQL first: cursor argument (or whatever variable name GraphqlPagination::page_size_variable specifies). Defaults to DEFAULT_BATCH_SIZE.

batch_size = 0 is the “no batching” sentinel: the page-size variable is omitted from the request so the upstream uses its own default page size, and the entire result set is emitted as a single page. If the upstream schema requires a non-null first: argument this will surface as FaucetError::Config at stream-time.

tls: Option<TlsClientConfig>

Optional client-certificate (mutual TLS) config. When set, the source presents a client certificate on every request (data + inline auth token request). Requires the crate’s mtls feature.

Implementations

impl GraphqlStreamConfig

pub fn new(endpoint: impl Into<String>, query: impl Into<String>) -> Self

Create a new config with an endpoint and query.

pub fn tls(self, tls: TlsClientConfig) -> Self

Attach a mutual-TLS client identity (requires the mtls feature at build time; otherwise GraphqlStream::try_new errors).

pub fn variables(self, vars: Value) -> Self

Set the GraphQL variables.

pub fn auth(self, auth: GraphqlAuth) -> Self

Set the authentication method.

pub fn headers(self, headers: HeaderMap) -> Self

Set additional headers.

pub fn records_path(self, path: impl Into<String>) -> Self

Set the JSONPath expression for record extraction.

pub fn pagination(self, pagination: GraphqlPagination) -> Self

Enable cursor-based (Relay) pagination with the given configuration.

pub fn offset_pagination(self, pagination: GraphqlOffsetPagination) -> Self

Enable offset-into-variable pagination (ShopifyQL and similar).

pub fn max_pages(self, max: usize) -> Self

Set the maximum number of pages to fetch.

pub fn with_batch_size(self, batch_size: usize) -> Self

Set the per-page record count for Source::stream_pages and the GraphQL first: cursor argument.

Pass 0 to opt out of batching — the page-size variable is omitted from the request so the upstream uses its own default page size, and the response is emitted as a single StreamPage.

pub fn validate(&self) -> Result<(), FaucetError>

Validate the config at load time so a bad config fails fast with a typed FaucetError::Config instead of surfacing deep in a run: rejects an out-of-range batch_size (> MAX_BATCH_SIZE) and an empty endpoint or query.

Trait Implementations

impl Clone for GraphqlStreamConfig

fn clone(&self) -> GraphqlStreamConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GraphqlStreamConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GraphqlStreamConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for GraphqlStreamConfig

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for GraphqlStreamConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.