Class: XapianDb::IndexWriters::TransactionalWriter

Inherits:
Object
  • Object
show all
Defined in:
lib/xapian_db/index_writers/transactional_writer.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ TransactionalWriter

Constructor



16
17
18
19
 
# File 'lib/xapian_db/index_writers/transactional_writer.rb', line 16

def initialize
  @index_requests  = []
  @delete_requests = []
end

Instance Attribute Details

#delete_requests ⇒ Object (readonly)

Returns the value of attribute delete_requests.



13
14
15
 
# File 'lib/xapian_db/index_writers/transactional_writer.rb', line 13

def delete_requests
  @delete_requests
end

#index_requests ⇒ Object (readonly)

Returns the value of attribute index_requests.



13
14
15
 
# File 'lib/xapian_db/index_writers/transactional_writer.rb', line 13

def index_requests
  @index_requests
end

Instance Method Details

#commit_using(writer) ⇒ Object

Commit all pending changes to the database

Parameters:



43
44
45
46
47
 
# File 'lib/xapian_db/index_writers/transactional_writer.rb', line 43

def commit_using(writer)
  @index_requests.each { |obj| writer.index obj, false }
  @delete_requests.each { |xapian_id| writer.delete_doc_with xapian_id, false }
  XapianDb.database.commit
end

#delete_doc_with(xapian_id, commit = false) ⇒ Object

Remove a document from the index

Parameters:

  • xapian_id (String) —

    The document id



29
30
31
 
# File 'lib/xapian_db/index_writers/transactional_writer.rb', line 29

def delete_doc_with(xapian_id, commit=false)
  @delete_requests << xapian_id
end

#index(obj, commit = false, changed_attrs: []) ⇒ Object

Update an object in the index

Parameters:

  • obj (Object) —

    An instance of a class with a blueprint configuration



23
24
25
 
# File 'lib/xapian_db/index_writers/transactional_writer.rb', line 23

def index(obj, commit=false, changed_attrs: [])
  @index_requests << obj
end

#reindex_class(klass, options = {}) ⇒ Object

Reindex all objects of a given class

Parameters:

  • klass (Class) —

    The class to reindex

  • options (Hash) (defaults to: {}) —

    Options for reindexing

Options Hash (options):

  • :verbose (Boolean) — default: false —

    Should the reindexing give status informations?



37
38
39
 
# File 'lib/xapian_db/index_writers/transactional_writer.rb', line 37

def reindex_class(klass, options={})
  raise "rebuild_xapian_index is not supported in transactions"
end