Class: Sunspot::Search::AbstractSearch

Inherits:
Object
  • Object
show all
Includes:
HitEnumerable
Defined in:
lib/sunspot/search/abstract_search.rb

Overview

This class encapsulates the results of a Solr search. It provides access to search results, total result count, facets, and pagination information. Instances of Search are returned by the Sunspot.search and Sunspot.new_search methods.

Direct Known Subclasses

MoreLikeThisSearch, StandardSearch

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from HitEnumerable

#data_accessor_for, #each_hit_with_result, #populate_hits

Constructor Details

#initialize(connection, setup, query, configuration) ⇒ AbstractSearch

:nodoc:



24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/sunspot/search/abstract_search.rb', line 24

def initialize(connection, setup, query, configuration) #:nodoc:
  @connection, @setup, @query = connection, setup, query
  @query.paginate(1, configuration.pagination.default_per_page)

  @facets = []
  @facets_by_name = {}

  @groups_by_name = {}
  @groups = []

  @stats_by_name = {}
  @stats = []
end

Instance Attribute Details

#facets ⇒ Object (readonly)

Retrieve all facet objects defined for this search, in order they were defined. To retrieve an individual facet by name, use #facet()



18
19
20
 
# File 'lib/sunspot/search/abstract_search.rb', line 18

def facets
  @facets
end

#groups ⇒ Object (readonly)

Retrieve all facet objects defined for this search, in order they were defined. To retrieve an individual facet by name, use #facet()



18
19
20
 
# File 'lib/sunspot/search/abstract_search.rb', line 18

def groups
  @groups
end

#query ⇒ Object (readonly)

:nodoc:



19
20
21
 
# File 'lib/sunspot/search/abstract_search.rb', line 19

def query
  @query
end

#request_handler ⇒ Object

Returns the value of attribute request_handler.



20
21
22
 
# File 'lib/sunspot/search/abstract_search.rb', line 20

def request_handler
  @request_handler
end

#stats(name) ⇒ Object (readonly)

Retrieve all facet objects defined for this search, in order they were defined. To retrieve an individual facet by name, use #facet()



18
19
20
 
# File 'lib/sunspot/search/abstract_search.rb', line 18

def stats
  @stats
end

Instance Method Details

#add_date_facet(field, options) ⇒ Object

:nodoc:



237
238
239
240
 
# File 'lib/sunspot/search/abstract_search.rb', line 237

def add_date_facet(field, options) #:nodoc:
  name = (options[:name] || field.name)
  add_facet(name, DateFacet.new(field, self, options))
end

#add_field_facet(field, options = {}) ⇒ Object

:nodoc:



228
229
230
231
 
# File 'lib/sunspot/search/abstract_search.rb', line 228

def add_field_facet(field, options = {}) #:nodoc:
  name = (options[:name] || field.name)
  add_facet(name, FieldFacet.new(field, self, options))
end

#add_field_group(field) ⇒ Object

:nodoc:



224
225
226
 
# File 'lib/sunspot/search/abstract_search.rb', line 224

def add_field_group(field) #:nodoc:
  add_group(field.name, FieldGroup.new(field, self))
end

#add_field_stats(field) ⇒ Object

:nodoc:



247
248
249
 
# File 'lib/sunspot/search/abstract_search.rb', line 247

def add_field_stats(field) #:nodoc:
  add_stats(field.name, FieldStats.new(field, self))
end

#add_query_facet(name, options) ⇒ Object

:nodoc:



233
234
235
 
# File 'lib/sunspot/search/abstract_search.rb', line 233

def add_query_facet(name, options) #:nodoc:
  add_facet(name, QueryFacet.new(name, self, options))
end

#add_range_facet(field, options) ⇒ Object

:nodoc:



242
243
244
245
 
# File 'lib/sunspot/search/abstract_search.rb', line 242

def add_range_facet(field, options) #:nodoc:
  name = (options[:name] || field.name)
  add_facet(name, RangeFacet.new(field, self, options))
end

#build(&block) ⇒ Object

Build this search using a DSL block. This method can be called more than once on an unexecuted search (e.g., Sunspot.new_search) in order to build a search incrementally.

Example

search = Sunspot.new_search(Post)
search.build do
  with(:published_at).less_than Time.now
end
search.execute



214
215
216
217
 
# File 'lib/sunspot/search/abstract_search.rb', line 214

def build(&block)
  Util.instance_eval_or_call(dsl, &block)
  self
end

#dynamic_facet(base_name, dynamic_name) ⇒ Object

Deprecated in favor of optional second argument to #facet



185
186
187
 
# File 'lib/sunspot/search/abstract_search.rb', line 185

def dynamic_facet(base_name, dynamic_name) #:nodoc:
  facet(base_name, dynamic_name)
end

#execute ⇒ Object

Execute the search on the Solr instance and store the results. If you use Sunspot#search() to construct your searches, there is no need to call this method as it has already been called. If you use Sunspot#new_search(), you will need to call this method after building the query.



