Struct HashScanOptions 

pub struct HashScanOptions {
    pub scan: ScanOptions,
    pub include_key: bool,
    pub key_column_name: Option<String>,
    pub include_ttl: bool,
    pub ttl_column_name: Option<String>,
    pub row_index: Option<RowIndex>,
    pub projection: Option<Vec<String>>,
}

Options for scanning Redis hashes.

Example

use polars_redis::options::HashScanOptions;

let opts = HashScanOptions::new("user:*")
    .with_batch_size(500)
    .with_ttl(true)
    .with_projection(vec!["name", "email"]);

Fields

scan: ScanOptions

Base scan options.

include_key: bool

Whether to include the key column.

key_column_name: Option<String>

Custom name for the key column.

include_ttl: bool

Whether to include TTL.

ttl_column_name: Option<String>

Custom name for the TTL column.

row_index: Option<RowIndex>

Row index configuration.

projection: Option<Vec<String>>

Fields to fetch (None = all via HGETALL).

Implementations

impl HashScanOptions

pub fn new(pattern: impl Into<String>) -> Self

Create new HashScanOptions with the given pattern.

pub fn with_batch_size(self, size: usize) -> Self

Set the batch size.

pub fn with_count_hint(self, count: usize) -> Self

Set the COUNT hint for SCAN.

pub fn with_n_rows(self, n: usize) -> Self

Set the maximum number of rows to return.

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

Enable or disable the key column.

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

Set a custom name for the key column.

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

Enable or disable the TTL column.

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

Set a custom name for the TTL column.

pub fn with_row_index(self, name: impl Into<String>, offset: u64) -> Self

Set the row index configuration.

pub fn with_projection(self, fields: Vec<impl Into<String>>) -> Self

Set the fields to fetch (projection).

Trait Implementations

impl Clone for HashScanOptions

fn clone(&self) -> HashScanOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HashScanOptions

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

Formats the value using the given formatter.

impl Default for HashScanOptions

fn default() -> Self

Returns the “default value” for a type.