Module: Groonga::Command::Drilldownable

Included in:
LogicalSelect, Select
Defined in:
lib/groonga/command/drilldownable.rb

Defined Under Namespace

Classes: Drilldown

Instance Method Summary collapse

Instance Method Details

#drilldown ⇒ String

Returns drilldown parameter value.

Returns:

  • (String) —

    drilldown parameter value.

Since:

  • 1.1.3



23
24
25
 
# File 'lib/groonga/command/drilldownable.rb', line 23

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



86
87
88
 
# File 'lib/groonga/command/drilldownable.rb', line 86

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



79
80
81
 
# File 'lib/groonga/command/drilldownable.rb', line 79

def drilldown_calc_types
  self[:drilldown_calc_types]
end

#drilldown_filter ⇒ String?

Returns The filter for the drilled down result.

Returns:

  • (String, nil) —

    The filter for the drilled down result.

Since:

  • 1.3.3



34
35
36
 
# File 'lib/groonga/command/drilldownable.rb', line 34

def drilldown_filter
  self[:drilldown_filter]
end

#drilldown_limit ⇒ String

Returns drilldown_limit parameter value.

Returns:

  • (String) —

    drilldown_limit parameter value.

Since:

  • 1.1.3



72
73
74
 
# File 'lib/groonga/command/drilldownable.rb', line 72

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



65
66
67
 
# File 'lib/groonga/command/drilldownable.rb', line 65

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



58
59
60
 
# File 'lib/groonga/command/drilldownable.rb', line 58

def drilldown_output_columns
  self[:drilldown_output_columns]
end

#drilldown_sort_keys ⇒ ::Array<String>

Returns The sort keys for drilldowns.

Returns:

  • (::Array<String>) —

    The sort keys for drilldowns.

Since:

  • 1.2.8



50
51
52
53
 
# File 'lib/groonga/command/drilldownable.rb', line 50

def drilldown_sort_keys
  value = self[:drilldown_sort_keys] || self[:drilldown_sortby] || ""
  parse_array_value(value)
end

#drilldown_sortby ⇒ String

Deprecated.

since 1.4.4. Use drilldown_sort_keys instead.

Returns drilldown_sortby parameter value.

Returns:

  • (String) —

    drilldown_sortby parameter value.

Since:

  • 1.1.3



43
44
45
 
# File 'lib/groonga/command/drilldownable.rb', line 43

def drilldown_sortby
  self[:drilldown_sortby]
end

#drilldowns ⇒ Object 



27
28
29
 
# File 'lib/groonga/command/drilldownable.rb', line 27

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

#labeled_drilldowns ⇒ ::Hash<String, Drilldown>

Returns The labeled drilldowns.

Returns:

  • (::Hash<String, Drilldown>) —

    The labeled drilldowns.

Since:

  • 1.2.8



93
94
95
 
# File 'lib/groonga/command/drilldownable.rb', line 93

def labeled_drilldowns
  @labeled_drilldowns ||= parse_labeled_drilldowns("")
end