Module: Sunspot::Rails::Searchable::InstanceMethods

Defined in:
lib/sunspot/rails/searchable.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object

:nodoc:



275
276
277
278
279
280
281
282
283
284
 
# File 'lib/sunspot/rails/searchable.rb', line 275

def self.included(base) #:nodoc:
  base.module_eval do
    alias_method :index, :solr_index unless method_defined? :index
    alias_method :index!, :solr_index! unless method_defined? :index!
    alias_method :remove_from_index, :solr_remove_from_index unless method_defined? :remove_from_index
    alias_method :remove_from_index!, :solr_remove_from_index! unless method_defined? :remove_from_index!
    alias_method :more_like_this, :solr_more_like_this unless method_defined? :more_like_this
    alias_method :more_like_this_ids, :solr_more_like_this_ids unless method_defined? :more_like_this_ids
  end
end

Instance Method Details

#solr_index ⇒ Object

Index the model in Solr. If the model is already indexed, it will be updated. Using the defaults, you will usually not need to call this method, as models are indexed automatically when they are created or updated. If you have disabled automatic indexing (see ClassMethods#searchable), this method allows you to manage indexing manually.



293
294
295
 
# File 'lib/sunspot/rails/searchable.rb', line 293

def solr_index
  Sunspot.index(self)
end

#solr_index! ⇒ Object

Index the model in Solr and immediately commit. See #index



300
301
302
 
# File 'lib/sunspot/rails/searchable.rb', line 300

def solr_index!
  Sunspot.index!(self)
end

#solr_more_like_this(*args, &block) ⇒ Object 



323
324
325
326
327
328
 
# File 'lib/sunspot/rails/searchable.rb', line 323

def solr_more_like_this(*args, &block)
  options = args.extract_options!
  self.class.solr_execute_search(options) do
    Sunspot.new_more_like_this(self, *args, &block)
  end
end

#solr_more_like_this_ids(&block) ⇒ Object 



330
331
332
333
334
 
# File 'lib/sunspot/rails/searchable.rb', line 330

def solr_more_like_this_ids(&block)
  self.class.solr_execute_search_ids do
    solr_more_like_this(&block)
  end
end

#solr_remove_from_index ⇒ Object

Remove the model from the Solr index. Using the defaults, this should not be necessary, as models will automatically be removed from the index when they are destroyed. If you disable automatic removal (which is not recommended!), you can use this method to manage removal manually.



311
312
313
 
# File 'lib/sunspot/rails/searchable.rb', line 311

def solr_remove_from_index
  Sunspot.remove(self)
end

#solr_remove_from_index! ⇒ Object

Remove the model from the Solr index and commit immediately. See #remove_from_index



319
320
321
 
# File 'lib/sunspot/rails/searchable.rb', line 319

def solr_remove_from_index!
  Sunspot.remove!(self)
end