Class: Sunspot::DSL::FieldQuery

Inherits:
Scope
  • Object
show all
Defined in:
lib/sunspot/dsl/field_query.rb

Overview

Provides an API for areas of the query DSL that operate on specific fields. This functionality is provided by the query DSL and the dynamic query DSL.

Direct Known Subclasses

Query

Constant Summary

Constants inherited from Scope

Scope::NONE

Instance Method Summary collapse

Methods inherited from Scope

#all_of, #any_of, #with, #without

Constructor Details

#initialize(query, setup) ⇒ FieldQuery

Returns a new instance of FieldQuery.



9
10
11
12
 
# File 'lib/sunspot/dsl/field_query.rb', line 9

def initialize(query, setup)
  @query = query
  super(query.scope, setup)
end

Instance Method Details

#dynamic(base_name, &block) ⇒ Object 



91
92
93
94
95
96
 
# File 'lib/sunspot/dsl/field_query.rb', line 91

def dynamic(base_name, &block)
  Sunspot::Util.instance_eval_or_call(
    FieldQuery.new(@query, @setup.dynamic_field_factory(base_name)),
    &block
  )
end

#facet(*field_names, &block) ⇒ Object

Request facets on the given field names. If the last argument is a hash, the given options will be applied to all specified fields. See Sunspot::Search#facet and Sunspot::Facet for information on what is returned.

Parameters

field_names…<Symbol>

fields for which to return field facets

Options

:sort<Symbol>

Either :count (values matching the most terms first) or :index (lexical)

:limit<Integer>

The maximum number of facet rows to return

:minimum_count<Integer>

The minimum count a facet row must have to be returned

:zeros<Boolean>

Return facet rows for which there are no matches (equivalent to :minimum_count => 0). Default is false.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/sunspot/dsl/field_query.rb', line 62

def facet(*field_names, &block)
  if block
    options =
      if field_names.last.is_a?(Hash)
        field_names.pop
      else
        {}
      end
    if field_names.length != 1
      raise(
        ArgumentError,
        "wrong number of arguments (#{field_names.length} for 1)"
      )
    end
    name = field_names.first
    DSL::QueryFacet.new(@query.add_query_facet(name, options), @setup).instance_eval(&block)
  else
    options = 
      if field_names.last.is_a?(Hash)
        field_names.pop
      else
        {}
      end
    for field_name in field_names
      @query.add_field_facet(@setup.field(field_name), options)
    end
  end
end

#order_by(field_name, direction = nil) ⇒ Object

Specify the order that results should be returned in. This method can be called multiple times; precedence will be in the order given.

Parameters

field_name<Symbol>

the field to use for ordering

direction<Symbol>

:asc or :desc (default :asc)



22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/sunspot/dsl/field_query.rb', line 22

def order_by(field_name, direction = nil)
  sort =
    if special = Sunspot::Query::Sort.special(field_name)
      special.new(direction)
    else
      Sunspot::Query::Sort::FieldSort.new(
        @setup.field(field_name), direction
      )
    end
  @query.add_sort(sort)
end

#order_by_random ⇒ Object

DEPRECATED Use order_by(:random)



37
38
39
 
# File 'lib/sunspot/dsl/field_query.rb', line 37

def order_by_random
  order_by(:random)
end