Class: Redis::Commands::Search::NumericField

Inherits:
Field
  • Object
show all
Defined in:
lib/redis/commands/modules/search/field.rb

Overview

A NUMERIC field, indexing numeric values for range queries.

Instance Attribute Summary

Attributes inherited from Field

#alias_name, #name, #options, #query, #type

Instance Method Summary collapse

Methods inherited from Field

#to_args

Constructor Details

#initialize(name, query = nil, **options) ⇒ NumericField

Build a NUMERIC field.

Parameters:

  • name (String, Symbol) —

    the document attribute the field indexes

  • query (Query, nil) (defaults to: nil) —

    a query the field is bound to, enabling #gt, #lt, #between



144
145
146
 
# File 'lib/redis/commands/modules/search/field.rb', line 144

def initialize(name, query = nil, **options)
  super(name, :numeric, query, **options)
end

Instance Method Details

#between(min, max) ⇒ Query

Add an inclusive range predicate to the bound query.

Parameters:

  • min (Numeric) —

    the inclusive lower bound

  • max (Numeric) —

    the inclusive upper bound

Returns:

  • (Query) —

    the bound query with the predicate added

Raises:

  • (ArgumentError) —

    if min or max is not numeric



172
173
174
175
176
 
# File 'lib/redis/commands/modules/search/field.rb', line 172

def between(min, max)
  # Coerce to numeric so a value can't inject range/query syntax. RangePredicate renders
  # bounds verbatim, so the field boundary is where untrusted input must be validated.
  query.add_predicate(RangePredicate.new(@alias_name || name, Float(min), Float(max)))
end

#gt(value) ⇒ Query

Add a greater-than range predicate to the bound query.

Parameters:

  • value (Numeric) —

    the exclusive lower bound

Returns:

  • (Query) —

    the bound query with the predicate added

Raises:

  • (ArgumentError) —

    if value is not numeric



153
154
155
 
# File 'lib/redis/commands/modules/search/field.rb', line 153

def gt(value)
  query.add_predicate(RangePredicate.new(@alias_name || name, "(#{Float(value)}", "+inf"))
end

#lt(value) ⇒ Query

Add a less-than range predicate to the bound query.

Parameters:

  • value (Numeric) —

    the exclusive upper bound

Returns:

  • (Query) —

    the bound query with the predicate added

Raises:

  • (ArgumentError) —

    if value is not numeric



162
163
164
 
# File 'lib/redis/commands/modules/search/field.rb', line 162

def lt(value)
  query.add_predicate(RangePredicate.new(@alias_name || name, "-inf", "(#{Float(value)}"))
end