Liking cljdoc? Tell your friends :D

corium.api.async

Asynchronous JVM Clojure API for Corium.

Operations backed by CompletableFuture return a one-shot core.async channel. A successful channel yields its value; a failed channel yields the Throwable. Successful nil results close without yielding a value. Use <? in a go block to rethrow failures.

Boundary values are recursively translated between ordinary Clojure data and the Java client's Keyword, Symbol, EdnList, and Tagged representations.

Asynchronous JVM Clojure API for Corium.

Operations backed by CompletableFuture return a one-shot core.async channel.
A successful channel yields its value; a failed channel yields the Throwable.
Successful nil results close without yielding a value. Use `<?` in a go block
to rethrow failures.

Boundary values are recursively translated between ordinary Clojure data and
the Java client's Keyword, Symbol, EdnList, and Tagged representations.
raw docstring

<?cljmacro

(<? channel)

Takes from channel in a go block and throws a delivered error.

Takes from `channel` in a go block and throws a delivered error.
sourceraw docstring

as-ofclj

(as-of db t)

Derives an as-of database view at transaction t or a java.time.Instant.

Derives an as-of database view at transaction `t` or a java.time.Instant.
sourceraw docstring

available-storage-backendsclj

(available-storage-backends)

Returns the storage backends installed for LocalPeer in this JVM.

Returns the storage backends installed for LocalPeer in this JVM.
sourceraw docstring

basis-tclj

(basis-t db)

Returns a channel yielding the basis transaction of db.

Returns a channel yielding the basis transaction of `db`.
sourceraw docstring

closeclj

(close peer)

Idempotently closes peer.

Idempotently closes `peer`.
sourceraw docstring

connectclj

(connect config)

Connects to a Corium peer and returns a result channel.

Required keys are :peer (:remote or :local) and :db-name. A remote peer also requires :endpoint. A local peer accepts either :endpoint or failover-ordered :endpoints.

Both peer types accept :token, :allow-insecure-token?, :tls-ca, and :tls-domain. Local peers additionally accept :direct-storage, either true or a DirectStorage value.

Connects to a Corium peer and returns a result channel.

Required keys are `:peer` (`:remote` or `:local`) and `:db-name`.
A remote peer also requires `:endpoint`. A local peer accepts either
`:endpoint` or failover-ordered `:endpoints`.

Both peer types accept `:token`, `:allow-insecure-token?`, `:tls-ca`, and
`:tls-domain`. Local peers additionally accept `:direct-storage`, either
true or a DirectStorage value.
sourceraw docstring

databaseclj

(database peer-or-db)

Alias for database-name.

Alias for `database-name`.
sourceraw docstring

database-nameclj

(database-name peer-or-db)

Returns the name of the database connected to peer or represented by db.

Returns the name of the database connected to `peer` or represented by `db`.
sourceraw docstring

datomsclj

(datoms db index)
(datoms db index components)
(datoms db index components limit)

Scans index, optionally beginning with components and capped by limit. Limit 0 requests an unbounded scan.

Scans `index`, optionally beginning with `components` and capped by `limit`.
Limit 0 requests an unbounded scan.
sourceraw docstring

dbclj

(db peer)

Returns a channel yielding the current immutable database value for peer.

Returns a channel yielding the current immutable database value for `peer`.
sourceraw docstring

direct-storageclj

(direct-storage)
(direct-storage cache)

Creates direct-storage configuration, optionally using cache.

Creates direct-storage configuration, optionally using `cache`.
sourceraw docstring

error?clj

(error? value)

Returns true when value is an error delivered by a result channel.

Returns true when `value` is an error delivered by a result channel.
sourceraw docstring

historyclj

(history db)

Derives a history database view.

Derives a history database view.
sourceraw docstring

pullclj

(pull db pattern entity)

Pulls entity using pattern from db.

Pulls `entity` using `pattern` from `db`.
sourceraw docstring

qclj

(q db query & arguments)

Executes query with positional arguments and yields only its value.

Executes `query` with positional `arguments` and yields only its value.
sourceraw docstring

queryclj

(query db query)
(query db query arguments)
(query db query arguments fuel)
(query db query additional-databases arguments fuel)

Executes a query and yields {:shape keyword :value clojure-value}.

arguments and additional-databases are collections. Fuel 0 requests the peer default. Only RemotePeer supports joins across databases.

Executes a query and yields `{:shape keyword :value clojure-value}`.

`arguments` and `additional-databases` are collections. Fuel 0 requests the
peer default. Only RemotePeer supports joins across databases.
sourceraw docstring

segment-cacheclj

(segment-cache directory capacity-bytes)
(segment-cache directory capacity-bytes memory-capacity-bytes)

Creates a SegmentCache. The optional memory capacity 0 uses the engine default.

Creates a SegmentCache. The optional memory capacity 0 uses the engine default.
sourceraw docstring

sinceclj

(since db t)

Derives a since database view at transaction t or a java.time.Instant.

Derives a since database view at transaction `t` or a java.time.Instant.
sourceraw docstring

statsclj

(stats db)

Returns a channel yielding database statistics as a Clojure map.

Returns a channel yielding database statistics as a Clojure map.
sourceraw docstring

syncclj

(sync peer)

Synchronizes peer and returns a channel yielding the resulting database.

Synchronizes `peer` and returns a channel yielding the resulting database.
sourceraw docstring

transactclj

(transact peer transaction-data)

Submits Clojure transaction data through peer and yields a transaction map.

Submits Clojure transaction data through `peer` and yields a transaction map.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close