Struct SpannerSourceConfig 

pub struct SpannerSourceConfig {
    pub connection: SpannerConnection,
    pub query: String,
    pub params: HashMap<String, Value>,
    pub batch_size: usize,
    pub exact_staleness_secs: Option<u64>,
    pub replication: SpannerReplication,
    pub state_key: Option<String>,
    pub shard: Option<ShardConfig>,
}

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

Configuration for SpannerSource.

Fields

connection: SpannerConnection

Connection settings (project_id / instance / database / auth / max_sessions / emulator_host), flattened.

query: String

GoogleSQL query to run. Use named parameters (@name) for params, and the named parameter @bookmark to bind the incremental cursor server-side.

params: HashMap<String, Value>

Named bind parameters for the query. Values must be scalars (string, integer, float, or boolean) — Spanner parameters are typed, and null/array/object values have no unambiguous parameter type.

batch_size: usize

Records per emitted StreamPage. 0 emits the whole result set as a single page. Defaults to DEFAULT_BATCH_SIZE.

exact_staleness_secs: Option<u64>

Read at a timestamp this many seconds in the past instead of a strong read. Stale reads can be served by any replica, offloading the leader — at the cost of missing rows committed within the staleness window.

replication: SpannerReplication

Replication mode. Defaults to SpannerReplication::Full.

state_key: Option<String>

Explicit state-store key for the bookmark. When unset, a key is derived from the database path and a query fingerprint.

shard: Option<ShardConfig>

Optional primary-key range sharding for clustered (Mode B) execution.

When set, the source advertises itself as shardable: the cluster coordinator splits the query’s key range into contiguous slices that different workers process concurrently. Has no effect outside the cluster coordinator (a plain faucet run streams the whole query).

Implementations

impl SpannerSourceConfig

pub fn new( project_id: impl Into<String>, instance: impl Into<String>, database: impl Into<String>, query: impl Into<String>, ) -> SpannerSourceConfig

Build a config from connection identifiers and a query, with defaults elsewhere.

pub fn validate(&self) -> Result<(), FaucetError>

Validate connection, batch size, params, and replication settings.

Trait Implementations

impl Clone for SpannerSourceConfig

fn clone(&self) -> SpannerSourceConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpannerSourceConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SpannerSourceConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for SpannerSourceConfig

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 SpannerSourceConfig

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.