Module: SunspotActiveRecord::Searchable::ClassMethods

Defined in:
lib/sunspot_activerecord/searchable.rb

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Object) extended(base)

:nodoc:



101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/sunspot_activerecord/searchable.rb', line 101

def self.extended(base) #:nodoc:
  class <<base
    alias_method :search, :solr_search unless method_defined? :search
    alias_method :search_ids, :solr_search_ids unless method_defined? :search_ids
    alias_method :remove_all_from_index, :solr_remove_all_from_index unless method_defined? :remove_all_from_index
    alias_method :remove_all_from_index!, :solr_remove_all_from_index! unless method_defined? :remove_all_from_index!
    alias_method :reindex, :solr_reindex unless method_defined? :reindex
    alias_method :index, :solr_index unless method_defined? :index
    alias_method :index_orphans, :solr_index_orphans unless method_defined? :index_orphans
    alias_method :clean_index_orphans, :solr_clean_index_orphans unless method_defined? :clean_index_orphans
  end
end

Instance Method Details

- (Boolean) searchable?

Classes that have been defined as searchable return true for this method.

Returns

true

Returns:

  • (Boolean) 


287
288
289
 
# File 'lib/sunspot_activerecord/searchable.rb', line 287

def searchable?
  true
end

- (Object) solr_clean_index_orphans

Find IDs of records of this class that are indexed in Solr but do not exist in the database, and remove them from Solr. Under normal circumstances, this should not be necessary; this method is provided in case something goes wrong.



271
272
273
274
275
276
277
 
# File 'lib/sunspot_activerecord/searchable.rb', line 271

def solr_clean_index_orphans
  solr_index_orphans.each do |id|
    new do |fake_instance|
      fake_instance.id = id
    end.solr_remove_from_index
  end
end

- (Object) solr_execute_search(options = {}) 



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/sunspot_activerecord/searchable.rb', line 291

def solr_execute_search(options = {})
  options.assert_valid_keys(:include, :select)
  search = yield
  unless options.empty?
    search.build do |query|
      if options[:include]
        query.data_accessor_for(self).include = options[:include]
      end
      if options[:select]
        query.data_accessor_for(self).select = options[:select]
      end
    end
  end
  search.execute
end

- (Object) solr_execute_search_ids(options = {}) 



307
308
309
310
 
# File 'lib/sunspot_activerecord/searchable.rb', line 307

def solr_execute_search_ids(options = {})
  search = yield
  search.raw_results.map { |raw_result| raw_result.primary_key.to_i }
end

- (Object) solr_index(opts = {})

Add/update all existing records in the Solr index. The batch_size argument specifies how many records to load out of the database at a time. The default batch size is 50; if nil is passed, records will not be indexed in batches. By default, a commit is issued after each batch; passing false for batch_commit will disable this, and only issue a commit at the end of the process. If associated objects need to indexed also, you can specify include in format accepted by ActiveRecord to improve your sql select performance

Options (passed as a hash)

batch_size<Integer>

Batch size with which to load records. Passing 'nil' will skip batches. Default is 50.

batch_commit<Boolean>

Flag signalling if a commit should be done after after each batch is indexed, default is 'true'

include<Mixed>

include option to be passed to the ActiveRecord find, used for including associated objects that need to be indexed with the parent object, accepts all formats ActiveRecord::Base.find does

first_id

The lowest possible ID for this class. Defaults to 0, which is fine for integer IDs; string primary keys will need to specify something reasonable here.

Examples

# index in batches of 50, commit after each
Post.index

# index all rows at once, then commit
Post.index(:batch_size => nil)

# index in batches of 50, commit when all batches complete
Post.index(:batch_commit => false)

# include the associated +author+ object when loading to index
Post.index(:include => :author)


223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/sunspot_activerecord/searchable.rb', line 223

def solr_index(opts={})
  options = {
    :batch_size => 50,
    :batch_commit => true,
    :include => self.sunspot_options[:include],
    :first_id => 0
  }.merge(opts)

  if options[:batch_size]
    counter = 0
    find_in_batches(:include => options[:include], :batch_size => options[:batch_size]) do |records|
      #solr_benchmark options[:batch_size], counter do
        Sunspot.index(records)
      #end
      Sunspot.commit if options[:batch_commit]
      counter += 1
    end
    Sunspot.commit unless options[:batch_commit]
  else
    Sunspot.index!(all(:include => options[:include]))
  end
end

- (Object) solr_index_orphans

Return the IDs of records of this class that are indexed in Solr but do not exist in the database. Under normal circumstances, this should never happen, but this method is provided in case something goes wrong. Usually you will want to rectify the situation by calling #clean_index_orphans or #reindex

Returns

Array

Collection of IDs that exist in Solr but not in the database



256
257
258
259
260
261
262
263
 
# File 'lib/sunspot_activerecord/searchable.rb', line 256

def solr_index_orphans
  count = self.count
  indexed_ids = solr_search_ids { paginate(:page => 1, :per_page => count) }.to_set
  all(:select => 'id').each do |object|
    indexed_ids.delete(object.id)
  end
  indexed_ids.to_a
end

- (Object) solr_reindex(options = {})

Completely rebuild the index for this class. First removes all instances from the index, then loads records and indexes them.

See #index for information on options, etc.



180
181
182
183
 
# File 'lib/sunspot_activerecord/searchable.rb', line 180

def solr_reindex(options = {})
  solr_remove_all_from_index
  solr_index(options)
end

- (Object) solr_remove_all_from_index

Remove instances of this class from the Solr index.



161
162
163
 
# File 'lib/sunspot_activerecord/searchable.rb', line 161

def solr_remove_all_from_index
  Sunspot.remove_all(self)
end

- (Object) solr_remove_all_from_index!

Remove all instances of this class from the Solr index and immediately commit.



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

def solr_remove_all_from_index!
  Sunspot.remove_all!(self)
end

- (Object) solr_search(options = {}, &block)

Search for instances of this class in Solr. The block is delegated to the Sunspot.search method - see the Sunspot documentation for the full API.

Example

Post.search(:include => [:blog]) do
  keywords 'best pizza'
  with :blog_id, 1
  order :updated_at, :desc
  facet :category_ids
end

Options

:include

Specify associations to eager load

:select

Specify columns to select from database when loading results

Returns

Sunspot::Search

Object containing results, totals, facets, etc.



136
137
138
139
140
 
# File 'lib/sunspot_activerecord/searchable.rb', line 136

def solr_search(options = {}, &block)
  solr_execute_search(options) do
    Sunspot.new_search(self, &block)
  end
end

- (Object) solr_search_ids(&block)

Get IDs of matching results without loading the result objects from the database. This method may be useful if search is used as an intermediate step in a larger find operation. The block is the same as the block provided to the #search method.

Returns

Array

Array of IDs, in the order returned by the search



152
153
154
155
156
 
# File 'lib/sunspot_activerecord/searchable.rb', line 152

def solr_search_ids(&block)
  solr_execute_search_ids do
    solr_search(&block)
  end
end