crux.api

Interface ICruxIngestAPI

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

ICruxAPI, ICruxAsyncIngestAPI

public interface ICruxIngestAPI
extends Closeable

Provides API access to Crux ingestion.

Method Summary

Modifier and Type	Method and Description
ICursor<Map<Keyword,?>>	openTxLog(Long afterTxId, boolean withOps) Reads the transaction log.
Map<Keyword,?>	submitTx(List<List<?>> transaction) Deprecated. in favour of submitTx(Transaction)
TransactionInstant	submitTx(Transaction transaction) Writes transactions to the log for processing.

Methods inherited from interface java.io.Closeable

close

Method Detail

submitTx

TransactionInstant submitTx(Transaction transaction)

Writes transactions to the log for processing.

Parameters:

transaction - the transaction to be processed.

Returns:

a map with details about the submitted transaction.

submitTx

@Deprecated
Map<Keyword,?> submitTx(List<List<?>> transaction)

Deprecated. in favour of submitTx(Transaction)

Writes transactions to the log for processing.

Parameters:

transaction - the transaction to be processed.

Returns:

a map with details about the submitted transaction.

openTxLog

ICursor<Map<Keyword,?>> openTxLog(Long afterTxId,
                                  boolean withOps)

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.

Parameters:

afterTxId - optional transaction id to start after.

withOps - should the operations with documents be included?

Returns:

a lazy sequence of the transaction log.