Struct BigQuerySinkConfig 

pub struct BigQuerySinkConfig {
    pub project_id: String,
    pub dataset_id: String,
    pub table_id: String,
    pub auth: BigQueryCredentials,
    pub batch_size: usize,
    pub insert_id_field: Option<String>,
}

Available on crate feature sink-bigquery only.

Configuration for the BigQuery streaming insert sink.

Fields

project_id: String

GCP project ID.

dataset_id: String

BigQuery dataset ID.

table_id: String

BigQuery table ID.

auth: BigQueryCredentials

Authentication credentials. YAML/JSON key is auth for consistency with every other connector’s auth block.

batch_size: usize

Maximum rows per tabledata.insertAll request. Defaults to DEFAULT_BATCH_SIZE.

When the upstream StreamPage carries more records than batch_size, the sink slices the page into batch_size-row chunks and issues one insertAll HTTP call per chunk. When batch_size = 0, the page is sent as a single request — useful when the source already chunks to BigQuery’s preferred size (e.g. ~500 rows for streaming inserts).

batch_size = 0 is the “no batching” sentinel: the entire upstream page is forwarded in one insertAll call, subject to BigQuery’s natural per-request limits (~10MB body, ~500 rows recommended). Larger pages may exceed those limits — keep the default unless the upstream StreamPage size is already tuned for BigQuery.

insert_id_field: Option<String>

Optional record field whose value is sent as the BigQuery streaming insertId for each row. BigQuery uses insertId for best-effort de-duplication over a short window, so a stable per-row key here makes streaming inserts resilient to transport retries (which are otherwise at-least-once and can produce duplicate rows) (#78/#31). When None (the default) no insertId is sent. A row missing the field is inserted without an insertId (no dedup for that row).

Implementations

impl BigQuerySinkConfig

pub fn new( project_id: impl Into<String>, dataset_id: impl Into<String>, table_id: impl Into<String>, credentials: BigQueryCredentials, ) -> BigQuerySinkConfig

Create a new config with the required fields and sensible defaults.

pub fn with_insert_id_field( self, field: impl Into<String>, ) -> BigQuerySinkConfig

Set the record field used as the per-row BigQuery streaming insertId for best-effort de-duplication on retry.

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

Set the per-request row count for tabledata.insertAll.

Pass 0 to opt out of re-chunking — the sink forwards each upstream StreamPage as a single insertAll call. BigQuery’s streaming-insert sweet spot is ~500 rows per request.

Trait Implementations

impl Clone for BigQuerySinkConfig

fn clone(&self) -> BigQuerySinkConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BigQuerySinkConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BigQuerySinkConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for BigQuerySinkConfig

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 BigQuerySinkConfig

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.