Class: Redis::Commands::Search::Predicate

Inherits:

Object

• Object
• Redis::Commands::Search::Predicate

Defined in:

lib/redis/commands/modules/search/query.rb

Overview

Abstract base for a single query-string predicate. Subclasses render themselves into a query-string fragment via #to_s.

Direct Known Subclasses

RangePredicate, TagEqualityPredicate, TextMatchPredicate

Constant Summary

TEXT_SPECIAL_CHARACTERS =

RediSearch query operators/metacharacters. Escaped with a backslash so an interpolated value is matched literally instead of altering (or breaking) the query.

[
  ',', '.', '<', '>', '{', '}', '[', ']', '"', "'", ':', ';', '!', '@',
  '#', '$', '%', '^', '&', '*', '(', ')', '-', '+', '=', '~', '|', '/', '\\'
].freeze

TAG_SPECIAL_CHARACTERS =

TAG values are single literal tokens, so whitespace is significant and must be escaped too. TEXT queries keep spaces, which separate terms (a multi-word match is an AND).

(TEXT_SPECIAL_CHARACTERS + [' ']).freeze

TEXT_ESCAPE_PATTERN =

Regexp.union(TEXT_SPECIAL_CHARACTERS)

TAG_ESCAPE_PATTERN =

Regexp.union(TAG_SPECIAL_CHARACTERS)

Instance Attribute Summary

• #field ⇒ String readonly

  The field the predicate applies to.

Instance Method Summary

• #initialize(field) ⇒ Predicate constructor

  A new instance of Predicate.

• #to_s ⇒ String

  The query-string fragment.

Constructor Details

#initialize(field) ⇒ Predicate

Returns a new instance of Predicate.

Parameters:

• field (String) —

  the field name

# File 'lib/redis/commands/modules/search/query.rb', line 630

def initialize(field)
  @field = field
end

Instance Attribute Details

#field ⇒ String (readonly)

Returns the field the predicate applies to.

Returns:

• (String) —

  the field the predicate applies to

# File 'lib/redis/commands/modules/search/query.rb', line 615

def field
  @field
end

Instance Method Details

#to_s ⇒ String

Returns the query-string fragment.

Returns:

• (String) —

  the query-string fragment

Raises:

• (NotImplementedError) —

  always; subclasses must override

# File 'lib/redis/commands/modules/search/query.rb', line 636

def to_s
  raise NotImplementedError
end