Struct StringSchema 

pub struct StringSchema { /* private fields */ }

Schema for Redis string values, defining how to parse and convert them.

Redis strings are simple key-value pairs. This schema defines what type the values should be parsed as (e.g., Int64 for counters, Utf8 for text).

Example

use polars_redis::StringSchema;
use arrow::datatypes::DataType;

// For string counters
let schema = StringSchema::new(DataType::Int64)
    .with_key(true)
    .with_value_column_name("count");

// For text values
let schema = StringSchema::new(DataType::Utf8)
    .with_key(true);

Output Schema

• _key (optional): The Redis key
• value: The parsed value (type depends on schema)
• _ttl (optional): TTL in seconds

Implementations

impl StringSchema

pub fn new(value_type: DataType) -> Self

Create a new StringSchema with the given value type.

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

Set whether to include the Redis key as a column.

pub fn with_key_column_name(self, name: impl Into<String>) -> Self

Set the name of the key column.

pub fn with_value_column_name(self, name: impl Into<String>) -> Self

Set the name of the value column.

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

Set whether to include the TTL as a column.

pub fn with_ttl_column_name(self, name: impl Into<String>) -> Self

Set the name of the TTL column.

pub fn value_type(&self) -> &DataType

Get the value type.

pub fn include_key(&self) -> bool

Whether the key column is included.

pub fn key_column_name(&self) -> &str

Get the key column name.

pub fn value_column_name(&self) -> &str

Get the value column name.

pub fn include_ttl(&self) -> bool

Whether the TTL column is included.

pub fn ttl_column_name(&self) -> &str

Get the TTL column name.

pub fn to_arrow_schema(&self) -> Schema

Convert to Arrow Schema.

Trait Implementations

impl Clone for StringSchema

fn clone(&self) -> StringSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StringSchema

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

Formats the value using the given formatter.

impl Default for StringSchema

fn default() -> Self

Returns the “default value” for a type.