Liking cljdoc? Tell your friends :D
All platforms.

compound.core

add-itemsclj/s

(add-items compound items)

Adds the given items to the compound, cascading the additions to the secondary indexes. If the key exists, handle the conflict as specified in the primary index definition.

Adds the given items to the compound, cascading the additions to the secondary indexes.
If the key exists, handle the conflict as specified in the primary index definition.
raw docstring

add-secondary-indexclj/s

(add-secondary-index compound index-def)

Adds an additional secondary index to an existing compound. Throws if there is there is a conflict on the index id.

Adds an additional secondary index to an existing compound.
Throws if there is there is a conflict on the index id.
raw docstring

apply-diffclj/s

(apply-diff c diff)

clearclj/s

(clear compound)

Clear a compound of data

Clear a compound of data
raw docstring

compoundclj/s

(compound opts)

compound-specclj/smultimethod

diffclj/s

(diff source target)

Returns a diff which will provide the information required to turn the source compound into the target compound, so that source can be turned into target in the following format.

{:inserts ... items that exist only in source, and not in target :updates {:source ... :target ...} source and target items that exist in source and target, but are different :deletes ... items that exist in target, but not in source

This is useful when e.g. syncing a compound with an external mutable datastructure

Returns a diff which will provide the information required to turn the _source_ compound into the _target_ compound,
so that source can be turned into target  in the following format.

{:inserts ... items that exist only in source, and not in target
 :updates {:source ... :target ...} source and target items that exist in source and target, but are different
 :deletes ... items that exist in target, but not in source

This is useful when e.g. syncing a compound with an external mutable datastructure
raw docstring

empty-compoundclj/s

(empty-compound opts)

idclj/s

(id index-def)

indexclj/s

(index compound id)

index-defclj/s

(index-def compound id)

index-defs-by-idclj/s

(index-defs-by-id compound)

indexes-by-idclj/s

(indexes-by-id compound)

itemsclj/s

(items compound)

Returns the items indexed by the compound

Returns the items indexed by the compound
raw docstring

primary-indexclj/s

(primary-index compound)

primary-index-defclj/s

(primary-index-def compound)

primary-index-defaultsclj/s

primary-index-fnclj/s

(primary-index-fn compound)

primary-index-idclj/s

(primary-index-id compound)

remove-keysclj/s

(remove-keys compound ks)

Remove items from the compound with the given primary keys

Remove items from the compound with the given primary keys
raw docstring

remove-secondary-indexclj/s

(remove-secondary-index compound id)

Remove the secondary index with the provided id from the compound

Remove the secondary index with the provided id from the compound
raw docstring

secondary-indexclj/s

(secondary-index compound id)

secondary-index-defclj/s

(secondary-index-def compound id)

secondary-index-defaultsclj/s

secondary-index-defs-by-idclj/s

(secondary-index-defs-by-id compound)

secondary-indexes-by-idclj/s

(secondary-indexes-by-id compound)

set-primary-indexclj/s

(set-primary-index compound primary-index)

set-secondary-index-defs-by-idclj/s

(set-secondary-index-defs-by-id compound secondary-index-defs-by-id)

set-secondary-indexes-by-idclj/s

(set-secondary-indexes-by-id compound secondary-indexes-by-id)

structureclj/s

(structure compound)

update-itemclj/s

(update-item compound k f)
(update-item compound k f & args)

Update the item with the given primary key, cascading updates to the secondary indexes

Update the item with the given primary key, cascading updates to the secondary indexes
raw docstring

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

Keyboard shortcutsReport a problemcljdoc on GitHub
× close