Struct SnowflakeSinkConfig 

pub struct SnowflakeSinkConfig {
    pub account: String,
    pub warehouse: String,
    pub database: String,
    pub schema: String,
    pub table: String,
    pub auth: AuthSpec<SnowflakeAuth>,
    pub batch_size: usize,
    pub poll_timeout: Duration,
}

Available on crate feature sink-snowflake only.

Configuration for the Snowflake sink.

Fields

account: String

Snowflake account identifier (e.g. "xy12345.us-east-1").

warehouse: String

Warehouse to use for the session.

database: String

Database name.

schema: String

Schema name.

table: String

Target table name.

auth: AuthSpec<SnowflakeAuth>

Authentication: either inline ({ type, config }) or a { ref: <name> } pointer to a shared provider in the CLI’s top-level auth: catalog. A shared provider must yield a Bearer or Token credential, which maps onto SnowflakeAuth::OAuth; key-pair JWT is always inline.

batch_size: usize

Maximum number of records sent per Snowflake SQL REST API request. Defaults to DEFAULT_BATCH_SIZE (1000), which matches the documented sweet spot for the SQL REST API.

When write_batch is handed a slice larger than batch_size, the sink re-chunks it into batch_size slices and issues one INSERT per chunk. batch_size = 0 is the “no batching” sentinel — the records slice is forwarded as a single INSERT, no matter how large, so upstream StreamPage framing flows through untouched.

poll_timeout: Duration

Maximum wall-clock time to wait for an asynchronously-executed INSERT to finish. Snowflake’s SQL REST API answers an accepted but not-yet-finished statement with HTTP 202 and a statementHandle; the sink polls GET /api/v2/statements/{handle} until the statement reports success before counting the rows as written. Without this the sink would report success the moment Snowflake accepted the statement, losing durability. Defaults to 300 seconds. Set to 0 to poll indefinitely.

Implementations

impl SnowflakeSinkConfig

pub fn new( account: impl Into<String>, warehouse: impl Into<String>, database: impl Into<String>, schema: impl Into<String>, table: impl Into<String>, auth: SnowflakeAuth, ) -> SnowflakeSinkConfig

Create a new config with required fields and sensible defaults.

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

Set the maximum wall-clock time spent polling an asynchronously executed INSERT for completion. Pass Duration::ZERO to poll forever.

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

Set the maximum number of records per Snowflake SQL REST API request.

Pass 0 to opt out of re-chunking — the entire records slice handed to write_batch is sent in a single INSERT request, preserving upstream StreamPage framing.

Trait Implementations

impl Clone for SnowflakeSinkConfig

fn clone(&self) -> SnowflakeSinkConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SnowflakeSinkConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SnowflakeSinkConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for SnowflakeSinkConfig

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 SnowflakeSinkConfig

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.