lambdaroyal.memory.core.tx — org.clojars.gixxi/lambdaroyal-memory 1.0.2

*alter-context* clj

*gtid* clj

alter-document clj

(alter-document tx coll-name user-scope-tuple fn & args)

alters a document given by [user-scope-tuple] within the collection denoted by [coll-name] by applying the function [fn] with the parameters [args] to it. An user-scope-tuple can be obtained using find-first, find and select. returns the new user value

applicable-indexes clj

(applicable-indexes coll key)

applicable-indexes' clj

(applicable-indexes' tx coll key)

checks whether collection :coll within the context of a transaction :tx provides an applicable attribute index for the attribute seq :key

coll-count clj

(coll-count tx coll-name)

returns the number of elements in a collection with name [coll-name]

coll-empty? clj

(coll-empty? tx coll-name)

returns true iff the collection with name [coll-name] is empty

Constraint clj protocol

application clj

(application this)

returns a set of database actions this constraint type is relevant for

postcommit clj

(postcommit this ctx coll application coll-tuple)

This function gets called after a key/value pair is inserted to/updated within a collection. Constraint like indexes implement this for the update of the very index after the update to the key/value pair data structure took place

precommit clj

(precommit this ctx coll application key value)

This function gets called before a key/value pair is inserted to/updated within a collection. Implementing this function if a necessary precondition needs to be checked before performing an costly update to the underlying datastructure holding the key/value pair. Implementations should raise. Here ctx aims to handle constraint to need to check on other collections as well

constraint-appl-domain clj

donotes database actions suitable for certain types of domains

contains-key? clj

(contains-key? coll key)

returns true iff the collection [coll] contains a tuple whose key is equal to the user key [key].

create-attribute-index clj

(create-attribute-index name unique a)

creates an attribute index for attributes a

create-constraint-exception clj

(create-constraint-exception coll key msg)

create-no-applicable-index-exception clj

(create-no-applicable-index-exception coll key)

create-referenced-integrity-constraint clj

(create-referenced-integrity-constraint name referencing-coll referencing-key)

create-referrer-integrity-constraint clj

(create-referrer-integrity-constraint name foreign-coll foreign-key)

create-tx clj

(create-tx ctx & opts)

creates a transaction upon user-scope function like select, insert, alter-document, delete can be executed. Iff an eviction channel is assigned to a collection then this channel needs to be started otherwise a

create-unique-key clj

(create-unique-key key)

(create-unique-key coll key)

creates a unique key [key running] from a user space key using the running bigint index

create-unique-key-constraint clj

(create-unique-key-constraint)

create-unique-stop-key clj

(create-unique-stop-key key)

creates a unique key [key running] that can be used for < and <= comparator

debug clj

decorate-coll-with-gtid clj

(decorate-coll-with-gtid coll gtid)

decorate-with-gtid clj

(decorate-with-gtid val)

delete clj

(delete tx coll-name key)

deletes a document by key [key] from collection with name [coll-name] using the transaction [tx]. the transaction can be created from context using (create-tx [context]. returns number of removed items.

find-first clj

(find-first coll key)

returns the first collection tuple whose key is equal to the user key [key]. This is not a userscope method.

get-gtid clj

(get-gtid)

gtid clj

gtid-dosync clj macro

(gtid-dosync & body)

Index clj protocol

applicable? clj

(applicable? this key)

return true iff this index can be used to find values as per the given key.

find clj

(find this start-test start-key stop-test stop-key)

takes all values from the collection using this index that fulfil (start-test start-key) until the collection is fully realized or (stop-test stop-key) is fulfilled. start-test as well as stop-test are of >,>=,<,<=. The returning sequence contains of items [[uk i] (ref v)], where uk is the user-key, i is the running index for the collection and (ref v) denotes a STM reference type instance to the value v

find-without-stop clj

(find-without-stop this start-test start-key)

takes all values from the collection using this index that fulfil (start-test start-key) until the collection is fully realized. start-test is of >,>=,<,<=. The returning sequence contains of items [[uk i] (ref v)], where uk is the user-key, i is the running index for the collection and (ref v) denotes a STM reference type instance to the value v

rating clj

(rating this key)

returns a natural number denoting an order by which two indexes can be compared in order to use one for a finding a certain key. the index with the lower rating result wins

insert clj

(insert tx coll-name key value)

inserts a document [value] by key [key] into collection with name [coll-name] using the transaction [tx]. the transaction can be created from context using (create-tx [context])

insert-raw clj

(insert-raw tx coll-name key value)

ONLY FOR INTERNAL PURPOSE

process-constraints clj

(process-constraints application f ctx coll & attr)

select clj

(select tx coll-name)

(select tx coll-name start-test start-key)

(select tx coll-name attributes start-test start-key)

(select tx coll-name start-test start-key stop-test stop-key)

(select tx coll-name attributes start-test start-key stop-test stop-key)

test(s) one of <, <=, > or

=. Returns a seq of those entries [key, value] with keys ek for which (test (.. sc comparator (compare ek key)) 0) is true. iff just [tx] and coll-name are given, then we return all tupels.

select-first clj

(select-first tx coll-name key)

returns the first key/value pair of the collection [coll-name] that matches the key [key] or nil

select-from-coll clj

(select-from-coll coll attributes start-test start-key)

(select-from-coll coll attributes start-test start-key stop-test stop-key)

tree clj

(tree tx coll-name user-scope-tuple & opts)

takes a document [user-scope-tuple] from the collection with name [coll-name] and gives back derived document where all foreign keys are replaced by their respective documents.

tree-referencees clj

(tree-referencees tx coll-name user-scope-tuple & opts)

takes a document [user-scope-tuple] from the collection with name [coll-name] and gives back a hash-map denoting all foreign-key referenced documents. The key in hash-map is [coll-name user-scope-key].

user-scope-key clj

(user-scope-key user-scope-tuple)

takes a user-scope-tuple into account and returns the user scope key that was provided when storing this document

user-scope-tuple clj

(user-scope-tuple [k r])

within a collection a key-value-pair consists of k -> r, where k is [uk i], r is a STM reference to document v, uk is the key the user used to store document v. i is a running index that allows the uk being non-unique with respect to the collection. since v is wrapped by an STM reference we provide back the raw value v in order to prevent the user from altering the value using STM mechanism directly, since this would bypass the secondary indexes and make them invalid.