Class Rddb::DocumentStore::Base
In: lib/rddb/document_store.rb
Parent: Object

Base class for document storage engines.

Methods

Included Modules

Enumerable

Public Instance methods

The number of documents in the data store

[Source]

    # File lib/rddb/document_store.rb, line 31
31:       def count
32:         raise_abstract_error('count')
33:       end

Delete the document.

[Source]

    # File lib/rddb/document_store.rb, line 21
21:       def delete(id)
22:         raise_abstract_error('delete')
23:       end

Yield each document from the data store to the given block. You may specify the partition to limit the data extraction to a single partition.

[Source]

    # File lib/rddb/document_store.rb, line 38
38:       def each(partition=nil, &block)
39:         raise_abstract_error('each')
40:       end

Yield each partition name

[Source]

    # File lib/rddb/document_store.rb, line 43
43:       def each_partition(&block)
44:         raise_abstract_error('each_partition')
45:       end

Return true if the document exists.

[Source]

    # File lib/rddb/document_store.rb, line 26
26:       def exists?(id)
27:         raise_abstract_error('exists?')
28:       end

Find the document.

[Source]

    # File lib/rddb/document_store.rb, line 11
11:       def find(id)
12:         raise_abstract_error('find')
13:       end

Store the document.

[Source]

    # File lib/rddb/document_store.rb, line 16
16:       def store(document)
17:         raise_abstract_error('store')
18:       end

Return true if the datastore supports partitioning

[Source]

    # File lib/rddb/document_store.rb, line 48
48:       def supports_partitioning?
49:         false
50:       end

Trigger indexes to be stored if necessary. Default implementation is a no-op.

[Source]

    # File lib/rddb/document_store.rb, line 54
54:       def write_indexes
55:       end

[Validate]