Struct BigQuerySourceConfig 

pub struct BigQuerySourceConfig {
    pub project_id: String,
    pub auth: BigQueryCredentials,
    pub query: String,
    pub use_legacy_sql: bool,
    pub location: Option<String>,
    pub max_results_per_page: i32,
    pub params: Vec<Value>,
    pub statement_timeout: Duration,
    pub poll_timeout: Duration,
    pub batch_size: usize,
}

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

Configuration for the BigQuery query source.

Fields

project_id: String

GCP project ID against which the query is billed and run.

auth: BigQueryCredentials

Authentication — the auth field, consistent with every other connector.

query: String

SQL statement to execute. May contain ${field.path} placeholders that are resolved against the parent-record context at runtime as positional ? markers; matched values are appended to params when the query is sent.

use_legacy_sql: bool

Whether to use BigQuery’s legacy SQL dialect. Defaults to false (Standard SQL). Set to true only for tables that use legacy [project:dataset.table] references.

location: Option<String>

Optional location override for non-US jobs ("EU", "asia-east1"). When None, BigQuery uses the default location for the queried tables.

max_results_per_page: i32

Maximum rows per page when calling jobs.getQueryResults. Smaller values trade more HTTP round-trips for lower memory; larger values trade memory for fewer requests. Defaults to 1000.

params: Vec<Value>

Positional bind parameters for the query, sent as POSITIONAL query parameters in declaration order before any context-derived values. Each value is shipped as a STRING parameter; BigQuery casts as needed at execution time.

statement_timeout: Duration

Per-statement server-side timeout. Forwarded to the timeoutMs field on jobs.query. Defaults to 60 seconds. If BigQuery does not finish the query within this window it responds with jobComplete=false; the source then polls jobs.getQueryResults until the job completes.

poll_timeout: Duration

Maximum wall-clock time the source will spend polling jobs.getQueryResults for a job that keeps reporting jobComplete=false, before giving up with FaucetError::Source. Without this cap a job that never completes would loop forever. Defaults to 300 seconds. Set to 0 to disable the cap and poll indefinitely. Only the completion wait is bounded; once the job is complete, ordinary pageToken paging is unaffected.

batch_size: usize

Records per emitted StreamPage. Rows returned by BigQuery are re-framed into pages of this size — every time the buffer reaches batch_size, a page is yielded. Defaults to DEFAULT_BATCH_SIZE.

batch_size = 0 is the “no batching” sentinel: the entire result set is buffered and emitted in a single page. Useful for small lookup tables, or for sinks that prefer one large request to many small ones.

Implementations

impl BigQuerySourceConfig

pub fn new( project_id: impl Into<String>, credentials: BigQueryCredentials, query: impl Into<String>, ) -> BigQuerySourceConfig

Create a new config with required fields and sensible defaults.

pub fn with_use_legacy_sql(self, use_legacy: bool) -> BigQuerySourceConfig

Enable BigQuery’s legacy SQL dialect.

pub fn with_location(self, location: impl Into<String>) -> BigQuerySourceConfig

Pin the job to a specific location (e.g. "EU").

pub fn with_max_results_per_page(self, max_results: i32) -> BigQuerySourceConfig

Set the maximum row count per getQueryResults page.

pub fn with_params(self, params: Vec<Value>) -> BigQuerySourceConfig

Set the positional bind parameters for the query.

pub fn with_statement_timeout(self, timeout: Duration) -> BigQuerySourceConfig

Set the per-statement server-side timeout.

pub fn with_poll_timeout(self, timeout: Duration) -> BigQuerySourceConfig

Set the maximum wall-clock time spent polling for job completion before giving up. Pass Duration::ZERO to poll forever.

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

Set the records-per-page hint for Source::stream_pages.

Pass 0 to opt out of batching — the entire result set is emitted in a single page.

Trait Implementations

impl Clone for BigQuerySourceConfig

fn clone(&self) -> BigQuerySourceConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BigQuerySourceConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BigQuerySourceConfig

fn deserialize<__D>( __deserializer: __D, ) -> Result<BigQuerySourceConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for BigQuerySourceConfig

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 BigQuerySourceConfig

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.