Class: Sunspot::DSL::Query

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

Overview

This class presents a DSL for constructing queries using the Sunspot.search method. Methods of this class are available inside the search block. Methods that take field names as arguments are implemented in the superclass Sunspot::DSL::Scope, as that DSL is also available in the #dynamic() block.

See Sunspot.search for usage examples

Constant Summary

Constants inherited from Scope

Scope::NONE

Instance Method Summary collapse

Methods inherited from Scope

#facet, #initialize, #order_by, #with, #without

Constructor Details

This class inherits a constructor from Sunspot::DSL::Scope

Instance Method Details

#dynamic(base_name, &block) ⇒ Object

Apply restrictions, facets, and ordering to dynamic field instances. The block API is implemented by Sunspot::DSL::Scope, which is a superclass of the Query DSL (thus providing a subset of the API, in particular only methods that refer to particular fields).

Parameters

base_name<Symbol>

The base name for the dynamic field definition

Example

Sunspot.search Post do
  dynamic :custom do
    with :cuisine, 'Pizza'
    facet :atmosphere
    order_by :chef_name
  end
end



73
74
75
 
# File 'lib/sunspot/dsl/query.rb', line 73

def dynamic(base_name, &block)
  Scope.new(@query.dynamic_query(base_name)).instance_eval(&block)
end

#keywords(keywords) ⇒ Object

Specify a phrase that should be searched as fulltext. Only text fields are searched - see DSL::Fields.text

Note that the keywords are passed directly to Solr unadulterated. The advantage of this is that users can potentially use boolean logic to make advanced searches. The disadvantage is that syntax errors are possible. This may get better in a future version; suggestions are welcome.

Parameters

keywords<String>

phrase to perform fulltext search on



26
27
28
 
# File 'lib/sunspot/dsl/query.rb', line 26

def keywords(keywords)
  @query.keywords = keywords
end

#paginate(options = {}) ⇒ Object

Paginate your search. This works the same way as WillPaginate’s paginate().

Note that Solr searches are always paginated. Not calling #paginate is the equivalent of calling:

paginate(:page => 1, :per_page => Sunspot.config.pagination.default_per_page)

Options (options)

:page<Integer>

The requested page (required)

:per_page<Integer>

How many results to return per page. The default is the value in Sunspot.config.pagination.default_per_page

Raises:

  • (ArgumentError) 


46
47
48
49
50
51
 
# File 'lib/sunspot/dsl/query.rb', line 46

def paginate(options = {})
  page = options.delete(:page) || raise(ArgumentError, "paginate requires a :page argument")
  per_page = options.delete(:per_page)
  raise ArgumentError, "unknown argument #{options.keys.first.inspect} passed to paginate" unless options.empty?
  @query.paginate(page, per_page)
end