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<GraphqlPagination>,
    pub max_pages: Option<usize>,
    pub batch_size: usize,
}

Available on crate features source-graphql and source-rest only.

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<GraphqlPagination>

Pagination configuration. None for single-page queries.

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.

Implementations

impl GraphqlStreamConfig

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

Create a new config with an endpoint and query.

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

Set the GraphQL variables.

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

Set the authentication method.

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

Set additional headers.

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

Set the JSONPath expression for record extraction.

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

Enable cursor-based pagination with the given configuration.

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

Set the maximum number of pages to fetch.

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

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.

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<(), Error>

Formats the value using the given formatter.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<GraphqlStreamConfig, <__D as Deserializer<'de>>::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 as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.