biiwide.kvdb.protocols — biiwide/kvdb-api 0.1.3

KVDBable clj protocol

The KVDBable protocol is supported by types that can be coerced into a KVDB instance.

to-kvdb clj

(to-kvdb x)

Convert a supported KVDB type into a full KVDB instance.

KVDBEntry clj protocol

All records returned by KVDB functions will satisfy the KVDBEntry protocol.

entry? clj

(entry? x)

key clj

(key entry)

revision clj

(revision entry)

value clj

(value entry)

MutableKVDB clj protocol

The KVDB protocol defines common operations for mutable key/value databases.

create! clj

(create! kvdb key value)

Creates an entry in the database. Throws an exception when the key is already present. Returns the new entry.

mutable-kvdb? clj

(mutable-kvdb? x)

Test if a value supports the MutableKVDB protocol.

remove! clj

(remove! kvdb key revision)

Removes an entry from the database. Asserts the entry's revision matches the provided revision. Returns the final state of the entry.

replace! clj

(replace! kvdb key revision new-value)

Replaces the value of an entry in the database with a new value. Asserts the entry's revision matches the provided revision. Returns the new state of the entry.

OverridableKVDB clj protocol

The OverridableKVDB protocol provides support for overriding protocol implementations on a KVDB instance.

overridable-kvdb? clj

(overridable-kvdb? x)

Test if a value supports the OverridableKVDB protocol.

overridden clj

(overridden kvdb)

Return a map of all overridden KVDB methods on a KVDB instance.

pop-overrides clj

(pop-overrides kvdb)

Remove the prior set of overridden methods from an OverridableKVDB.

push-overrides clj

(push-overrides kvdb implementations-map)

Overlay a set of overriden KVDB protocol methods on a KVDB instance.

PageableKVDB clj protocol

The PageableKVDB protocol provides a resumable mechanism for retrieving pages of database entries.

page clj

(page kvdb starting-key limit)

Returns a page of up to 'limit results starting from 'starting-key inclusively.

pageable-kvdb? clj

(pageable-kvdb? x)

Test if a value supports the PageableKVDB protocol.

ReadableKVDB clj protocol

The KVDB protocol defines common operations for key/value databases.

entries clj

(entries kvdb)

Returns a sequence of all key/value entries in the databse. Will only throw exceptions when unable to communicate wth the database.

fetch clj

(fetch kvdb k missing-value)

Retrieves the entry for a key from the database. Returns 'misising-value when the key is not present. Will only throw exceptions when unable to communicate with the database.

readable-kvdb? clj

(readable-kvdb? x)

Test if a value supports the ReadableKVDB protocol.