Class: PEROBS::Store

Inherits:
Object
  • Object
show all
Defined in:
lib/perobs/Store.rb

Overview

PEROBS::Store is a persistent storage system for Ruby objects. Regular Ruby objects are transparently stored in a back-end storage and retrieved when needed. It features a garbage collector that removes all objects that are no longer in use. A build-in cache keeps access latencies to recently used objects low and lazily flushes modified objects into the persistend back-end. The default back-end is a filesystem based database. Alternatively, an Amazon DynamoDB can be used as well. Adding support for other key/value stores is fairly trivial to do. See PEROBS::DynamoDB for an example

Persistent objects must be defined by deriving your class from PEROBS::Object, PERBOS::Array or PEROBS::Hash. Only instance variables that are declared via po_attr will be persistent. It is recommended that references to other objects are all going to persistent objects again. TO create a new persistent object you must call Store.new(). Don’t use the constructors of persistent classes directly. Store.new() will return a proxy or delegator object that can be used like the actual object. By using delegators we can disconnect the actual object from the delegator handle.

require ‘perobs’

class Person < PEROBS::Object

po_attr :name, :mother, :father, :kids

def initialize(store, name)
  super
  attr_init(:name, name)
  attr_init(:kids, @store.new(PEROBS::Array))
end

def to_s
  "#{@name} is the child of #{self.mother ? self.mother.name : 'unknown'} " +
  "and #{self.father ? self.father.name : 'unknown'}.
end

end

store = PEROBS::Store.new(‘family’) store = joe = store.new(Person, ‘Joe’) store = jane = store.new(Person, ‘Jane’) jim = store.new(Person, ‘Jim’) jim.father = joe joe.kids << jim jim.mother = jane jane.kids << jim store.sync

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data_base, options = {}) ⇒ Store

Create a new Store.

Parameters:

  • data_base (String) —

    the name of the database

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

    various options to affect the operation of the database. Currently the following options are supported: :engine : The class that provides the back-end storage

    engine. By default BTreeDB is used. A user
can provide it's own storage engine that must
conform to the same API exposed by BTreeBlobsDB.

    :cache_bits : the number of bits used for cache indexing. The

    cache will hold 2 to the power of bits number of
objects. We have separate caches for reading and
writing. The default value is 16. It probably makes
little sense to use much larger numbers than that.

    :serializer : select the format used to serialize the data. There

    are 3 different options:
:marshal : Native Ruby serializer. Fastest option
that can handle most Ruby data types. Big
disadvantate is the stability of the format. Data
written with one Ruby version may not be readable
with another version.
:json : About half as fast as marshal, but the
format is rock solid and portable between
languages. It only supports basic Ruby data types
like String, Fixnum, Float, Array, Hash. This is
the default option.
:yaml : Can also handle most Ruby data types and is
portable between Ruby versions (1.9 and later).
Unfortunately, it is 10x slower than marshal.



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/perobs/Store.rb', line 122

def initialize(data_base, options = {})
  # Create a backing store handler
  @db = (options[:engine] || BTreeDB).new(data_base, options)
  # Create a map that can translate classes to numerical IDs and vice
  # versa.
  @class_map = ClassMap.new(@db)
  # This flag is used to check that PEROBS objects are only created via
  # the Store.new() call by PEROBS users.
  @object_creation_in_progress = false

  # List of PEROBS objects that are currently available as Ruby objects
  # hashed by their ID.
  @in_memory_objects = {}

  # The Cache reduces read and write latencies by keeping a subset of the
  # objects in memory.
  @cache = Cache.new(options[:cache_bits] || 16)

  # The named (global) objects IDs hashed by their name
  unless (@root_objects = object_by_id(0))
    # The root object hash always has the object ID 0.
    @root_objects = _construct_po(Hash, 0)
    # The ID change removes it from the write cache. We need to add it
    # again.
    @cache.cache_write(@root_objects)
  end
end

Instance Attribute Details

#cache ⇒ Object (readonly)

Returns the value of attribute cache.



92
93
94
 
# File 'lib/perobs/Store.rb', line 92

def cache
  @cache
end

#class_map ⇒ Object (readonly)

Returns the value of attribute class_map.



92
93
94
 
# File 'lib/perobs/Store.rb', line 92

def class_map
  @class_map
end

#db ⇒ Object (readonly)

Returns the value of attribute db.



92
93
94
 
# File 'lib/perobs/Store.rb', line 92

def db
  @db
end

#object_creation_in_progress ⇒ Object (readonly)

Returns the value of attribute object_creation_in_progress.



92
93
94
 
# File 'lib/perobs/Store.rb', line 92

