Struct SnowflakeSourceConfig 

pub struct SnowflakeSourceConfig {
    pub account: String,
    pub warehouse: String,
    pub database: String,
    pub schema: String,
    pub role: Option<String>,
    pub auth: AuthSpec<SnowflakeAuth>,
    pub query: String,
    pub params: Vec<Value>,
    pub statement_timeout: Duration,
    pub poll_timeout: Duration,
    pub batch_size: usize,
}

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

Configuration for the Snowflake query source.

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.

role: Option<String>

Optional role to assume for the session.

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.

query: String

SQL statement to execute. May contain ${field.path} placeholders that are resolved against the parent-record context at runtime; resolved values are sent as positional bind parameters appended after params.

params: Vec<Value>

Positional bind parameters for the query, applied in order before any context-derived values. Snowflake’s SQL REST API uses 1-based positional binds in the JSON request body (see the bindings field in the SQL API docs).

statement_timeout: Duration

Per-statement server-side timeout. Defaults to 60 seconds. Passed through as the timeout field on the POST /api/v2/statements request body. The HTTP-level timeout for each individual request is configured separately by the source via the underlying reqwest client defaults.

poll_timeout: Duration

Maximum wall-clock time the source will spend polling an asynchronous statement (one for which the initial POST /api/v2/statements returns HTTP 202) before giving up with FaucetError::Source. Without this cap a statement that never finishes would loop forever. Defaults to 300 seconds. Set to 0 to disable the cap and poll indefinitely.

batch_size: usize

Records per emitted StreamPage.

Snowflake’s SQL REST API splits large result sets into partitions (one chunk of rows per HTTP response). The source re-frames partitions into batch_size-sized pages: rows accumulate in a buffer and are yielded as soon as the buffer reaches batch_size. 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 (e.g. SQL COPY, BigQuery load jobs) that prefer one large request to many small ones.

Implementations

impl SnowflakeSourceConfig

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

Create a new config with required fields and sensible defaults.

pub fn with_role(self, role: impl Into<String>) -> SnowflakeSourceConfig

Set the session role.

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

Set positional bind parameters for the query.

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

Set the per-statement server-side timeout.

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

Set the maximum wall-clock time spent polling an asynchronous statement before giving up. Pass Duration::ZERO to poll forever.

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

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 SnowflakeSourceConfig

fn clone(&self) -> SnowflakeSourceConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SnowflakeSourceConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SnowflakeSourceConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for SnowflakeSourceConfig

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 SnowflakeSourceConfig

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.