45
46
47
48
49
50
 
# File 'lib/sunspot/search/abstract_search.rb', line 45

def execute
  reset
  params = @query.to_params
  @solr_result = @connection.post "#{request_handler}", :data => params
  self
end

#execute! ⇒ Object

:nodoc: deprecated



52
53
54
 
# File 'lib/sunspot/search/abstract_search.rb', line 52

def execute! #:nodoc: deprecated
  execute
end

#facet(name, dynamic_name = nil) ⇒ Object

Get the facet object for the given name. ‘name` can either be the name given to a query facet, or the field name of a field facet. Returns a Sunspot::Facet object.

Parameters

name<Symbol>

Name of the field to return the facet for, or the name given to the query facet when the search was constructed.

dynamic_name<Symbol>

If faceting on a dynamic field, this is the dynamic portion of the field name.

Example:

search = Sunspot.search(Post) do
  facet :category_ids
  dynamic :custom do
    facet :cuisine
  end
  facet :age do
    row 'Less than a month' do
      with(:published_at).greater_than(1.month.ago)
    end
    row 'Less than a year' do
      with(:published_at, 1.year.ago..1.month.ago)
    end
    row 'More than a year' do
      with(:published_at).less_than(1.year.ago)
    end
  end
end
search.facet(:category_ids)
  #=> Facet for :category_ids field
search.facet(:custom, :cuisine)
  #=> Facet for the dynamic field :cuisine in the :custom field definition
search.facet(:age)
  #=> Facet for the query facet named :age



160
161
162
163
164
165
166
167
168
 
# File 'lib/sunspot/search/abstract_search.rb', line 160

def facet(name, dynamic_name = nil)
  if name
    if dynamic_name
      @facets_by_name[:"#{name}:#{dynamic_name}"]
    else
      @facets_by_name[name.to_sym]
    end
  end
end

#facet_response ⇒ Object

:nodoc:



189
190
191
 
# File 'lib/sunspot/search/abstract_search.rb', line 189

def facet_response #:nodoc:
  @solr_result['facet_counts']
end

#group(name) ⇒ Object 



176
177
178
179
180
 
# File 'lib/sunspot/search/abstract_search.rb', line 176

def group(name)
  if name
    @groups_by_name[name.to_sym]
  end
end

#group_response ⇒ Object

:nodoc:



197
198
199
 
# File 'lib/sunspot/search/abstract_search.rb', line 197

def group_response #:nodoc:
  @solr_result['grouped']
end

#highlights_for(doc) ⇒ Object

:nodoc:



251
252
253
254
255
 
# File 'lib/sunspot/search/abstract_search.rb', line 251

def highlights_for(doc) #:nodoc:
  if @solr_result['highlighting']
    @solr_result['highlighting'][doc['id']]
  end
end

#hits(options = {}) ⇒ Object Also known as: raw_results

Access raw Solr result information. Returns a collection of Hit objects that contain the class name, primary key, keyword relevance score (if applicable), and any stored fields.

Options (options)

:verify

Only return hits that reference objects that actually exist in the data store. This causes results to be eager-loaded from the data store, unlike the normal behavior of this method, which only loads the referenced results when Hit#result is first called.

Returns

Array

Ordered collection of Hit objects



89
90
91
92
93
94
95
 
# File 'lib/sunspot/search/abstract_search.rb', line 89

def hits(options = {})
  if options[:verify]
    super
  else
    @hits ||= paginate_collection(super)
  end
end

#inspect ⇒ Object

:nodoc:



220
221
222
 
# File 'lib/sunspot/search/abstract_search.rb', line 220

def inspect #:nodoc:
  "<Sunspot::Search:#{query.to_params.inspect}>"
end

#query_time ⇒ Object

The time elapsed to generate the Solr response

Returns

Integer

Query runtime in milliseconds



116
117
118
 
# File 'lib/sunspot/search/abstract_search.rb', line 116

def query_time
  @query_time ||= solr_response_header['QTime']
end

#results ⇒ Object

Get the collection of results as instantiated objects. If WillPaginate is available, the results will be a WillPaginate::Collection instance; if not, it will be a vanilla Array.

If not all of the results referenced by the Solr hits actually exist in the data store, Sunspot will only return the results that do exist.

Returns

WillPaginate::Collection or Array

Instantiated result objects



68
69
70
 
# File 'lib/sunspot/search/abstract_search.rb', line 68

def results
  @results ||= paginate_collection(verified_hits.map { |hit| hit.instance })
end

#stats_response ⇒ Object

:nodoc:



193
194
195
 
# File 'lib/sunspot/search/abstract_search.rb', line 193

def stats_response #:nodoc:
  @solr_result['stats']['stats_fields']
end

#total ⇒ Object

The total number of documents matching the query parameters

Returns

Integer

Total matching documents



105
106
107
 
# File 'lib/sunspot/search/abstract_search.rb', line 105

def total
  @total ||= solr_response['numFound'] || 0
end