Struct MssqlCdcSourceConfig 

pub struct MssqlCdcSourceConfig {
    pub connection: MssqlConnectionConfig,
    pub capture_instances: Vec<String>,
    pub start_position: StartPosition,
    pub poll_interval: Duration,
    pub idle_timeout: Duration,
    pub max_staged_records: Option<usize>,
    pub batch_size: usize,
    pub max_connections: u32,
    pub statement_timeout_secs: u64,
    pub state_key: Option<String>,
}

Available on crate features source-mssql-cdc and source-rest only.

Configuration for the Microsoft SQL Server CDC source.

The source polls native SQL Server change data capture: sys.fn_cdc_get_max_lsn() for the high-water LSN, then cdc.fn_cdc_get_all_changes_<capture_instance>() per configured capture instance, advancing a durable per-instance LSN bookmark.

Fields

connection: MssqlConnectionConfig

Connection + TLS settings (connection_url or connection_string).

capture_instances: Vec<String>

Capture instances to poll (e.g. dbo_Orders). Required and non-empty.

A capture instance is created by sys.sp_cdc_enable_table and defaults to <schema>_<table>. Names are used verbatim to build the cdc.fn_cdc_get_all_changes_<name> table-valued function call, so v1 only accepts the SQL Server identifier characters [A-Za-z0-9_] (validated at load time) to prevent injection into the function name.

start_position: StartPosition

Start position on a fresh run (ignored once a bookmark exists). Default current (skip existing history).

poll_interval: Duration

Seconds to wait between empty polls (no new changes). Default 1s.

idle_timeout: Duration

Terminator: end the fetch cycle after this much continuous quiet (no change rows across any capture instance). Default 30s. A long-running runtime (faucet schedule / faucet serve) re-invokes the source to keep tailing.

max_staged_records: Option<usize>

Max records buffered for a single in-progress transaction before the run aborts with a typed error (rather than risking unbounded memory growth). None = unbounded.

batch_size: usize

Advisory per-page record count. 0 accumulates every change into a single trailing page (snapshot/test convenience). Default DEFAULT_BATCH_SIZE.

max_connections: u32

Maximum pooled connections. Defaults to 5.

statement_timeout_secs: u64

Per-query timeout in seconds (0 disables). Defaults to 300.

state_key: Option<String>

Explicit state-store key for the LSN bookmark. When unset, a key is derived from the database (or host) and the sorted capture-instance list.

Implementations

impl MssqlCdcSourceConfig

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

Validate fail-fast invariants. Called from MssqlCdcSource::new.

pub fn resolved_state_key(&self) -> String

The state-store key for this source’s LSN bookmark map. Uses the explicit state_key override when set, otherwise a derived, stable key.

Trait Implementations

impl Clone for MssqlCdcSourceConfig

fn clone(&self) -> MssqlCdcSourceConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MssqlCdcSourceConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MssqlCdcSourceConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for MssqlCdcSourceConfig

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 MssqlCdcSourceConfig

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.