def object_creation_in_progress
  @object_creation_in_progress
end

Instance Method Details

#[](name) ⇒ Object

Return the object with the provided name.

Parameters:

  • name (Symbol) —

    A Symbol specifies the name of the object to be returned.

Returns:

  • The requested object or nil if it doesn’t exist.



222
223
224
225
226
227
 
# File 'lib/perobs/Store.rb', line 222

def [](name)
  # Return nil if there is no object with that name.
  return nil unless (id = @root_objects[name])

  POXReference.new(self, id)
end

#[]=(name, obj) ⇒ PEROBS::Object

Store the provided object under the given name. Use this to make the object a root or top-level object (think global variable). Each store should have at least one root object. Objects that are not directly or indirectly reachable via any of the root objects are no longer accessible and will be garbage collected.

Parameters:

  • name (Symbol) —

    The name to use.

  • obj (PEROBS::Object) —

    The object to store

Returns:



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/perobs/Store.rb', line 194

def []=(name, obj)
  # If the passed object is nil, we delete the entry if it exists.
  if obj.nil?
    @root_objects.delete(name)
    return nil
  end

  # We only allow derivatives of PEROBS::Object to be stored in the
  # store.
  unless obj.is_a?(ObjectBase)
    raise ArgumentError, 'Object must be of class PEROBS::Object but ' +
                         "is of class #{obj.class}"
  end

  unless obj.store == self
    raise ArgumentError, 'The object does not belong to this store.'
  end

  # Store the name and mark the name list as modified.
  @root_objects[name] = obj._id

  obj
end

#_collect(id, ignore_errors = false) ⇒ Object

Remove the object from the in-memory list. This is an internal method and should never be called from user code.

Parameters:

  • id (Fixnum or Bignum) —

    Object ID of object to remove from the list



376
377
378
379
380
381
 
# File 'lib/perobs/Store.rb', line 376

def _collect(id, ignore_errors = false)
  unless ignore_errors || @in_memory_objects.include?(id)
    raise RuntimeError, "Object with id #{id} is currently not in memory"
  end
  @in_memory_objects.delete(id)
end

#_construct_po(klass, id, *args) ⇒ BasicObject

For library internal use only! This method will create a new PEROBS object.

Parameters:

  • klass (BasicObject) —

    Class of the object to create

  • id (Fixnum, Bignum or nil) —

    Requested object ID or nil

  • *args (Array) —

    Arguments to pass to the object constructor.

Returns:

  • (BasicObject) —

    Newly constructed PEROBS object



167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/perobs/Store.rb', line 167

def _construct_po(klass, id, *args)
  unless klass.is_a?(BasicObject)
    raise ArgumentError, "#{klass} is not a BasicObject derivative"
  end
  @object_creation_in_progress = true
  obj = klass.new(self, *args)
  @object_creation_in_progress = false
  # If a specific object ID was requested we need to set it now.
  obj._change_id(id) if id
  obj
end

#_new_id ⇒ Fixnum or Bignum

Internal method. Don’t use this outside of this library! Generate a new unique ID that is not used by any other object. It uses random numbers between 0 and 2**64 - 1.

Returns:

  • (Fixnum or Bignum) 


351
352
353
354
355
356
357
358
359
360
 
# File 'lib/perobs/Store.rb', line 351

def _new_id
  begin
    # Generate a random number. It's recommended to not store more than
    # 2**62 objects in the same store.
    id = rand(2**64)
    # Ensure that we don't have already another object with this ID.
  end while @in_memory_objects.include?(id) || @db.include?(id)

  id
end

#_register_in_memory(obj, id) ⇒ Object

Internal method. Don’t use this outside of this library! Add the new object to the in-memory list. We only store a weak reference to the object so it can be garbage collected. When this happens the object finalizer is triggered and calls _forget() to remove the object from this hash again.

Parameters:

  • obj (BasicObject) —

    Object to register

  • id (Fixnum or Bignum) —

    object ID



369
370
371
 
# File 'lib/perobs/Store.rb', line 369

def _register_in_memory(obj, id)
  @in_memory_objects[id] = WeakRef.new(obj)
end

#check(repair = true) ⇒ Fixnum

This method can be used to check the database and optionally repair it. The repair is a pure structural repair. It cannot ensure that the stored data is still correct. E. g. if a reference to a non-existing or unreadable object is found, the reference will simply be deleted.

Parameters:

  • repair (TrueClass/FalseClass) (defaults to: true) —

    true if a repair attempt should be made.

Returns:

  • (Fixnum) —

    The number of references to bad objects found.



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/perobs/Store.rb', line 285

