Package bw :: Package poseidon :: Module indexocean :: Class IndexedOcean

Class IndexedOcean

 object --+    
          |    
ocean.Ocean --+
              |
             IndexedOcean

This class wraps around a regular ocean instance and manages multiple indexes (based on key-types) and makes available functions which take advantage of the indexes.

This frees Poseidon from actually handling index specific activities.

This class takes care of all issues pertaining to transactioning to make sure that Poseidon doesn't have to worry about it

Instance Methods

__init__(self, fn, options)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

flush_index(self)

create_index(self)

load_index(self, _index_io)

pack(self)

commit(self)

__getslice__(self, i, j)
Do a range search using the OOBTree

evaluate(self, expression)
Evaluate the expression and return all values in this object where the keys match the expression

rexsearch(self, pattern)
Do a regular expression search based on the pattern

Inherited from ocean.Ocean: __contains__, __getitem__, __iter__, __len__, __repr__, __setitem__, begin_transaction, clean_index, clear, close, generate_header, get, has_key, keys, process_options, put, read, read_header, rollback, setdefault

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __str__

Properties
Inherited from `object`: `__class__`

Method Details

init(self, fn, options)
(Constructor)

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__: (inherited documentation)