Struct StreamSchema 

pub struct StreamSchema {
    pub include_key: bool,
    pub key_column_name: String,
    pub include_id: bool,
    pub id_column_name: String,
    pub include_timestamp: bool,
    pub timestamp_column_name: String,
    pub include_sequence: bool,
    pub sequence_column_name: String,
    pub fields: Vec<String>,
    pub include_row_index: bool,
    pub row_index_column_name: String,
}

Schema configuration for Redis Stream scanning.

Defines output columns when scanning Redis Streams. Each stream entry becomes a row in the output DataFrame.

Example

use polars_redis::StreamSchema;

let schema = StreamSchema::new(vec![
    "user_id".to_string(),
    "action".to_string(),
    "payload".to_string(),
])
.with_key(true)
.with_id(true)
.with_timestamp(true);

Output Schema

• _key (optional): The Redis stream key
• _id (optional): The entry ID (e.g., “1234567890123-0”)
• _timestamp (optional): Timestamp extracted from entry ID (Int64 ms)
• _sequence (optional): Sequence number from entry ID
• User-defined fields extracted from entry data
• _index (optional): Global row number

Fields

include_key: bool

Whether to include the Redis key as a column.

key_column_name: String

Name of the key column.

include_id: bool

Whether to include the entry ID as a column.

id_column_name: String

Name of the entry ID column.

include_timestamp: bool

Whether to include the timestamp as a column.

timestamp_column_name: String

Name of the timestamp column.

include_sequence: bool

Whether to include the sequence number as a column.

sequence_column_name: String

Name of the sequence column.

fields: Vec<String>

Field names to extract from entries.

include_row_index: bool

Whether to include a global row index column.

row_index_column_name: String

Name of the row index column.

Implementations

impl StreamSchema

pub fn new() -> Self

Create a new StreamSchema with default settings.

pub fn with_fields(fields: Vec<String>) -> Self

Create a new StreamSchema with the specified fields.

pub fn with_key(self, include: bool) -> Self

Set whether to include the key column.

pub fn with_key_column_name(self, name: &str) -> Self

Set the key column name.

pub fn with_id(self, include: bool) -> Self

Set whether to include the entry ID column.

pub fn with_id_column_name(self, name: &str) -> Self

Set the entry ID column name.

pub fn with_timestamp(self, include: bool) -> Self

Set whether to include the timestamp column.

pub fn with_timestamp_column_name(self, name: &str) -> Self

Set the timestamp column name.

pub fn with_sequence(self, include: bool) -> Self

Set whether to include the sequence column.

pub fn with_sequence_column_name(self, name: &str) -> Self

Set the sequence column name.

pub fn add_field(self, name: &str) -> Self

Add a field to extract from entries.

pub fn set_fields(self, fields: Vec<String>) -> Self

Set the fields to extract from entries.

pub fn with_row_index(self, include: bool) -> Self

Set whether to include a global row index column.

pub fn with_row_index_column_name(self, name: &str) -> Self

Set the row index column name.

pub fn to_arrow_schema(&self) -> Schema

Build the Arrow schema for this configuration.

Trait Implementations

impl Clone for StreamSchema

fn clone(&self) -> StreamSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamSchema

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

Formats the value using the given formatter.

impl Default for StreamSchema

fn default() -> Self

Returns the “default value” for a type.