Class: Sunspot::DSL::StandardQuery
- Inherits:
-
FieldQuery
- Object
- Scope
- FieldQuery
- Sunspot::DSL::StandardQuery
- Includes:
- Adjustable, Paginatable
- Defined in:
- sunspot/lib/sunspot/dsl/standard_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. Much of the DSL’s functionality is implemented by this class’s superclasses, Sunspot::DSL::FieldQuery and Sunspot::DSL::Scope
See Sunspot.search for usage examples
Direct Known Subclasses
Constant Summary
Constants inherited from Scope
Instance Method Summary (collapse)
-
- (Object) fulltext(keywords, options = {}, &block)
(also: #keywords)
Specify a phrase that should be searched as fulltext.
- - (Object) with(*args)
Methods included from Adjustable
#adjust_solr_params, #request_handler
Methods included from Paginatable
Methods inherited from FieldQuery
#dynamic, #facet, #initialize, #order_by, #order_by_random
Methods inherited from Scope
#all_of, #any_of, #dynamic, #initialize, #text_fields, #without
Constructor Details
This class inherits a constructor from Sunspot::DSL::FieldQuery
Instance Method Details
- (Object) fulltext(keywords, options = {}, &block) Also known as: keywords
Specify a phrase that should be searched as fulltext. Only text fields are searched - see DSL::Fields.text
Keyword search is executed using Solr’s dismax handler, which strikes a good balance between powerful and foolproof. In particular, well-matched quotation marks can be used to group phrases, and the + and - modifiers work as expected. All other special Solr boolean syntax is escaped, and mismatched quotes are ignored entirely.
This method can optionally take a block, which is evaluated by the Fulltext DSL class, and exposes several powerful dismax features.
Parameters
keywords | phrase to perform fulltext search on |
Options
:fields | List of fields that should be searched for keywords. Defaults to all fields configured for the types under search. |
:highlight | If true, perform keyword highlighting on all searched fields. If an array of field names, perform highlighting on the specified fields. Note that for highlighting to work, the desired fields have to be set up with :stored => true. This can also be called from within the fulltext block. |
:minimum_match | The minimum number of search terms that a result must match. By default, all search terms must match; if the number of search terms is less than this number, the default behavior applies. |
:tie | A tiebreaker coefficient for scores derived from subqueries that are lower-scoring than the maximum score subquery. Typically a near-zero value is useful. See wiki.apache.org/solr/DisMaxRequestHandler#tie_.28Tie_breaker.29 for more information. |
:query_phrase_slop | The number of words that can appear between the words in a user-entered phrase (i.e., keywords in quotes) and still match. For instance, in a search for “\“great pizza\”“ with a phrase slop of 1, “great pizza” and “great big pizza” will match, but “great monster of a pizza” will not. Default behavior is a query phrase slop of zero. |
58 59 60 61 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 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 |
# File 'sunspot/lib/sunspot/dsl/standard_query.rb', line 58 def fulltext(keywords, = {}, &block) if keywords && !(keywords.to_s =~ /^\s*$/) fulltext_query = @query.add_fulltext(keywords) if field_names = .delete(:fields) Util.Array(field_names).each do |field_name| @setup.text_fields(field_name).each do |field| fulltext_query.add_fulltext_field(field, field.default_boost) end end end if minimum_match = .delete(:minimum_match) fulltext_query.minimum_match = minimum_match.to_i end if tie = .delete(:tie) fulltext_query.tie = tie.to_f end if query_phrase_slop = .delete(:query_phrase_slop) fulltext_query.query_phrase_slop = query_phrase_slop.to_i end if highlight_field_names = .delete(:highlight) if highlight_field_names == true fulltext_query.add_highlight else highlight_fields = [] Util.Array(highlight_field_names).each do |field_name| highlight_fields.concat(@setup.text_fields(field_name)) end fulltext_query.add_highlight(highlight_fields) end end if block && fulltext_query fulltext_dsl = Fulltext.new(fulltext_query, @setup) Util.instance_eval_or_call( fulltext_dsl, &block ) end if !field_names && (!fulltext_dsl || !fulltext_dsl.fields_added?) @setup.all_text_fields.each do |field| unless fulltext_query.has_fulltext_field?(field) unless fulltext_dsl && fulltext_dsl.exclude_fields.include?(field.name) fulltext_query.add_fulltext_field(field, field.default_boost) end end end end end end |
- (Object) with(*args)
108 109 110 111 112 113 114 115 116 117 118 119 120 |
# File 'sunspot/lib/sunspot/dsl/standard_query.rb', line 108 def with(*args) case args.first when String, Symbol field_name = args[0] value = args.length > 1 ? args[1] : Scope::NONE if value == Scope::NONE return DSL::RestrictionWithNear.new(@setup.field(field_name.to_sym), @scope, @query, false) end end # else super end |