def check(repair = true)
  # All objects must have in-db version.
  sync
  # Run basic consistency checks first.
  @db.check_db(repair)

  # We will use the mark to mark all objects that we have checked already.
  # Before we start, we need to clear all marks.
  @db.clear_marks

  errors = 0
  @root_objects.each do |name, id|
    errors += check_object(id, repair)
  end
  @root_objects.delete_if { |name, id| !@db.check(id, false) }

  errors
end

#delete_store ⇒ Object

Delete the entire store. The store is no longer usable after this method was called.



181
182
183
184
 
# File 'lib/perobs/Store.rb', line 181

def delete_store
  @db.delete_database
  @db = @class_map = @cache = @root_objects = nil
end

#each ⇒ Object

Calls the given block once for each object, passing that object as a parameter.



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/perobs/Store.rb', line 323

def each
  @db.clear_marks
  # Start with the object 0 and the indexes of the root objects. Push them
  # onto the work stack.
  stack = [ 0 ] + @root_objects.values
  stack.each { |id| @db.mark(id) }
  while !stack.empty?
    # Get an object index from the stack.
    obj = object_by_id(id = stack.pop)
    yield(POXReference.new(self, id)) if block_given?
    obj._referenced_object_ids.each do |id|
      unless @db.is_marked?(id)
        @db.mark(id)
        stack << id
      end
    end
  end
end

#gc ⇒ Fixnum

Discard all objects that are not somehow connected to the root objects from the back-end storage. The garbage collector is not invoked automatically. Depending on your usage pattern, you need to call this method periodically.

Returns:

  • (Fixnum) —

    The number of collected objects



243
244
245
246
247
 
# File 'lib/perobs/Store.rb', line 243

def gc
  sync
  mark
  sweep
end

#new(klass, *args) ⇒ POXReference

You need to call this method to create new PEROBS objects that belong to this Store.

Parameters:

  • klass (Class) —

    The class of the object you want to create. This must be a derivative of ObjectBase.

  • *args —

    Optional list of other arguments that are passed to the constructor of the specified class.

Returns:

  • (POXReference) —

    A reference to the newly created object.



157
158
159
 
# File 'lib/perobs/Store.rb', line 157

def new(klass, *args)
  _construct_po(klass, nil, *args).myself
end

#object_by_id(id) ⇒ Object

Return the object with the provided ID. This method is not part of the public API and should never be called by outside users. It’s purely intended for internal use.



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/perobs/Store.rb', line 252

def object_by_id(id)
  if (obj = @in_memory_objects[id])
    # We have the object in memory so we can just return it.
    begin
      return obj.__getobj__
    rescue WeakRef::RefError
      # Due to a race condition the object can still be in the
      # @in_memory_objects list but has been collected already by the Ruby
      # GC. In that case we need to load it again.
    end
  end

  # We don't have the object in memory. Let's find it in the storage.
  if @db.include?(id)
    # Great, object found. Read it into memory and return it.
    obj = ObjectBase::read(self, id)
    # Add the object to the in-memory storage list.
    @cache.cache_read(obj)

    return obj
  end

  # The requested object does not exist. Return nil.
  nil
end

#rename_classes(rename_map) ⇒ Object

Rename classes of objects stored in the data base.

Parameters:

  • rename_map (Hash) —

    Hash that maps the old name to the new name



344
345
346
 
# File 'lib/perobs/Store.rb', line 344

def rename_classes(rename_map)
  @class_map.rename(rename_map)
end

#statistics ⇒ Object

This method returns a Hash with some statistics about this store.



384
385
386
387
388
389
 
# File 'lib/perobs/Store.rb', line 384

def statistics
  {
    :in_memory_objects => @in_memory_objects.length,
    :root_objects => 0 #@root_objects.length
  }
end

#sync ⇒ Object

Flush out all modified objects to disk and shrink the in-memory list if needed.



231
232
233
234
235
236
 
# File 'lib/perobs/Store.rb', line 231

def sync
  if @cache.in_transaction?
    raise RuntimeError, 'You cannot call sync during a transaction'
  end
  @cache.flush
end

#transaction ⇒ Object

This method will execute the provided block as an atomic transaction regarding the manipulation of all objects associated with this Store. In case the execution of the block generates an exception, the transaction is aborted and all PEROBS objects are restored to the state at the beginning of the transaction. The exception is passed on to the enclosing scope, so you probably want to handle it accordingly.



310
311
312
313
314
315
316
317
318
319
 
# File 'lib/perobs/Store.rb', line 310

def transaction
  @cache.begin_transaction
  begin
    yield if block_given?
  rescue => e
    @cache.abort_transaction
    raise e
  end
  @cache.end_transaction
end