Liking cljdoc? Tell your friends :D

biiwide.kvdb.protocols


KVDBableprotocol

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

The KVDBable protocol is supported by types that can be coerced into
a KVDB instance.
to-kvdb
(to-kvdb x)

Convert a supported KVDB type into a full KVDB instance.

Convert a supported KVDB type into a full KVDB instance.

raw docstring

KVDBEntryprotocol

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

All records returned by KVDB functions will satisfy the KVDBEntry protocol.
entry?
(entry? x)
key
(key entry)
revision
(revision entry)
value
(value entry)
raw docstring

MutableKVDBprotocol

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

The KVDB protocol defines common operations for mutable key/value databases.
create!
(create! kvdb key value)

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

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

mutable-kvdb?
(mutable-kvdb? x)

Test if a value supports the MutableKVDB protocol.

Test if a value supports the MutableKVDB protocol.

remove!
(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.

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

replace!
(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.

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.

raw docstring

OverridableKVDBprotocol

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

The OverridableKVDB protocol provides support for overriding protocol implementations on a KVDB instance.
overridable-kvdb?
(overridable-kvdb? x)

Test if a value supports the OverridableKVDB protocol.

Test if a value supports the OverridableKVDB protocol.

overridden
(overridden kvdb)

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

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

pop-overrides
(pop-overrides kvdb)

Remove the prior set of overridden methods from an OverridableKVDB.

Remove the prior set of overridden methods from an OverridableKVDB.

push-overrides
(push-overrides kvdb implementations-map)

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

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

raw docstring

PageableKVDBprotocol

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

The PageableKVDB protocol provides a resumable mechanism for retrieving pages of database entries.
page
(page kvdb starting-key limit)

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

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

pageable-kvdb?
(pageable-kvdb? x)

Test if a value supports the PageableKVDB protocol.

Test if a value supports the PageableKVDB protocol.

raw docstring

ReadableKVDBprotocol

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

The KVDB protocol defines common operations for key/value databases.
entries
(entries kvdb)

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

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

fetch
(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.

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?
(readable-kvdb? x)

Test if a value supports the ReadableKVDB protocol.

Test if a value supports the ReadableKVDB protocol.

raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close