crux.api — juxt/crux-core 21.04-1.16.0-beta

Public API of Crux.

conform-tx-ops clj

(conform-tx-ops tx-ops)

DBProvider clj protocol

db clj

(db node)

(db node db-basis)

(db node valid-time)

(db node valid-time tx-time)

Returns a DB snapshot at the given time.

db-basis: (optional map, all keys optional)

• :crux.db/valid-time (Date): If provided, DB won't return any data with a valid-time greater than the given time. Defaults to now.
• :crux.tx/tx (Map): If provided, DB will be a snapshot as of the given transaction. Defaults to the latest completed transaction.
• :crux.tx/tx-time (Date): Shorthand for {:crux.tx/tx {:crux.tx/tx-time <>}}

Providing both :crux.tx/tx and :crux.tx/tx-time is undefined. Arities passing dates directly (node vt and node vt tt) are deprecated and will be removed in a later release.

If the node hasn't yet indexed a transaction at or past the given transaction, this throws NodeOutOfSyncException

open-db clj

(open-db node)

(open-db node db-basis)

(open-db node valid-time)

(open-db node valid-time tx-time)

Opens a DB snapshot at the given time.

db-basis: (optional map, all keys optional)

• :crux.db/valid-time (Date): If provided, DB won't return any data with a valid-time greater than the given time. Defaults to now.
• :crux.tx/tx (Map): If provided, DB will be a snapshot as of the given transaction. Defaults to the latest completed transaction.
• :crux.tx/tx-time (Date): Shorthand for {:crux.tx/tx {:crux.tx/tx-time <>}}

Providing both :crux.tx/tx and :crux.tx/tx-time is undefined. Arities passing dates directly (node vt and node vt tt) are deprecated and will be removed in a later release.

If the node hasn't yet indexed a transaction at or past the given transaction, this throws NodeOutOfSyncException

This DB opens up shared resources to make multiple requests faster - it must be .closed when you've finished using it (for example, in a with-open block)

new-api-client clj

(new-api-client url)

(new-api-client url opts)

Creates a new remote API client.

This implements: DBProvider, PCruxNode, PCruxIngestClient and java.io.Closeable.

The remote client requires valid and transaction time to be specified for all calls to db.

NOTE: Requires either clj-http or http-kit on the classpath, See https://opencrux.com/reference/http.html for more information.

url the URL to a Crux HTTP end-point. (OPTIONAL) auth-supplier a supplier function which provides an auth token string for the Crux HTTP end-point.

returns a remote API client.

new-ingest-client clj

(new-ingest-client options)

Starts an ingest client for transacting into Crux without running a full local node with index. Accepts a map, or a JSON/EDN file or classpath resource. See https://opencrux.com/reference/configuration.html for details. Returns a component that implements java.io.Closeable, PCruxIngestClient and PCruxAsyncIngestClient. Latter allows the node to be stopped by calling (.close node).

open-q clj

(open-q db q & args)

lazily q[uery] a Crux db. query param is a datalog query in map, vector or string form.

This function returns a Cursor of result tuples - once you've consumed as much of the sequence as you need to, you'll need to .close the sequence. A common way to do this is using with-open:

