Struct HashSchema 

pub struct HashSchema { /* private fields */ }

Schema for a Redis hash, mapping field names to types.

Defines how Redis hash fields should be converted to Arrow/Polars columns. Each field is mapped to a RedisType which determines parsing behavior.

Example

use polars_redis::{HashSchema, RedisType};

let schema = HashSchema::new(vec![
    ("name".to_string(), RedisType::Utf8),
    ("age".to_string(), RedisType::Int64),
    ("score".to_string(), RedisType::Float64),
    ("active".to_string(), RedisType::Boolean),
])
.with_key(true)
.with_key_column_name("_key")
.with_ttl(true);

Optional Metadata Columns

• Key column: Include the Redis key as a column (default: true, name: “_key”)
• TTL column: Include the key’s TTL in seconds (default: false, name: “_ttl”)
• Row index: Include a row number column (default: false, name: “_index”)

Implementations

impl HashSchema

pub fn new(field_types: Vec<(String, RedisType)>) -> Self

Create a new HashSchema from a list of (field_name, type) pairs.

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_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 with_row_index(self, include: bool) -> Self

Set whether to include the row index as a column.

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

Set the name of the row index column.

pub fn fields(&self) -> &[String]

Get the ordered field names.

pub fn field_type(&self, name: &str) -> Option<RedisType>

Get the type for a field.

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 include_ttl(&self) -> bool

Whether the TTL column is included.

pub fn ttl_column_name(&self) -> &str

Get the TTL column name.

pub fn include_row_index(&self) -> bool

Whether the row index column is included.

pub fn row_index_column_name(&self) -> &str

Get the row index column name.

pub fn to_arrow_schema(&self) -> Schema

Convert to Arrow Schema.

pub fn project(&self, columns: &[String]) -> Self

Get a subset schema with only the specified columns (for projection pushdown).

Trait Implementations

impl Clone for HashSchema

fn clone(&self) -> HashSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HashSchema

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

Formats the value using the given formatter.

impl Default for HashSchema

fn default() -> Self

Returns the “default value” for a type.