crux.api
Public API of Crux.
Public API of Crux.
new-api-clientclj
(new-api-client url)Creates a new remote API client ICruxAPI. The remote client
requires valid and transaction time to be specified for all
calls to db.
NOTE: requires crux-http-client on the classpath, see crux.bootstrap.remote-api-client/internal-http-request-fn for more information.
url the URL to a Crux HTTP end-point.
returns a remote API client.
Creates a new remote API client ICruxAPI. The remote client requires valid and transaction time to be specified for all calls to `db`. NOTE: requires crux-http-client on the classpath, see crux.bootstrap.remote-api-client/*internal-http-request-fn* for more information. url the URL to a Crux HTTP end-point. returns a remote API client.
new-ingest-clientclj
(new-ingest-client options)Starts an ingest client for transacting into Kafka without running a full local node with index.
For valid options, see crux.bootstrap/cli-options. Options are specified as keywords using their long format name, like :bootstrap-servers etc.
options {:bootstrap-servers "kafka-cluster-kafka-brokers.crux.svc.cluster.local:9092" :group-id "group-id" :tx-topic "crux-transaction-log" :doc-topic "crux-docs" :create-topics true :doc-partitions 1 :replication-factor 1}
Returns a crux.api.ICruxIngestAPI component that implements java.io.Closeable, which allows the client to be stopped by calling close.
Starts an ingest client for transacting into Kafka without running a
full local node with index.
For valid options, see crux.bootstrap/cli-options. Options are
specified as keywords using their long format name, like
:bootstrap-servers etc.
options
{:bootstrap-servers "kafka-cluster-kafka-brokers.crux.svc.cluster.local:9092"
:group-id "group-id"
:tx-topic "crux-transaction-log"
:doc-topic "crux-docs"
:create-topics true
:doc-partitions 1
:replication-factor 1}
Returns a crux.api.ICruxIngestAPI component that implements
java.io.Closeable, which allows the client to be stopped by calling
close.PCruxAsyncIngestClientcljprotocol
Provides API access to Crux async ingestion.
Provides API access to Crux async ingestion.
submit-tx-asyncclj
(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.
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.
PCruxDatasourcecljprotocol
Represents the database as of a specific valid and transaction time.
Represents the database as of a specific valid and transaction time.
entityclj
(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.
queries a document map for an entity. eid is an object which can be coerced into an entity id. returns the entity document map.
entity-txclj
(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.
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.
history-ascendingclj
(history-ascending db snapshot eid)Retrieves entity history lazily in chronological order from and including the valid time of the db while respecting transaction time. Includes the documents.
Retrieves entity history lazily in chronological order from and including the valid time of the db while respecting transaction time. Includes the documents.
history-descendingclj
(history-descending db snapshot eid)Retrieves entity history lazily in reverse chronological order from and including the valid time of the db while respecting transaction time. Includes the documents.
Retrieves entity history lazily in reverse chronological order from and including the valid time of the db while respecting transaction time. Includes the documents.
new-snapshotclj
(new-snapshot db)Returns a new implementation specific snapshot allowing for lazy query results in a try-with-resources block using (q db snapshot query)}. Can also be used for (history-ascending db snapshot eid) and (history-descending db snapshot eid) returns an implementation specific snapshot
Returns a new implementation specific snapshot allowing for lazy query results in a try-with-resources block using (q db snapshot query)}. Can also be used for (history-ascending db snapshot eid) and (history-descending db snapshot eid) returns an implementation specific snapshot
qclj
(q db query)(q db snapshot query)q[uery] a Crux db.
query param is a datalog query in map, vector or string form.
First signature will evaluate eagerly and will return a set or vector
of result tuples.
Second signature accepts a db snapshot, see new-snapshot.
Evaluates lazily consequently returns lazy sequence of result tuples.
q[uery] a Crux db. query param is a datalog query in map, vector or string form. First signature will evaluate eagerly and will return a set or vector of result tuples. Second signature accepts a db snapshot, see `new-snapshot`. Evaluates *lazily* consequently returns lazy sequence of result tuples.
transaction-timeclj
(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.
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.
valid-timeclj
(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 the latest transaction.
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 the latest transaction.
PCruxIngestClientcljprotocol
Provides API access to Crux ingestion.
Provides API access to Crux ingestion.
new-tx-log-contextclj
(new-tx-log-context node)Returns a new transaction log context allowing for lazy reading of the transaction log in a try-with-resources block using (tx-log ^Closeable tx-Log-context, from-tx-id, boolean with-ops?).
Returns an implementation specific context.
Returns a new transaction log context allowing for lazy reading of the transaction log in a try-with-resources block using (tx-log ^Closeable tx-Log-context, from-tx-id, boolean with-ops?). Returns an implementation specific context.
submit-txclj
(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.
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.
tx-logclj
(tx-log node tx-log-context from-tx-id with-ops?)Reads the transaction log lazily. 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.
tx-log-context a context from (new-tx-log-context node) from-tx-id optional transaction id to start from. with-ops? should the operations with documents be included?
Returns a lazy sequence of the transaction log.
Reads the transaction log lazily. 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. tx-log-context a context from (new-tx-log-context node) from-tx-id optional transaction id to start from. with-ops? should the operations with documents be included? Returns a lazy sequence of the transaction log.
PCruxNodecljprotocol
Provides API access to Crux.
Provides API access to Crux.
history-rangeclj
(history-range node
eid
valid-time-start
transaction-time-start
valid-time-end
transaction-time-end)Returns the transaction history of an entity, ordered by valid time / transaction time in chronological order, earliest first. Includes corrections, but does not include the actual documents.
Giving nil as any of the date arguments makes the range open ended for that value.
Returns the transaction history of an entity, ordered by valid time / transaction time in chronological order, earliest first. Includes corrections, but does not include the actual documents. Giving nil as any of the date arguments makes the range open ended for that value.
submitted-tx-corrected-entity?clj
(submitted-tx-corrected-entity? node submitted-tx valid-time eid)Checks if a submitted tx did correct an entity as of valid time.
submitted-tx must be a map returned from submit-tx
valid-time valid time of the correction to check.
eid is an object that can be coerced into an entity id.
Returns true if the entity was updated in this transaction.
Checks if a submitted tx did correct an entity as of valid time. submitted-tx must be a map returned from `submit-tx` valid-time valid time of the correction to check. eid is an object that can be coerced into an entity id. Returns true if the entity was updated in this transaction.
dbclj
(db node)(db node valid-time)(db node valid-time transaction-time)Will return the latest value of the db currently known. Non-blocking.
When a valid time is specified then returned db value contains only those documents whose valid time is not after the specified. Non-blocking.
When both valid and transaction time are specified returns a db value as of the valid and transaction time. Will block until the transaction time is present in the index.
Will return the latest value of the db currently known. Non-blocking. When a valid time is specified then returned db value contains only those documents whose valid time is not after the specified. Non-blocking. When both valid and transaction time are specified returns a db value as of the valid and transaction time. Will block until the transaction time is present in the index.
attribute-statsclj
(attribute-stats node)Returns frequencies map for indexed attributes
Returns frequencies map for indexed attributes
historyclj
(history node eid)Returns the transaction history of an entity, in reverse chronological order. Includes corrections, but does not include the actual documents.
Returns the transaction history of an entity, in reverse chronological order. Includes corrections, but does not include the actual documents.
syncclj
(sync node timeout)(sync node transaction-time timeout)If the transaction-time is supplied, blocks until indexing has processed a tx with a greater-than transaction-time, otherwise blocks until the node has caught up indexing the tx-log backlog. Will throw an exception on timeout. The returned date is the latest index time when this node has caught up as of this call. 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.
If the transaction-time is supplied, blocks until indexing has processed a tx with a greater-than transaction-time, otherwise blocks until the node has caught up indexing the tx-log backlog. Will throw an exception on timeout. The returned date is the latest index time when this node has caught up as of this call. 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.
submitted-tx-updated-entity?clj
(submitted-tx-updated-entity? node submitted-tx eid)Checks if a submitted tx did update an entity.
submitted-tx must be a map returned from submit-tx
eid is an object that can be coerced into an entity id.
Returns true if the entity was updated in this transaction.
Checks if a submitted tx did update an entity. submitted-tx must be a map returned from `submit-tx` eid is an object that can be coerced into an entity id. Returns true if the entity was updated in this transaction.
documentsclj
(documents node content-hashes-set)Reads the set of documents from the document store based on their respective content hashes. Returns a map content-hash->document
Reads the set of documents from the document store based on their respective content hashes. Returns a map content-hash->document
documentclj
(document node content-hash)Reads a document from the document store based on its content hash.
Reads a document from the document store based on its content hash.
statusclj
(status node)Returns the status of this node as a map.
Returns the status of this node as a map.
start-cluster-nodeclj
(start-cluster-node options)Starts a query node in local library mode.
For valid options, see crux.bootstrap/cli-options. Options are specified as keywords using their long format name, like :bootstrap-servers etc.
NOTE: requires any KV store dependencies and crux-kafka on the classpath. The crux.kv.memdb.MemKv KV backend works without additional dependencies.
The HTTP API can be started by passing the node to crux.http-server/start-http-server. This will require further dependencies on the classpath, see crux.http-server for details.
options {:kv-backend "crux.kv.rocksdb.RocksKv" ; requires RocksDB as dep "crux.kv.memdb.MemKv" ; will work without addional deps :bootstrap-servers "kafka-cluster-kafka-brokers.crux.svc.cluster.local:9092" :event-log-dir "data/eventlog-1" :db-dir "data/db-dir-1" :backup-dir "checkpoint" :group-id "group-id" :tx-topic "crux-transaction-log" :doc-topic "crux-docs" :create-topics true :doc-partitions 1 :replication-factor 1 :db-dir "data" :server-port 3000 :await-tx-timeout 10000 :doc-cache-size 131072 :object-store "crux.index.KvObjectStore"}
returns the started cluster node that implements ICruxAPI and
java.io.Closeable. Latter allows the node to be stopped
by calling (.close node).
throws IndexVersionOutOfSyncException if the index needs rebuilding.
Starts a query node in local library mode.
For valid options, see crux.bootstrap/cli-options. Options are
specified as keywords using their long format name, like
:bootstrap-servers etc.
NOTE: requires any KV store dependencies and crux-kafka on
the classpath. The crux.kv.memdb.MemKv KV backend works without
additional dependencies.
The HTTP API can be started by passing the node to
crux.http-server/start-http-server. This will require further
dependencies on the classpath, see crux.http-server for
details.
options
{:kv-backend "crux.kv.rocksdb.RocksKv" ; requires RocksDB as dep
"crux.kv.memdb.MemKv" ; will work without addional deps
:bootstrap-servers "kafka-cluster-kafka-brokers.crux.svc.cluster.local:9092"
:event-log-dir "data/eventlog-1"
:db-dir "data/db-dir-1"
:backup-dir "checkpoint"
:group-id "group-id"
:tx-topic "crux-transaction-log"
:doc-topic "crux-docs"
:create-topics true
:doc-partitions 1
:replication-factor 1
:db-dir "data"
:server-port 3000
:await-tx-timeout 10000
:doc-cache-size 131072
:object-store "crux.index.KvObjectStore"}
returns the started cluster node that implements ICruxAPI and
java.io.Closeable. Latter allows the node to be stopped
by calling `(.close node)`.
throws IndexVersionOutOfSyncException if the index needs rebuilding.start-jdbc-nodeclj
(start-jdbc-node options)returns a JDBC node which implements ICruxAPI and
java.io.Closeable. Latter allows the node to be stopped
by calling (.close node).
throws IndexVersionOutOfSyncException if the index needs rebuilding.
returns a JDBC node which implements ICruxAPI and java.io.Closeable. Latter allows the node to be stopped by calling `(.close node)`. throws IndexVersionOutOfSyncException if the index needs rebuilding.
start-standalone-nodeclj
(start-standalone-node options)Creates a minimal standalone node writing the transaction log into its local KV store without relying on Kafka. Alternatively, when the event-log-dir option is provided, using two KV stores to enable rebuilding the index from the event log, being more similar to the semantics of Kafka but for a single process only.
NOTE: requires any KV store dependencies on the classpath. The crux.kv.memdb.MemKv KV backend works without additional dependencies.
options {:kv-backend "crux.kv.rocksdb.RocksKv" (or crux.kv.memdb.MemKv) :event-log-dir "data/eventlog-1" :db-dir "data/db-dir-1" :backup-dir "checkpoint"}
see start-cluster-node doc for more options
returns a standalone node which implements ICruxAPI and
java.io.Closeable. Latter allows the node to be stopped
by calling (.close node).
throws IndexVersionOutOfSyncException if the index needs rebuilding. throws NonMonotonicTimeException if the clock has moved backwards since last run. Only applicable when using the event log.
Creates a minimal standalone node writing the transaction log
into its local KV store without relying on
Kafka. Alternatively, when the event-log-dir option is
provided, using two KV stores to enable rebuilding the index
from the event log, being more similar to the semantics of
Kafka but for a single process only.
NOTE: requires any KV store dependencies on the classpath. The
crux.kv.memdb.MemKv KV backend works without additional dependencies.
options
{:kv-backend "crux.kv.rocksdb.RocksKv" (or crux.kv.memdb.MemKv)
:event-log-dir "data/eventlog-1"
:db-dir "data/db-dir-1"
:backup-dir "checkpoint"}
see start-cluster-node doc for more options
returns a standalone node which implements ICruxAPI and
java.io.Closeable. Latter allows the node to be stopped
by calling `(.close node)`.
throws IndexVersionOutOfSyncException if the index needs rebuilding.
throws NonMonotonicTimeException if the clock has moved backwards since
last run. Only applicable when using the event log.cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close