Class: Groonga::Command::LogicalRangeFilter

Inherits:
Base
  • Object
show all
Includes:
Searchable
Defined in:
lib/groonga/command/logical-range-filter.rb

Overview

A command class that represents logical_range_filter command.

Since:

  • 1.1.1

Instance Attribute Summary

Attributes inherited from Base

#arguments, #command_name, #original_format, #original_source, #path_prefix

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Searchable

#conditions

Methods inherited from Base

#==, #[], #[]=, #command_format?, #initialize, #key?, #name, #output_type, #request_id, #to_command_format, #to_elasticsearch_format, #to_s, #to_uri_format, #uri_format?

Constructor Details

This class inherits a constructor from Groonga::Command::Base

Class Method Details

.command_name ⇒ Object

Since:

  • 1.1.1



31
32
33
 
# File 'lib/groonga/command/logical-range-filter.rb', line 31

def command_name
  "logical_range_filter"
end

.parameter_names ⇒ Object

Since:

  • 1.1.1



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/groonga/command/logical-range-filter.rb', line 35

def parameter_names
  [
    :logical_table,
    :shard_key,
    :min,
    :min_border,
    :max,
    :max_border,
    :order,
    :offset,
    :limit,
    :filter,
    :output_columns,
    :use_range_index,
    :post_filter,
    :sort_keys,
  ]
end

Instance Method Details

#filter ⇒ String

Returns filter parameter value.

Returns:

  • (String) —

    filter parameter value.

Since:

  • 1.1.1



127
128
129
 
# File 'lib/groonga/command/logical-range-filter.rb', line 127

def filter
  self[:filter]
end

#limit ⇒ Integer

Returns limit parameter value.

Returns:

  • (Integer) —

    limit parameter value.

Since:

  • 1.1.1



118
119
120
121
122
 
# File 'lib/groonga/command/logical-range-filter.rb', line 118

def limit
  value = self[:limit]
  value = value.to_i unless value.nil?
  value
end

#logical_table ⇒ String

Returns logical_table parameter value.

Returns:

  • (String) —

    logical_table parameter value.

Since:

  • 1.1.1



60
61
62
 
# File 'lib/groonga/command/logical-range-filter.rb', line 60

def logical_table
  self[:logical_table]
end

#max ⇒ String

Returns max parameter value.

Returns:

  • (String) —

    max parameter value.

Since:

  • 1.1.1



88
89
90
 
# File 'lib/groonga/command/logical-range-filter.rb', line 88

def max
  self[:max]
end

#max_border ⇒ String

Returns max_border parameter value.

Returns:

  • (String) —

    max_border parameter value.

Since:

  • 1.1.1



95
96
97
 
# File 'lib/groonga/command/logical-range-filter.rb', line 95

def max_border
  self[:max_border]
end

#min ⇒ String

Returns min parameter value.

Returns:

  • (String) —

    min parameter value.

Since:

  • 1.1.1



74
75
76
 
# File 'lib/groonga/command/logical-range-filter.rb', line 74

def min
  self[:min]
end

#min_border ⇒ String

Returns min_border parameter value.

Returns:

  • (String) —

    min_border parameter value.

Since:

  • 1.1.1



81
82
83
 
# File 'lib/groonga/command/logical-range-filter.rb', line 81

def min_border
  self[:min_border]
end

#offset ⇒ Integer

Returns offset parameter value.

Returns:

  • (Integer) —

    offset parameter value.

Since:

  • 1.1.1



109
110
111
112
113
 
# File 'lib/groonga/command/logical-range-filter.rb', line 109

def offset
  value = self[:offset]
  value = value.to_i unless value.nil?
  value
end

#order ⇒ String

Returns order parameter value.

Returns:

  • (String) —

    order parameter value.

Since:

  • 1.1.1



102
103
104
 
# File 'lib/groonga/command/logical-range-filter.rb', line 102

def order
  self[:order]
end

#output_columns ⇒ String

Returns output_columns parameter value.

Returns:

  • (String) —

    output_columns parameter value.

Since:

  • 1.1.1



134
135
136
 
# File 'lib/groonga/command/logical-range-filter.rb', line 134

def output_columns
  self[:output_columns]
end

#post_filter ⇒ String

Returns post_filter parameter value.

Returns:

  • (String) —

    post_filter parameter value.

Since:

  • 1.4.3



151
152
153
 
# File 'lib/groonga/command/logical-range-filter.rb', line 151

def post_filter
  self[:post_filter]
end

#shard_key ⇒ String

Returns shard_key parameter value.

Returns:

  • (String) —

    shard_key parameter value.

Since:

  • 1.1.1



67
68
69
 
# File 'lib/groonga/command/logical-range-filter.rb', line 67

def shard_key
  self[:shard_key]
end

#sort_keys ⇒ ::Array<String>

Returns The sort keys.

Returns:

  • (::Array<String>) —

    The sort keys.

Since:

  • 1.4.3



158
159
160
 
# File 'lib/groonga/command/logical-range-filter.rb', line 158

def sort_keys
  parse_array_value(self[:sort_keys] || "")
end

#use_range_index ⇒ Boolean?

Returns Whether force to use or not use range index. nil means that decided whether use range index automatically.

Returns:

  • (Boolean, nil) —

    Whether force to use or not use range index. nil means that decided whether use range index automatically.

Since:

  • 1.4.3



142
143
144
145
146
 
# File 'lib/groonga/command/logical-range-filter.rb', line 142

def use_range_index
  boolean_value(:use_range_index,
                default: nil,
                invalid: nil)
end