(with-open [res (crux/open-q db '{:find [...] :where [...]})] (doseq [row (iterator-seq res)] ...))

Once the sequence is closed, attempting to iterate it is undefined.

PCruxAsyncIngestClient clj protocol

Provides API access to Crux async ingestion.

submit-tx-async clj

(submit-tx-async node tx-ops)

Writes transactions to the log for processing tx-ops datalog style transactions. Non-blocking. Returns a deref with map with details about the submitted transaction, including tx-time and tx-id.

PCruxDatasource clj protocol

Represents the database as of a specific valid and transaction time.

pull clj

(pull db query eid)

Returns the requested data for the given entity ID, based on the projection spec

e.g. (pull db [:film/name :film/year] :spectre) => {:film/name "Spectre", :film/year 2015}

See https://opencrux.com/reference/queries.html#pull for details of the spec format.

transaction-time clj

(transaction-time db)

returns the time of the latest transaction applied to this db value. If a tx time was specified when db value was acquired then returns the specified time.

open-entity-history clj

(open-entity-history db eid sort-order)

(open-entity-history
  db
  eid
  sort-order
  {:keys [with-docs? with-corrections?]
   {start-vt :crux.db/valid-time
    start-tt :crux.tx/tx-time
    start-tx-id :crux.tx/tx-id}
     :start
   {end-vt :crux.db/valid-time end-tt :crux.tx/tx-time end-tx-id :crux.tx/tx-id}
     :end})

Lazily retrieves entity history for the given entity. Don't forget to close the cursor when you've consumed enough history! See entity-history for all the options

entity clj

(entity db eid)

queries a document map for an entity. eid is an object which can be coerced into an entity id. returns the entity document map.

open-q* clj

(open-q* db query args)

lazily q[uery] a Crux db. query param is a datalog query in map, vector or string form.

This function returns a Cursor of result tuples - once you've consumed as much of the sequence as you need to, you'll need to .close the sequence. A common way to do this is using with-open:

(with-open [res (crux/open-q db '{:find [...] :where [...]})] (doseq [row (iterator-seq res)] ...))

Once the sequence is closed, attempting to iterate it is undefined.

q* clj

(q* db query args)

q[uery] a Crux db. query param is a datalog query in map, vector or string form. This function will return a set of result tuples if you do not specify :order-by, :limit or :offset; otherwise, it will return a vector of result tuples.

pull-many clj

(pull-many db query eids)

Returns the requested data for the given entity IDs, based on the projection spec

e.g. (pull-many db [:film/name :film/year] #{:spectre :skyfall}) => [{:film/name "Spectre", :film/year 2015}, {:film/name "Skyfall", :film/year 2012}]

See https://opencrux.com/reference/queries.html#pull for details of the spec format.

entity-tx clj

(entity-tx db eid)

returns the transaction details for an entity. Details include tx-id and tx-time. eid is an object that can be coerced into an entity id.

with-tx clj

(with-tx db tx-ops)

Returns a new db value with the tx-ops speculatively applied. The tx-ops will only be visible in the value returned from this function - they're not submitted to the cluster, nor are they visible to any other database value in your application. If the transaction doesn't commit (eg because of a failed 'match'), this function returns nil.

valid-time clj

(valid-time db)

returns the valid time of the db. If valid time wasn't specified at the moment of the db value retrieval then valid time will be time of db value retrieval.

db-basis clj

(db-basis db)

returns the basis of this db snapshot - a map containing :crux.db/valid-time and :crux.tx/tx

entity-history clj

(entity-history db eid sort-order)

(entity-history
  db
  eid
  sort-order
  {:keys [with-docs? with-corrections?]
   {start-vt :crux.db/valid-time
    start-tt :crux.tx/tx-time
    start-tx-id :crux.tx/tx-id}
     :start
   {end-vt :crux.db/valid-time end-tt :crux.tx/tx-time end-tx-id :crux.tx/tx-id}
     :end})

Eagerly retrieves entity history for the given entity.

Options:

• sort-order (parameter): #{:asc :desc}
• :with-docs?: specifies whether to include documents in the entries
• :with-corrections?: specifies whether to include bitemporal corrections in the sequence, sorted first by valid-time, then tx-id.
• :start (nested map, inclusive, optional): the :crux.db/valid-time and :crux.tx/tx-time to start at.
• :end (nested map, exclusive, optional): the :crux.db/valid-time and :crux.tx/tx-time to stop at.

No matter what :start and :end parameters you specify, you won't receive results later than the valid-time and transact-time of this DB value.

Each entry in the result contains the following keys:

• :crux.db/valid-time,
• :crux.db/tx-time,
• :crux.tx/tx-id,
• :crux.db/content-hash
• :crux.db/doc (see with-docs?).

PCruxIngestClient clj protocol

Provides API access to Crux ingestion.

open-tx-log clj

(open-tx-log this after-tx-id with-ops?)

Reads the transaction log. Optionally includes operations, which allow the contents under the :crux.api/tx-ops key to be piped into (submit-tx tx-ops) of another Crux instance.

after-tx-id optional transaction id to start after. with-ops? should the operations with documents be included?

Returns an iterator of the TxLog

submit-tx clj

(submit-tx node tx-ops)

Writes transactions to the log for processing tx-ops datalog style transactions. Returns a map with details about the submitted transaction, including tx-time and tx-id.

PCruxNode clj protocol

Provides API access to Crux.

await-tx-time clj

(await-tx-time node tx-time)

(await-tx-time node tx-time timeout)

Blocks until the node has indexed a transaction that is past the supplied txTime. Will throw on timeout. The returned date is the latest index time when this node has caught up as of this call.

await-tx clj

(await-tx node tx)

(await-tx node tx timeout)

Blocks until the node has indexed a transaction that is at or past the supplied tx. Will throw on timeout. Returns the most recent tx indexed by the node.

tx-committed? clj

(tx-committed? node submitted-tx)

Checks if a submitted tx was successfully committed. submitted-tx must be a map returned from submit-tx. Returns true if the submitted transaction was committed, false if the transaction was not committed, and throws NodeOutOfSyncException if the node has not yet indexed the transaction.

latest-completed-tx clj

(latest-completed-tx node)

Returns the latest transaction to have been indexed by this node.

attribute-stats clj

(attribute-stats node)

Returns frequencies map for indexed attributes

sync clj

(sync node)

(sync node timeout)

(sync node tx-time timeout)

Blocks until the node has caught up indexing to the latest tx available at the time this method is called. Will throw an exception on timeout. The returned date is the latest transaction time indexed by this node. This can be used as the second parameter in (db valid-time transaction-time) for consistent reads.

timeout – max time to wait, can be nil for the default. Returns the latest known transaction time.

recent-queries clj

(recent-queries node)

Returns a list of recently completed/failed queries

slowest-queries clj

(slowest-queries node)

Returns a list of slowest completed/failed queries ran on the node

listen clj

(listen node event-opts f)

Attaches a listener to Crux's event bus.

event-opts should contain :crux/event-type, along with any other options the event-type requires.

We currently only support one public event-type: :crux/indexed-tx. Supplying :with-tx-ops? true will include the transaction's operations in the event passed to f.

(.close ...) the return value to detach the listener.

This is an experimental API, subject to change.

status clj

(status node)

Returns the status of this node as a map.

active-queries clj

(active-queries node)

Returns a list of currently running queries

latest-submitted-tx clj

(latest-submitted-tx node)

Returns the latest transaction to have been submitted to this cluster

q clj

(q db q & args)

q[uery] a Crux db. query param is a datalog query in map, vector or string form. This function will return a set of result tuples if you do not specify :order-by, :limit or :offset; otherwise, it will return a vector of result tuples.

start-node clj

(start-node options)

NOTE: requires any dependencies on the classpath that the Crux modules may need.

Accepts a map, or a JSON/EDN file or classpath resource.

See https://opencrux.com/reference/configuration.html for details.

Returns a node which implements: DBProvider, PCruxNode, PCruxIngestClient, PCruxAsyncIngestClient and java.io.Closeable.

Latter allows the node to be stopped by calling (.close node).

Throws IndexVersionOutOfSyncException if the index needs rebuilding.

TransactionFnContext clj protocol

indexing-tx clj

(indexing-tx tx-fn-ctx)

warn-on-malloc-arena-max clj