ICruxAPI (Crux Javadoc)

All Superinterfaces:

AutoCloseable, Closeable, ICruxIngestAPI
```
public interface ICruxAPI
extends ICruxIngestAPI, Closeable
```
Provides API access to Crux.

Field Summary

Fields
Modifier and Type Field and Description

static Map<Keyword,?> TX_INDEXED_EVENT_OPTS
Temporary helper value to pass to `listen`, to subscribe to tx-indexed events.

Fields
Modifier and Type	Field and Description
`static Map<Keyword,?>`	`TX_INDEXED_EVENT_OPTS` Temporary helper value to pass to `listen`, to subscribe to tx-indexed events.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`List<IQueryState>`	`activeQueries()` Returns a list of currently running queries.
`Map<Keyword,Long>`	`attributeStats()` Return frequencies of indexed attributes.
`Map<Keyword,?>`	`awaitTx(Map<Keyword,?> tx, Duration timeout)` Deprecated. in favour of `awaitTx(TransactionInstant, Duration)`
`TransactionInstant`	`awaitTx(TransactionInstant tx, Duration timeout)` Blocks until the node has indexed a transaction that is at or past the supplied tx.
`Date`	`awaitTxTime(Date txTime, Duration timeout)` Blocks until the node has indexed a transaction that is past the supplied txTime.
`ICruxDatasource`	`db()` Returns a db as of now.
`ICruxDatasource`	`db(Date validTime)` Returns a db as of the provided valid time.
`ICruxDatasource`	`db(Date validTime, Date transactionTime)` Returns a db as of valid time and transaction time.
`ICruxDatasource`	`db(DBBasis dbBasis)` Returns a db as of the given basis.
`ICruxDatasource`	`db(Map<Keyword,?> dbBasis)` Deprecated. in favour of `db(DBBasis)`
`ICruxDatasource`	`db(TransactionInstant txInstant)` Returns a db as of the TransactionInstant, with valid-time set to the invocation time of this method.
`boolean`	`hasTxCommitted(Map<Keyword,?> submittedTx)` Deprecated. in favour of `hasTxCommitted(TransactionInstant)`
`boolean`	`hasTxCommitted(TransactionInstant submittedTx)` Checks if a submitted tx was successfully committed.
`TransactionInstant`	`latestCompletedTx()`
`TransactionInstant`	`latestSubmittedTx()`
`AutoCloseable`	`listen(Map<Keyword,?> eventOpts, Consumer<Map<Keyword,?>> listener)` Attaches a listener to Crux's event bus.
`ICruxDatasource`	`openDB()` Returns a db as of now.
`ICruxDatasource`	`openDB(Date validTime)` Returns a db as of the provided valid time.
`ICruxDatasource`	`openDB(Date validTime, Date transactionTime)` Returns a db as of valid time and transaction time.
`ICruxDatasource`	`openDB(DBBasis dbBasis)` Returns a db as of the given basis.
`ICruxDatasource`	`openDB(Map<Keyword,?> dbBasis)` Deprecated. in favour of `openDB(DBBasis)` or `openDB(TransactionInstant)`
`ICruxDatasource`	`openDB(TransactionInstant txInstant)` Returns a db as of the TransactionInstant, with valid-time set to the invocation time of this method.
`List<IQueryState>`	`recentQueries()` Returns a list of recently completed/failed queries
`List<IQueryState>`	`slowestQueries()` Returns a list of slowest completed/failed queries ran on the node
`Map<Keyword,?>`	`status()` Returns the status of this node as a map.
`Date`	`sync(Duration timeout)` Blocks until the node has caught up indexing to the latest tx available at the time this method is called.

Methods inherited from interface crux.api.ICruxIngestAPI
openTxLog, submitTx, submitTx

Methods inherited from interface java.io.Closeable
close

- Field Detail
  - TX_INDEXED_EVENT_OPTS
```
static final Map<Keyword,?> TX_INDEXED_EVENT_OPTS
```
    Temporary helper value to pass to `listen`, to subscribe to tx-indexed events.
- Method Detail
  - db
