Class: Groonga::Command::LogicalSelect

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

Overview

A command class that represents logical_select command.

Since:

  • 1.1.3

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.3



29
30
31
 
# File 'lib/groonga/command/logical-select.rb', line 29

def command_name
  "logical_select"
end

.parameter_names ⇒ Object

Since:

  • 1.1.3



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/groonga/command/logical-select.rb', line 33

def parameter_names
  [
    :logical_table,
    :shard_key,
    :min,
    :min_border,
    :max,
    :max_border,
    :filter,
    :sortby,
    :output_columns,
    :offset,
    :limit,
    :drilldown,
    :drilldown_sortby,
    :drilldown_output_columns,
    :drilldown_offset,
    :drilldown_limit,
    :drilldown_calc_types,
    :drilldown_calc_target,
    :sort_keys,
  ]
end

Instance Method Details

#drilldown ⇒ String

Returns drilldown parameter value.

Returns:

  • (String) —

    drilldown parameter value.

Since:

  • 1.1.3



140
141
142
 
# File 'lib/groonga/command/logical-select.rb', line 140

def drilldown
  self[:drilldown]
end

#drilldown_calc_target ⇒ String

Returns drilldown_calc_target parameter value.

Returns:

  • (String) —

    drilldown_calc_target parameter value.

Since:

  • 1.1.3



189
190
191
 
# File 'lib/groonga/command/logical-select.rb', line 189

def drilldown_calc_target
  self[:drilldown_calc_target]
end

#drilldown_calc_types ⇒ String

Returns drilldown_calc_types parameter value.

Returns:

  • (String) —

    drilldown_calc_types parameter value.

Since:

  • 1.1.3



182
183
184
 
# File 'lib/groonga/command/logical-select.rb', line 182

def drilldown_calc_types
  self[:drilldown_calc_types]
end

#drilldown_limit ⇒ String

Returns drilldown_limit parameter value.

Returns:

  • (String) —

    drilldown_limit parameter value.

Since:

  • 1.1.3



175
176
177
 
# File 'lib/groonga/command/logical-select.rb', line 175

def drilldown_limit
  integer_value(:drilldown_limit)
end

#drilldown_offset ⇒ String

Returns drilldown_offset parameter value.

Returns:

  • (String) —

    drilldown_offset parameter value.

Since:

  • 1.1.3



168
169
170
 
# File 'lib/groonga/command/logical-select.rb', line 168

def drilldown_offset
  integer_value(:drilldown_offset)
end

#drilldown_output_columns ⇒ String

Returns drilldown_output_columns parameter value.

Returns:

  • (String) —

    drilldown_output_columns parameter value.

Since:

  • 1.1.3



161
162
163
 
# File 'lib/groonga/command/logical-select.rb', line 161

def drilldown_output_columns
  self[:drilldown_output_columns]
end

#drilldown_sortby ⇒ String

Returns drilldown_sortby parameter value.

Returns:

  • (String) —

    drilldown_sortby parameter value.

Since:

  • 1.1.3



154
155
156
 
# File 'lib/groonga/command/logical-select.rb', line 154

def drilldown_sortby
  self[:drilldown_sortby]
end

#drilldowns ⇒ Array<String>

Returns drilldown keys.

Returns:

  • (Array<String>) —

    drilldown keys.

Since:

  • 1.1.3



147
148
149
 
# File 'lib/groonga/command/logical-select.rb', line 147

def drilldowns
  @drilldowns ||= array_value(:drilldown)
end

#filter ⇒ String

Returns filter parameter value.

Returns:

  • (String) —

    filter parameter value.

Since:

  • 1.1.3



105
106
107
 
# File 'lib/groonga/command/logical-select.rb', line 105

def filter
  self[:filter]
end

#limit ⇒ Integer

Returns limit parameter value.

Returns:

  • (Integer) —

    limit parameter value.

Since:

  • 1.1.3



133
134
135
 
# File 'lib/groonga/command/logical-select.rb', line 133

def limit
  integer_value(:limit)
end

#logical_table ⇒ String

Returns logical_table parameter value.

Returns:

  • (String) —

    logical_table parameter value.

Since:

  • 1.1.3



63
64
65
 
# File 'lib/groonga/command/logical-select.rb', line 63

def logical_table
  self[:logical_table]
end

#max ⇒ String

Returns max parameter value.

Returns:

  • (String) —

    max parameter value.

Since:

  • 1.1.3



91
92
93
 
# File 'lib/groonga/command/logical-select.rb', line 91

def max
  self[:max]
end

#max_border ⇒ String

Returns max_border parameter value.

Returns:

  • (String) —

    max_border parameter value.

Since:

  • 1.1.3



98
99
100
 
# File 'lib/groonga/command/logical-select.rb', line 98

def max_border
  self[:max_border]
end

#min ⇒ String

Returns min parameter value.

Returns:

  • (String) —

    min parameter value.

Since:

  • 1.1.3



77
78
79
 
# File 'lib/groonga/command/logical-select.rb', line 77

def min
  self[:min]
end

#min_border ⇒ String

Returns min_border parameter value.

Returns:

  • (String) —

    min_border parameter value.

Since:

  • 1.1.3



84
85
86
 
# File 'lib/groonga/command/logical-select.rb', line 84

def min_border
  self[:min_border]
end

#offset ⇒ Integer

Returns offset parameter value.

Returns:

  • (Integer) —

    offset parameter value.

Since:

  • 1.1.3



126
127
128
 
# File 'lib/groonga/command/logical-select.rb', line 126

def offset
  integer_value(:offset)
end

#output_columns ⇒ String

Returns output_columns parameter value.

Returns:

  • (String) —

    output_columns parameter value.

Since:

  • 1.1.3



119
120
121
 
# File 'lib/groonga/command/logical-select.rb', line 119

def output_columns
  self[:output_columns]
end

#shard_key ⇒ String

Returns shard_key parameter value.

Returns:

  • (String) —

    shard_key parameter value.

Since:

  • 1.1.3



70
71
72
 
# File 'lib/groonga/command/logical-select.rb', line 70

def shard_key
  self[:shard_key]
end

#sort_keys ⇒ ::Array<String>

Returns The sort keys.

Returns:

  • (::Array<String>) —

    The sort keys.

Since:

  • 1.4.2



196
197
198
 
# File 'lib/groonga/command/logical-select.rb', line 196

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

#sortby ⇒ String

Returns sortby parameter value.

Returns:

  • (String) —

    sortby parameter value.

Since:

  • 1.1.3



112
113
114
 
# File 'lib/groonga/command/logical-select.rb', line 112

def sortby
  self[:sortby]
end