Module: SunspotActiveRecord::Searchable::InstanceMethods

Defined in:
lib/sunspot_activerecord/searchable.rb

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Object) included(base)

:nodoc:



328
329
330
331
332
333
334
335
336
337
# File 'lib/sunspot_activerecord/searchable.rb', line 328

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

- (Object) solr_index

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.



346
347
348
# File 'lib/sunspot_activerecord/searchable.rb', line 346

def solr_index
  Sunspot.index(self)
end

- (Object) solr_index!

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



353
354
355
# File 'lib/sunspot_activerecord/searchable.rb', line 353

def solr_index!
  Sunspot.index!(self)
end

- (Object) solr_more_like_this(*args, &block)



376
377
378
379
380
381
# File 'lib/sunspot_activerecord/searchable.rb', line 376

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

- (Object) solr_more_like_this_ids(&block)



383
384
385
386
387
# File 'lib/sunspot_activerecord/searchable.rb', line 383

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

- (Object) solr_remove_from_index

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.



364
365
366
# File 'lib/sunspot_activerecord/searchable.rb', line 364

def solr_remove_from_index
  Sunspot.remove(self)
end

- (Object) solr_remove_from_index!

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



372
373
374
# File 'lib/sunspot_activerecord/searchable.rb', line 372

def solr_remove_from_index!
  Sunspot.remove!(self)
end