```
ICruxDatasource db()
```
    Returns a db as of now. Will return the latest consistent snapshot of the db currently known. Does not block.
  - openDB
```
ICruxDatasource openDB()
```
    Returns a db as of now. Will return the latest consistent snapshot of the db currently known. Does not block. This method returns a DB that opens resources shared between method calls - it must be `.close`d when you've finished using it.
  - db
```
ICruxDatasource db(Date validTime)
```
    Returns a db as of the provided valid time. Will return the latest consistent snapshot of the db currently known, but does not wait for valid time to be current. Does not block.
  - openDB
```
ICruxDatasource openDB(Date validTime)
```
    Returns a db as of the provided valid time. Will return the latest consistent snapshot of the db currently known, but does not wait for valid time to be current. Does not block. This method returns a DB that opens resources shared between method calls - it must be `.close`d when you've finished using it.
  - db
```
ICruxDatasource db(Date validTime,
                   Date transactionTime)
            throws NodeOutOfSyncException
```
    Returns a db as of valid time and transaction time.
    
    Throws:
    
    NodeOutOfSyncException - if the node hasn't indexed up to the given `transactionTime`
  - openDB
```
ICruxDatasource openDB(Date validTime,
                       Date transactionTime)
                throws NodeOutOfSyncException
```
    Returns a db as of valid time and transaction time. This method returns a DB that opens resources shared between method calls - it must be `.close`d when you've finished using it.
    
    Throws:
    
    NodeOutOfSyncException - if the node hasn't indexed up to the given `transactionTime`
  - db
```
ICruxDatasource db(DBBasis dbBasis)
            throws NodeOutOfSyncException
```
    Returns a db as of the given basis.
    
    Throws:
    
    NodeOutOfSyncException - if the node hasn't indexed up to the given transaction
  - db
```
@Deprecated
ICruxDatasource db(Map<Keyword,?> dbBasis)
                        throws NodeOutOfSyncException
```
    Deprecated. in favour of db(DBBasis)
    
    Returns a db as of the given basis.
    
    Throws:
    
    NodeOutOfSyncException - if the node hasn't indexed up to the given transaction
  - db
```
ICruxDatasource db(TransactionInstant txInstant)
            throws NodeOutOfSyncException
```
    Returns a db as of the TransactionInstant, with valid-time set to the invocation time of this method.
    
    Throws:
    
    NodeOutOfSyncException - if the node hasn't indexed up to the given transaction
  - openDB
```
ICruxDatasource openDB(DBBasis dbBasis)
                throws NodeOutOfSyncException
```
    Returns a db as of the given basis. This method returns a DB that opens resources shared between method calls - it must be `.close`d when you've finished using it.
    
    Throws:
    
    NodeOutOfSyncException - if the node hasn't indexed up to the given transaction
  - openDB
```
@Deprecated
ICruxDatasource openDB(Map<Keyword,?> dbBasis)
                            throws NodeOutOfSyncException
```
    Deprecated. in favour of openDB(DBBasis) or openDB(TransactionInstant)
    
    Returns a db as of the given basis. This method returns a DB that opens resources shared between method calls - it must be `.close`d when you've finished using it.
    
    Throws:
    
    NodeOutOfSyncException - if the node hasn't indexed up to the given transaction
  - openDB
```
ICruxDatasource openDB(TransactionInstant txInstant)
                throws NodeOutOfSyncException
```
    Returns a db as of the TransactionInstant, with valid-time set to the invocation time of this method. This method returns a DB that opens resources shared between method calls - it must be `.close`d when you've finished using it.
    
    Throws:
    
    NodeOutOfSyncException - if the node hasn't indexed up to the given transaction
  - status
```
Map<Keyword,?> status()
```
    Returns the status of this node as a map.
    
    Returns:
    
    the status map.
  - hasTxCommitted
