Liking cljdoc? Tell your friends :D

xitdb.db


*return-history?*clj

source

append-context!clj

(append-context! history slot fn)

Appends a new history context and calls fn with a write cursor. Returns the new history index.

Appends a new history context and calls `fn` with a write cursor.
Returns the new history index.
sourceraw docstring

db-historyclj

(db-history db)
source

history-indexclj

(history-index xdb)

Returns the current size of the transaction history array.

Returns the current size of the transaction history array.
sourceraw docstring

materializeclj

source

open-databaseclj

(open-database filename open-mode)

Opens database filename. If filename is :memory, returns a memory based db. open-mode can be r or rw.

Opens database `filename`.
If `filename` is `:memory`, returns a memory based db.
open-mode can be `r` or `rw`.
sourceraw docstring

read-historyclj

(read-history db)

Returns the read only transaction history array.

Returns the read only transaction history array.
sourceraw docstring

v->slot!clj

(v->slot! cursor v)

Converts a value to a slot which can be written to a cursor. For XITDB* types (which support ISlot), will return -slot, for all other types conversion/v->slot!

Converts a value to a slot which can be written to a cursor.
For XITDB* types (which support ISlot), will return `-slot`,
for all other types `conversion/v->slot!`
sourceraw docstring

xit-dbclj

(xit-db filename)

Returns a new XITDBDatabase which can be used to query and transact data. filename can be :memory or the name of a file on the filesystem. If the file does not exist, it will be created. The returned database handle can be used from multiple threads. Reads can run in parallel, transactions (eg. swap!) will only allow one writer at a time.

Returns a new XITDBDatabase which can be used to query and transact data.
`filename` can be `:memory` or the name of a file on the filesystem.
If the file does not exist, it will be created.
The returned database handle can be used from multiple threads.
Reads can run in parallel, transactions (eg. `swap!`) will only allow one writer at a time.
sourceraw docstring

xitdb-reset!clj

(xitdb-reset! history new-value)

Sets the value of the database to new-value. Returns new history index.

Sets the value of the database to `new-value`.
Returns new history index.
sourceraw docstring

xitdb-swap!clj

(xitdb-swap! db f & args)

Starts a new transaction and calls f with the value at root. f will receive a XITDBWrite* type (db) and args. Actions on the XITDBWrite* type (like assoc) will mutate it. Return value of f is written at (root) cursor. Returns the transaction history index.

Starts a new transaction and calls `f` with the value at root.
`f` will receive a XITDBWrite* type (db) and `args`.
Actions on the XITDBWrite* type (like `assoc`) will mutate it.
Return value of `f` is written at (root) cursor.
Returns the transaction history index.
sourceraw docstring

xitdb-swap-with-lock!clj

(xitdb-swap-with-lock! xitdb f & args)

Performs the 'swap!' operation while locking db.lock. Returns the new value of the database. If the binding *return-history?* is true, returns [current-history-index db-before db-after].

Performs the 'swap!' operation while locking `db.lock`.
Returns the new value of the database.
If the binding `*return-history?*` is true, returns
`[current-history-index db-before db-after]`.
sourceraw docstring

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

× close