Struct RedisSourceConfig 

pub struct RedisSourceConfig {
    pub url: String,
    pub source_type: RedisSourceType,
    pub max_records: Option<usize>,
    pub batch_size: usize,
}

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

Configuration for the Redis source connector.

Fields

url: String

Redis connection URL (e.g. "redis://127.0.0.1:6379").

source_type: RedisSourceType

The type of Redis data structure to read from.

max_records: Option<usize>

Optional maximum number of records to return.

batch_size: usize

Records per emitted StreamPage. Each mode maps the knob onto its native paging primitive:

• Keys: SCAN COUNT batch_size hint, followed by an MGET batched to batch_size records per page.
• Stream: XRANGE - + COUNT batch_size, advancing the start ID per page.
• List: LRANGE start stop, sliding the window by batch_size.

Defaults to DEFAULT_BATCH_SIZE.

batch_size = 0 is the “no batching” sentinel: every mode drains its underlying primitive in a single round-trip (or, for Keys, the minimum number of round-trips the SCAN cursor needs) and emits the entire result set as a single page. Useful for small lookup tables or for sinks like SQL COPY / BigQuery load jobs that prefer one large request to many small ones.

Implementations

impl RedisSourceConfig

pub fn new( url: impl Into<String>, source_type: RedisSourceType, ) -> RedisSourceConfig

Create a new config with the given URL and source type.

pub fn max_records(self, max: usize) -> RedisSourceConfig

Set the maximum number of records to return.

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

Set the per-page record count for Source::stream_pages.

Pass 0 to opt out of batching — the entire result set is emitted in a single StreamPage.

Trait Implementations

impl Clone for RedisSourceConfig

fn clone(&self) -> RedisSourceConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RedisSourceConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RedisSourceConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for RedisSourceConfig

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 RedisSourceConfig

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.