Module: Sunspot

Defined in:
lib/sunspot.rb,
lib/sunspot/type.rb,
lib/sunspot/util.rb,
lib/sunspot/field.rb,
lib/sunspot/query.rb,
lib/sunspot/setup.rb,
lib/sunspot/schema.rb,
lib/sunspot/search.rb,
lib/sunspot/indexer.rb,
lib/sunspot/session.rb,
lib/sunspot/adapters.rb,
lib/sunspot/dsl/query.rb,
lib/sunspot/dsl/scope.rb,
lib/sunspot/dsl/fields.rb,
lib/sunspot/dsl/search.rb,
lib/sunspot/query/sort.rb,
lib/sunspot/search/hit.rb,
lib/sunspot/query/local.rb,
lib/sunspot/query/query.rb,
lib/sunspot/query/scope.rb,
lib/sunspot/dsl/fulltext.rb,
lib/sunspot/query/dismax.rb,
lib/sunspot/configuration.rb,
lib/sunspot/field_factory.rb,
lib/sunspot/data_extractor.rb,
lib/sunspot/composite_setup.rb,
lib/sunspot/dsl/field_query.rb,
lib/sunspot/dsl/query_facet.rb,
lib/sunspot/dsl/restriction.rb,
lib/sunspot/query/connective.rb,
lib/sunspot/query/pagination.rb,
lib/sunspot/search/facet_row.rb,
lib/sunspot/search/highlight.rb,
lib/sunspot/text_field_setup.rb,
lib/sunspot/query/boost_query.rb,
lib/sunspot/query/field_facet.rb,
lib/sunspot/query/query_facet.rb,
lib/sunspot/query/restriction.rb,
lib/sunspot/search/date_facet.rb,
lib/sunspot/query/highlighting.rb,
lib/sunspot/search/field_facet.rb,
lib/sunspot/search/query_facet.rb,
lib/sunspot/query/sort_composite.rb,
lib/sunspot/query/date_field_facet.rb,
lib/sunspot/query/text_field_boost.rb,
lib/sunspot/query/abstract_field_facet.rb

Overview

The Sunspot module provides class-method entry points to most of the functionality provided by the Sunspot library. Internally, the Sunspot singleton class contains a (non-thread-safe!) instance of Sunspot::Session, to which it delegates most of the class methods it exposes. In the method documentation below, this instance is referred to as the “singleton session”.

Though the singleton session provides a convenient entry point to Sunspot, it is by no means required to use the Sunspot class methods. Multiple sessions may be instantiated and used (if you need to connect to multiple Solr instances, for example.)

Note that the configuration of classes for index/search (the setup method) is not session-specific, but rather global.

Defined Under Namespace

Modules: Adapters, Configuration, DSL, DataExtractor, FieldFactory, Query, Type, Util Classes: AttributeField, CompositeSetup, Field, FulltextField, IdField, Indexer, Schema, Search, Session, Setup, TextFieldSetup, TypeField

Constant Summary collapse

UnrecognizedFieldError = 
Class.new(Exception)
UnrecognizedRestrictionError = 
Class.new(Exception)
NoAdapterError = 
Class.new(Exception)
NoSetupError = 
Class.new(Exception)
IllegalSearchError = 
Class.new(Exception)

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.session=(value) ⇒ Object

Clients can inject a session proxy, allowing them to implement custom session-management logic while retaining the Sunspot singleton API as an available interface. The object assigned to this attribute must respond to all of the public methods of the Sunspot::Session class.



50
51
52
 
# File 'lib/sunspot.rb', line 50

def session=(value)
  @session = value
end

Class Method Details

.batch(&block) ⇒ Object

Process all adds in a batch. Any Sunspot adds initiated inside the block will be sent in bulk when the block finishes. Useful if your application initiates index adds from various places in code as part of a single operation; doing a batch add will give better performance.

Example