```
boolean hasTxCommitted(TransactionInstant submittedTx)
                throws NodeOutOfSyncException
```
    Checks if a submitted tx was successfully committed.
    
    Parameters:
    
    submittedTx - must be a transaction instant returned from ICruxIngestAPI.submitTx(Transaction txOps).
    
    Returns:
    
    true if the submitted transaction was committed, false if it was not committed.
    
    Throws:
    
    NodeOutOfSyncException - if the node has not yet indexed the transaction.
  - hasTxCommitted
```
@Deprecated
boolean hasTxCommitted(Map<Keyword,?> submittedTx)
                            throws NodeOutOfSyncException
```
    Deprecated. in favour of hasTxCommitted(TransactionInstant)
    
    Checks if a submitted tx was successfully committed.
    
    Parameters:
    
    submittedTx - must be a transaction instant returned from ICruxIngestAPI.submitTx(List))}.
    
    Returns:
    
    true if the submitted transaction was committed, false if it was not committed.
    
    Throws:
    
    NodeOutOfSyncException - if the node has not yet indexed the transaction.
  - sync
```
Date sync(Duration 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(Date validTime, Date transactionTime) for consistent reads.
    
    Parameters:
    
    timeout - max time to wait, can be null for the default.
    
    Returns:
    
    the latest known transaction time.
  - awaitTxTime
```
Date awaitTxTime(Date txTime,
                 Duration 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.
    
    Parameters:
    
    txTime - transaction time to await.
    
    timeout - max time to wait, can be null for the default.
    
    Returns:
    
    the latest known transaction time.
  - awaitTx
```
TransactionInstant awaitTx(TransactionInstant tx,
                           Duration 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.
    
    Parameters:
    
    tx - Transaction to await, as returned from submitTx.
    
    timeout - max time to wait, can be null for the default.
    
    Returns:
    
    the latest known transaction.
  - awaitTx
```
@Deprecated
Map<Keyword,?> awaitTx(Map<Keyword,?> tx,
                                   Duration timeout)
```
    Deprecated. in favour of awaitTx(TransactionInstant, Duration)
    
    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.
    
    Parameters:
    
    tx - Transaction to await, as returned from submitTx.
    
    timeout - max time to wait, can be null for the default.
    
    Returns:
    
    the latest known transaction.
  - listen
```
AutoCloseable listen(Map<Keyword,?> eventOpts,
                     Consumer<Map<Keyword,?>> listener)
```
    Attaches a listener to Crux's event bus. 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`. See/use TX_INDEXED_EVENT_OPTS This is an experimental API, subject to change.
    
    Parameters:
    
    eventOpts - should contain `:crux/event-type`, along with any other options the event-type requires.
    
    Returns:
    
    an AutoCloseable - closing the return value detaches the listener.
  - latestCompletedTx
```
TransactionInstant latestCompletedTx()
```
    Returns:
    
    the latest transaction to have been indexed by this node.
  - latestSubmittedTx
```
TransactionInstant latestSubmittedTx()
```
    Returns:
    
    the latest transaction to have been submitted to this cluster
  - attributeStats
```
Map<Keyword,Long> attributeStats()
```
    Return frequencies of indexed attributes.
    
    Returns:
    
    Map containing attribute freqencies.
  - activeQueries
```
List<IQueryState> activeQueries()
```
    Returns a list of currently running queries.
    
    Returns:
    
    List containing maps with query information.
  - recentQueries
```
List<IQueryState> recentQueries()
```
    Returns a list of recently completed/failed queries
    
    Returns:
    
    List containing maps with query information.
  - slowestQueries
```
List<IQueryState> slowestQueries()
```
    Returns a list of slowest completed/failed queries ran on the node
    
    Returns:
    
    List containing maps with query information.

Interface ICruxAPI

Field Summary

Method Summary

Methods inherited from interface crux.api.ICruxIngestAPI

Methods inherited from interface java.io.Closeable

Field Detail

TX_INDEXED_EVENT_OPTS

Method Detail

db

openDB

db

openDB

db

openDB

db

db

db

openDB

openDB

openDB

status

hasTxCommitted

hasTxCommitted

sync

awaitTxTime

awaitTx

awaitTx

listen

latestCompletedTx

latestSubmittedTx

attributeStats

activeQueries

recentQueries

slowestQueries