Sunspot.batch do
  post = Post.new
  Sunspot.add(post)
  comment = Comment.new
  Sunspot.add(comment)
end

Sunspot will send both the post and the comment in a single request.



403
404
405
 
# File 'lib/sunspot.rb', line 403

def batch(&block)
  session.batch(&block)
end

.commit ⇒ Object

Commits the singleton session

When documents are added to or removed from Solr, the changes are initially stored in memory, and are not reflected in Solr’s existing searcher instance. When a commit message is sent, the changes are written to disk, and a new searcher is spawned. Commits are thus fairly expensive, so if your application needs to index several documents as part of a single operation, it is advisable to index them all and then call commit at the end of the operation.

Note that Solr can also be configured to automatically perform a commit after either a specified interval after the last change, or after a specified number of documents are added. See wiki.apache.org/solr/SolrConfigXml



201
202
203
 
# File 'lib/sunspot.rb', line 201

def commit
  session.commit
end

.commit_if_delete_dirty ⇒ Object

Sends a commit if the session has deletes since the last commit (see #delete_dirty?).



440
441
442
 
# File 'lib/sunspot.rb', line 440

def commit_if_delete_dirty
  session.commit_if_delete_dirty
end

.commit_if_dirty ⇒ Object

Sends a commit if the session is dirty (see #dirty?).



422
423
424
 
# File 'lib/sunspot.rb', line 422

def commit_if_dirty
  session.commit_if_dirty
end

.config ⇒ Object

Returns the configuration associated with the singleton session. See Sunspot::Configuration for details.

Returns

LightConfig::Configuration

configuration for singleton session



451
452
453
 
# File 'lib/sunspot.rb', line 451

def config
  session.config
end

.delete_dirty? ⇒ Boolean

True if documents have been removed since the last commit.

Returns

Boolean

Whether there have been any deletes since the last commit

Returns:

  • (Boolean) 


433
434
435
 
# File 'lib/sunspot.rb', line 433

def delete_dirty?
  session.delete_dirty?
end

.dirty? ⇒ Boolean

True if documents have been added, updated, or removed since the last commit.

Returns

Boolean

Whether there have been any updates since the last commit

Returns:

  • (Boolean) 


415
416
417
 
# File 'lib/sunspot.rb', line 415

def dirty?
  session.dirty?
end

.index(*objects) ⇒ Object

Indexes objects on the singleton session.

Parameters

objects…<Object>

objects to index (may pass an array or varargs)

Example

post1, post2 = new Array(2) { Post.create }
Sunspot.index(post1, post2)

Note that indexed objects won’t be reflected in search until a commit is sent - see Sunspot.index! and Sunspot.commit



170
171
172
 
# File 'lib/sunspot.rb', line 170

def index(*objects)
  session.index(*objects)
end

.index!(*objects) ⇒ Object

Indexes objects on the singleton session and commits immediately.

See: Sunspot.index and Sunspot.commit

Parameters

objects…<Object>

objects to index (may pass an array or varargs)



182
183
184
 
# File 'lib/sunspot.rb', line 182

def index!(*objects)
  session.index!(*objects)
end

.new_search(*types) ⇒ Object

Create a new Search instance, but do not execute it immediately. Generally you will want to use the #search method to execute searches using the DSL; however, if you are building searches dynamically (using the Builder pattern, for instance), it may be easier to access the Query API directly.

Parameters

types<Class>…

One or more types to search for. If no types are passed, all configured types will be searched for.

Returns

Sunspot::Search

Search object, not yet executed. Query parameters can be added manually; then #execute! should be called.



223
224
225
 
# File 'lib/sunspot.rb', line 223

def new_search(*types)
  session.new_search(*types)
end

.remove(*objects) ⇒ Object

Remove objects from the index. Any time an object is destroyed, it must be removed from the index; otherwise, the index will contain broken references to objects that do not exist, which will cause errors when those objects are matched in search results.

Parameters

objects…<Object>

Objects to remove from the index (may pass an array or varargs)

Example

post.destroy
Sunspot.remove(post)



316
317
318
 
# File 'lib/sunspot.rb', line 316

def remove(*objects)
  session.remove(*objects)
end

.remove!(*objects) ⇒ Object

Remove objects from the index and immediately commit. See Sunspot.remove

Parameters

objects…<Object>

Objects to remove from the index



327
328
329
 
# File 'lib/sunspot.rb', line 327

def remove!(*objects)
  session.remove!(*objects)
end

.remove_all(*classes) ⇒ Object

Remove all objects of the given classes from the index. There isn’t much use for this in general operations but it can be useful for maintenance, testing, etc. If no arguments are passed, remove everything from the index.

Parameters

classes…<Class>

classes for which to remove all instances from the index (may pass an array or varargs)

Example

Sunspot.remove_all(Post, Blog)



370
371
372
 
# File 'lib/sunspot.rb', line 370

def remove_all(*classes)
  session.remove_all(*classes)
end

.remove_all!(*classes) ⇒ Object

Remove all objects of the given classes from the index and immediately commit. See Sunspot.remove_all

Parameters

classes…<Class>

classes for which to remove all instances from the index



382
383
384
 
# File 'lib/sunspot.rb', line 382

def remove_all!(*classes)
  session.remove_all!(*classes)
end

.remove_by_id(clazz, id) ⇒ Object

Remove an object from the index using its class name and primary key. Useful if you know this information and want to remove an object without instantiating it from persistent storage

Parameters

clazz<Class>

Class of the object, or class name as a string or symbol

id

Primary key of the object. This should be the same id that would be returned by the class’s instance adapter.



343
344
345
 
# File 'lib/sunspot.rb', line 343

def remove_by_id(clazz, id)
  session.remove_by_id(clazz, id)
end

.remove_by_id!(clazz, id) ⇒ Object

Remove an object by class name and primary key, and immediately commit. See #remove_by_id and #commit



351
352
353
 
# File 'lib/sunspot.rb', line 351

def remove_by_id!(clazz, id)
  session.remove_by_id!(clazz, id)
end

.reset!(keep_config = false) ⇒ Object

Resets the singleton session. This is useful for clearing out all static data between tests, but probably nowhere else.

Parameters

keep_config<Boolean>

Whether to retain the configuration used by the current singleton session. Default false.



465
466
467
468
469
470
471
472
473
 
# File 'lib/sunspot.rb', line 465

def reset!(keep_config = false)
  config =
    if keep_config
      session.config
    else
      Configuration.build
    end
  @session = Session.new(config)
end

.search(*types, &block) ⇒ Object

Search for objects in the index.

Parameters

types<Class>…

One or more types to search for. If no types are passed, all configured types will be searched.

Returns

Sunspot::Search

Object containing results, facets, count, etc.

The fields available for restriction, ordering, etc. are those that meet the following criteria:

  • They are not of type text.

  • They are defined for at least one of the classes being searched

  • They have the same data type for all of the classes being searched.

  • They have the same multiple flag for all of the classes being searched.

  • They have the same stored flag for all of the classes being searched.

The restrictions available are the constants defined in the Sunspot::Restriction class. The standard restrictions are:

with(:field_name).equal_to(value)
with(:field_name, value) # shorthand for above
with(:field_name).less_than(value)
with(:field_name).greater_than(value)
with(:field_name).between(value1..value2)
with(:field_name).any_of([value1, value2, value3])
with(:field_name).all_of([value1, value2, value3])
without(some_instance) # exclude that particular instance

without can be substituted for with, causing the restriction to be negated. In the last example above, only without works, as it does not make sense to search only for an instance you already have.

Equality restrictions can take nil as a value, which restricts the results to documents that have no value for the given field. Passing nil as a value to other restriction types is illegal. Thus:

with(:field_name, nil) # ok
with(:field_name).equal_to(nil) # ok
with(:field_name).less_than(nil) # bad

Example

Sunspot.search(Post) do
  keywords 'great pizza'
  with(:published_at).less_than Time.now
  with :blog_id, 1
  without current_post
  facet :category_ids
  order_by :published_at, :desc
  paginate 2, 15
end

If the block passed to #search takes an argument, that argument will present the DSL, and the block will be evaluated in the calling context. This will come in handy for building searches using instance data or methods, e.g.:

Sunspot.search(Post) do |query|
  query.with(:blog_id, @current_blog.id)
end

See Sunspot::DSL::Search, Sunspot::DSL::Scope, Sunspot::DSL::FieldQuery and Sunspot::DSL::Query for the full API presented inside the block.



297
298
299
 
# File 'lib/sunspot.rb', line 297

def search(*types, &block)
  session.search(*types, &block)
end

.setup(clazz, &block) ⇒ Object

Configures indexing and search for a given class.

Parameters

clazz<Class>

class to configure

Example

Sunspot.setup(Post) do
  text :title, :body
  string :author_name
  integer :blog_id
  integer :category_ids
  float :average_rating, :using => :ratings_average
  time :published_at
  string :sort_title do
    title.downcase.sub(/^(an?|the)\W+/, ''/) if title = self.title
  end
end
Attribute Fields vs. Virtual Fields

Attribute fields call a method on the indexed object and index the return value. All of the fields defined above except for the last one are attribute fields. By default, the field name will also be the attribute used; this can be overriden with the :using option, as in :average_rating above. In that case, the attribute :ratings_average will be indexed with the field name :average_rating.

:sort_title is a virtual field, which evaluates the block inside the context of the instance being indexed, and indexes the value returned by the block. If the block you pass takes an argument, it will be passed the instance rather than being evaluated inside of it; so, the following example is equivalent to the one above (assuming #title is public):

Sunspot.setup(Post) do
  string :sort_title do |post|
    post.title.downcase.sub(/^(an?|the)\W+/, ''/) if title = self.title
  end
end
Field Types

The available types are:

  • text

  • string

  • integer

  • float

  • time

  • boolean

Note that the text type behaves quite differently from the others - this is the type that is indexed as fulltext, and is searched using the keywords method inside the search DSL. Text fields cannot have restrictions set on them, nor can they be used in order statements or for facets. All other types are indexed literally, and thus can be used for all of those operations. They will not, however, be searched in fulltext. In this way, Sunspot provides a complete barrier between fulltext fields and value fields.

It is fine to specify a field both as a text field and a string field; internally, the fields will have different names so there is no danger of conflict.

Dynamic Fields

For use cases which have highly dynamic data models (for instance, an open set of key-value pairs attached to a model), it may be useful to defer definition of fields until indexing time. Sunspot exposes dynamic fields, which define a data accessor (either attribute or virtual, see above), which accepts a hash of field names to values. Note that the field names in the hash are internally scoped to the base name of the dynamic field, so any time they are referred to, they are referred to using both the base name and the dynamic (runtime-specified) name.

Dynamic fields are speficied in the setup block using the type name prefixed by dynamic_. For example:

Sunspot.setup(Post) do
  dynamic_string :custom_values do
    key_value_pairs.inject({}) do |hash, key_value_pair|
      hash[key_value_pair.key.to_sym] = key_value_pair.value
    end
  end
end

If you later wanted to facet all of the values for the key “cuisine”, you could issue:

Sunspot.search(Post) do
  dynamic :custom_values do
    facet :cuisine
  end
end

In the documentation, :custom_values is referred to as the “base name” - that is, the one specified statically - and :cuisine is referred to as the dynamic name, which is the part that is specified at indexing time.



152
153
154
 
# File 'lib/sunspot.rb', line 152

def setup(clazz, &block)
  Setup.setup(clazz, &block)
end