Index

A B C D E F G H I J L M N O P Q R S T V W X
All Classes and Interfaces|All Packages|Serialized Form

A

accept(TransactionOperation.Visitor<E>) - Method in class xtdb.api.tx.DeleteOperation

accept(TransactionOperation.Visitor<E>) - Method in class xtdb.api.tx.EvictOperation

accept(TransactionOperation.Visitor<E>) - Method in class xtdb.api.tx.InvokeFunctionOperation

accept(TransactionOperation.Visitor<E>) - Method in class xtdb.api.tx.MatchOperation

accept(TransactionOperation.Visitor<E>) - Method in class xtdb.api.tx.PutOperation

accept(TransactionOperation.Visitor<E>) - Method in class xtdb.api.tx.TransactionOperation

activeQueries() - Method in interface xtdb.api.IXtdb

Returns a list of currently running queries.

add(TransactionOperation) - Method in class xtdb.api.tx.Transaction.Builder

ASC - Enum constant in enum class xtdb.api.HistoryOptions.SortOrder

attributeStats() - Method in interface xtdb.api.IXtdb

Return frequencies of indexed attributes.

awaitTx(Map<Keyword, ?>, Duration) - Method in interface xtdb.api.IXtdb

Deprecated.

in favour of IXtdb.awaitTx(TransactionInstant, Duration)

awaitTx(TransactionInstant, Duration) - Method in interface xtdb.api.IXtdb

Blocks until the node has indexed a transaction that is at or past the supplied tx.

awaitTxTime(Date, Duration) - Method in interface xtdb.api.IXtdb

Blocks until the node has indexed a transaction that is past the supplied txTime.

B

build() - Method in class xtdb.api.ModuleConfiguration.Builder

build() - Method in class xtdb.api.NodeConfiguration.Builder

build() - Method in class xtdb.api.tx.Transaction.Builder

build() - Method in class xtdb.api.XtdbDocument.Builder

build(Object, Consumer<XtdbDocument.Builder>) - Static method in class xtdb.api.XtdbDocument

builder() - Static method in class xtdb.api.ModuleConfiguration

builder() - Static method in class xtdb.api.NodeConfiguration

builder() - Static method in class xtdb.api.tx.Transaction

builder(Object) - Static method in class xtdb.api.XtdbDocument

Builder() - Constructor for class xtdb.api.ModuleConfiguration.Builder

buildModule(Consumer<ModuleConfiguration.Builder>) - Static method in class xtdb.api.ModuleConfiguration

buildNode(Consumer<NodeConfiguration.Builder>) - Static method in class xtdb.api.NodeConfiguration

buildTx(Consumer<Transaction.Builder>) - Static method in class xtdb.api.tx.Transaction

C

COMPLETED - Enum constant in enum class xtdb.api.IQueryState.QueryStatus

create(Object) - Static method in class xtdb.api.tx.DeleteOperation

create(Object) - Static method in class xtdb.api.tx.EvictOperation

create(Object) - Static method in class xtdb.api.tx.MatchOperation

create(Object) - Static method in class xtdb.api.XtdbDocument

Creates a new XtdbDocument with just an ID key.

create(Object, Object...) - Static method in class xtdb.api.tx.InvokeFunctionOperation

create(Object, Date) - Static method in class xtdb.api.tx.DeleteOperation

create(Object, Date) - Static method in class xtdb.api.tx.MatchOperation

create(Object, Date, Date) - Static method in class xtdb.api.tx.DeleteOperation

create(Object, Map<String, Object>) - Static method in class xtdb.api.XtdbDocument

create(HistoryOptions.SortOrder) - Static method in class xtdb.api.HistoryOptions

create(XtdbDocument) - Static method in class xtdb.api.tx.MatchOperation

create(XtdbDocument) - Static method in class xtdb.api.tx.PutOperation

create(XtdbDocument, Date) - Static method in class xtdb.api.tx.MatchOperation

create(XtdbDocument, Date) - Static method in class xtdb.api.tx.PutOperation

create(XtdbDocument, Date, Date) - Static method in class xtdb.api.tx.PutOperation

createFunction(Object, String) - Static method in class xtdb.api.XtdbDocument

Static factory to create an XTDB transaction function document.

D

db() - Method in interface xtdb.api.IXtdb

Returns a db as of now.

db(Date) - Method in interface xtdb.api.IXtdb

Returns a db as of the provided valid time.

db(Date, Date) - Method in interface xtdb.api.IXtdb

Returns a db as of valid time and transaction time.

db(Map<Keyword, ?>) - Method in interface xtdb.api.IXtdb

Deprecated.

in favour of IXtdb.db(DBBasis)

db(DBBasis) - Method in interface xtdb.api.IXtdb

Returns a db as of the given basis.

db(TransactionInstant) - Method in interface xtdb.api.IXtdb

Returns a db as of the TransactionInstant, with valid-time set to the invocation time of this method.

dbBasis() - Method in interface xtdb.api.IXtdbDatasource

DBBasis - Class in xtdb.api

A class representing the basis of a DB instance - a valid time and a transaction instant.

DBBasis(Date, TransactionInstant) - Constructor for class xtdb.api.DBBasis

delete(Object) - Method in class xtdb.api.tx.Transaction.Builder

Adds a delete operation to the transaction, deleting the given document from validTime = now.

delete(Object, Date) - Method in class xtdb.api.tx.Transaction.Builder

Adds a delete operation to the transaction, deleting the given document starting from the given valid time

delete(Object, Date, Date) - Method in class xtdb.api.tx.Transaction.Builder

Adds a delete operation to the transaction, deleting the given document starting for the given validTime range

DeleteOperation - Class in xtdb.api.tx

DESC - Enum constant in enum class xtdb.api.HistoryOptions.SortOrder

E

endTransaction(TransactionInstant) - Method in class xtdb.api.HistoryOptions

Sets the ending transaction.

endTransactionTime(Date) - Method in class xtdb.api.HistoryOptions

Sets the ending transaction time.

endValidTime(Date) - Method in class xtdb.api.HistoryOptions

Sets the end valid time.

entity(Object) - Method in interface xtdb.api.IXtdbDatasource

Returns the document map for an entity.

entityHistory(Object, HistoryOptions) - Method in interface xtdb.api.IXtdbDatasource

Eagerly retrieves entity history for the given entity.

entityHistory(Object, HistoryOptions.SortOrder) - Method in interface xtdb.api.IXtdbDatasource

Eagerly retrieves entity history for the given entity.

entityTx(Object) - Method in interface xtdb.api.IXtdbDatasource

Returns the transaction details for an entity.

equals(Object) - Method in class xtdb.api.DBBasis

equals(Object) - Method in class xtdb.api.ModuleConfiguration

equals(Object) - Method in class xtdb.api.NodeConfiguration

equals(Object) - Method in class xtdb.api.TransactionInstant

equals(Object) - Method in class xtdb.api.tx.DeleteOperation

equals(Object) - Method in class xtdb.api.tx.EvictOperation

equals(Object) - Method in class xtdb.api.tx.InvokeFunctionOperation

equals(Object) - Method in class xtdb.api.tx.MatchOperation

equals(Object) - Method in class xtdb.api.tx.PutOperation

equals(Object) - Method in class xtdb.api.tx.Transaction

equals(Object) - Method in class xtdb.api.XtdbDocument

evict(Object) - Method in class xtdb.api.tx.Transaction.Builder

Adds an evict operation to the transaction, removing all trace of the entity with the given ID.

EvictOperation - Class in xtdb.api.tx

F

factory(IPersistentMap) - Static method in class xtdb.api.DBBasis

Not intended for public use, may be removed.

factory(IPersistentMap) - Static method in class xtdb.api.XtdbDocument

Creates an XtdbDocument from a Clojure map.

factory(Long) - Static method in class xtdb.api.TransactionInstant

factory(Long, Date) - Static method in class xtdb.api.TransactionInstant

factory(Date) - Static method in class xtdb.api.TransactionInstant

factory(Map<Keyword, ?>) - Static method in class xtdb.api.TransactionInstant

FAILED - Enum constant in enum class xtdb.api.IQueryState.QueryStatus

G

get(String) - Method in class xtdb.api.XtdbDocument

getArguments() - Method in class xtdb.api.tx.InvokeFunctionOperation

getAtValidTime() - Method in class xtdb.api.tx.MatchOperation

getData() - Method in exception xtdb.api.NodeOutOfSyncException

getDocument() - Method in class xtdb.api.tx.MatchOperation

getDocument() - Method in class xtdb.api.tx.PutOperation

getEndTransaction() - Method in class xtdb.api.HistoryOptions

getEndValidTime() - Method in class xtdb.api.HistoryOptions

getEndValidTime() - Method in class xtdb.api.tx.DeleteOperation

getEndValidTime() - Method in class xtdb.api.tx.PutOperation

getError() - Method in interface xtdb.api.IQueryState

getErrorClass() - Method in interface xtdb.api.IQueryState.IQueryError

getErrorMessage() - Method in interface xtdb.api.IQueryState.IQueryError

getFinishedAt() - Method in interface xtdb.api.IQueryState

getId() - Method in class xtdb.api.TransactionInstant

getId() - Method in class xtdb.api.tx.DeleteOperation

getId() - Method in class xtdb.api.tx.EvictOperation

getId() - Method in class xtdb.api.tx.InvokeFunctionOperation

getId() - Method in class xtdb.api.tx.MatchOperation

getId() - Method in class xtdb.api.XtdbDocument

getKeyword() - Method in enum class xtdb.api.HistoryOptions.SortOrder

getModule(String) - Method in class xtdb.api.NodeConfiguration

getOperations() - Method in class xtdb.api.tx.Transaction

getQuery() - Method in interface xtdb.api.IQueryState

getQueryId() - Method in interface xtdb.api.IQueryState

getSortOrder() - Method in class xtdb.api.HistoryOptions

getSortOrderKey() - Method in class xtdb.api.HistoryOptions

getStartedAt() - Method in interface xtdb.api.IQueryState

getStartTransaction() - Method in class xtdb.api.HistoryOptions

getStartValidTime() - Method in class xtdb.api.HistoryOptions

getStartValidTime() - Method in class xtdb.api.tx.DeleteOperation

getStartValidTime() - Method in class xtdb.api.tx.PutOperation

getStatus() - Method in interface xtdb.api.IQueryState

getTime() - Method in class xtdb.api.TransactionInstant

getTransactionInstant() - Method in class xtdb.api.DBBasis

getTxTime() - Method in class xtdb.api.tx.Transaction

getValidTime() - Method in class xtdb.api.DBBasis

H

hashCode() - Method in class xtdb.api.DBBasis

hashCode() - Method in class xtdb.api.ModuleConfiguration

hashCode() - Method in class xtdb.api.NodeConfiguration

hashCode() - Method in class xtdb.api.TransactionInstant

hashCode() - Method in class xtdb.api.tx.DeleteOperation

hashCode() - Method in class xtdb.api.tx.EvictOperation

hashCode() - Method in class xtdb.api.tx.InvokeFunctionOperation

hashCode() - Method in class xtdb.api.tx.MatchOperation

hashCode() - Method in class xtdb.api.tx.PutOperation

hashCode() - Method in class xtdb.api.tx.Transaction

hashCode() - Method in class xtdb.api.XtdbDocument

hasTxCommitted(Map<Keyword, ?>) - Method in interface xtdb.api.IXtdb

Deprecated.

in favour of IXtdb.hasTxCommitted(TransactionInstant)

hasTxCommitted(TransactionInstant) - Method in interface xtdb.api.IXtdb

Checks if a submitted tx was successfully committed.

HistoryOptions - Class in xtdb.api

HistoryOptions.SortOrder - Enum Class in xtdb.api

I

ICursor<E> - Interface in xtdb.api

IN_PROGRESS - Enum constant in enum class xtdb.api.IQueryState.QueryStatus

IndexVersionOutOfSyncException - Exception in xtdb.api

IndexVersionOutOfSyncException(String) - Constructor for exception xtdb.api.IndexVersionOutOfSyncException

invokeFunction(Object, Object...) - Method in class xtdb.api.tx.Transaction.Builder

Adds a transaction function invocation operation to the transaction.

InvokeFunctionOperation - Class in xtdb.api.tx

IQueryState - Interface in xtdb.api

IQueryState.IQueryError - Interface in xtdb.api

IQueryState.QueryStatus - Enum Class in xtdb.api

isWithCorrections() - Method in class xtdb.api.HistoryOptions

isWithDocs() - Method in class xtdb.api.HistoryOptions

IXtdb - Interface in xtdb.api

Provides API access to XTDB.

IXtdbDatasource - Interface in xtdb.api

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

IXtdbSubmitClient - Interface in xtdb.api

Provides API access to XTDB transaction submission.

J

jwtSupplier - Variable in class xtdb.api.RemoteClientOptions

A supplier function which provides JWT authorization strings for the remote API client to use to connect to a authenticated HTTP Server.

L

latestCompletedTx() - Method in interface xtdb.api.IXtdb

latestSubmittedTx() - Method in interface xtdb.api.IXtdb

listen(Map<Keyword, ?>, Consumer<Map<Keyword, ?>>) - Method in interface xtdb.api.IXtdb

Attaches a listener to XTDB's event bus.

M

match(XtdbDocument) - Method in class xtdb.api.tx.Transaction.Builder

Adds a match operation to the transaction.

match(XtdbDocument, Date) - Method in class xtdb.api.tx.Transaction.Builder

Adds a match operation to the transaction.

matchNotExists(Object) - Method in class xtdb.api.tx.Transaction.Builder

Adds a match operation to the transaction.

matchNotExists(Object, Date) - Method in class xtdb.api.tx.Transaction.Builder

Adds a match operation to the transaction.

MatchOperation - Class in xtdb.api.tx

minus(String) - Method in class xtdb.api.XtdbDocument

minusAll(Iterable<String>) - Method in class xtdb.api.XtdbDocument

module(String) - Method in class xtdb.api.ModuleConfiguration.Builder

Specifies the constructor of this module.

ModuleConfiguration - Class in xtdb.api

Class to configure an XTDB module.

ModuleConfiguration.Builder - Class in xtdb.api

N

newApiClient(String) - Static method in interface xtdb.api.IXtdb

Creates a new remote API client.

newApiClient(String, RemoteClientOptions) - Static method in interface xtdb.api.IXtdb

Creates a new remote API client.

newSubmitClient(Consumer<NodeConfiguration.Builder>) - Static method in interface xtdb.api.IXtdbSubmitClient

Starts an submit-only client for transacting into XTDB without running a full local node with index.

newSubmitClient(Map<?, ?>) - Static method in interface xtdb.api.IXtdbSubmitClient

Starts an submit-only client for transacting into XTDB without running a full local node with index.

newSubmitClient(NodeConfiguration) - Static method in interface xtdb.api.IXtdbSubmitClient

NodeConfiguration - Class in xtdb.api

Class to configure an XTDB node.

NodeConfiguration.Builder - Class in xtdb.api

NodeOutOfSyncException - Exception in xtdb.api

NodeOutOfSyncException(String, IPersistentMap) - Constructor for exception xtdb.api.NodeOutOfSyncException

O

openDB() - Method in interface xtdb.api.IXtdb

Returns a db as of now.

openDB(Date) - Method in interface xtdb.api.IXtdb

Returns a db as of the provided valid time.

openDB(Date, Date) - Method in interface xtdb.api.IXtdb

Returns a db as of valid time and transaction time.

openDB(Map<Keyword, ?>) - Method in interface xtdb.api.IXtdb

Deprecated.

in favour of IXtdb.openDB(DBBasis) or IXtdb.openDB(TransactionInstant)

openDB(DBBasis) - Method in interface xtdb.api.IXtdb

Returns a db as of the given basis.

openDB(TransactionInstant) - Method in interface xtdb.api.IXtdb

Returns a db as of the TransactionInstant, with valid-time set to the invocation time of this method.

openEntityHistory(Object, HistoryOptions) - Method in interface xtdb.api.IXtdbDatasource

Lazily retrieves entity history for the given entity.

openEntityHistory(Object, HistoryOptions.SortOrder) - Method in interface xtdb.api.IXtdbDatasource

Lazily retrieves entity history for the given entity.

openQuery(Object, Object...) - Method in interface xtdb.api.IXtdbDatasource

Queries the db lazily.

openTxLog(Long, boolean) - Method in interface xtdb.api.IXtdbSubmitClient

Reads the transaction log.

P

plus(String, Object) - Method in class xtdb.api.XtdbDocument

plusAll(Map<String, Object>) - Method in class xtdb.api.XtdbDocument

pull(Object, Object) - Method in interface xtdb.api.IXtdbDatasource

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

pullMany(Object, Iterable<?>) - Method in interface xtdb.api.IXtdbDatasource

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

pullMany(Object, Object...) - Method in interface xtdb.api.IXtdbDatasource

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

put(String, Object) - Method in class xtdb.api.XtdbDocument.Builder

put(XtdbDocument) - Method in class xtdb.api.tx.Transaction.Builder

Adds a put operation to the transaction, putting the given document at validTime = now.

put(XtdbDocument, Date) - Method in class xtdb.api.tx.Transaction.Builder

Adds a put operation to the transaction, putting the given document starting from the given valid time

put(XtdbDocument, Date, Date) - Method in class xtdb.api.tx.Transaction.Builder

Adds a put operation to the transaction, putting the given document starting for the given validTime range

putAll(Map<String, Object>) - Method in class xtdb.api.XtdbDocument.Builder

PutOperation - Class in xtdb.api.tx

Q

query(Object, Object...) - Method in interface xtdb.api.IXtdbDatasource

Queries the db.

R

recentQueries() - Method in interface xtdb.api.IXtdb

Returns a list of recently completed/failed queries

RemoteClientOptions - Class in xtdb.api

RemoteClientOptions(Supplier<String>) - Constructor for class xtdb.api.RemoteClientOptions

remove(String) - Method in class xtdb.api.XtdbDocument.Builder

removeAll(Iterable<String>) - Method in class xtdb.api.XtdbDocument.Builder

S

set(String, Object) - Method in class xtdb.api.ModuleConfiguration.Builder

Sets the configuration key to the given value

set(Map<String, Object>) - Method in class xtdb.api.ModuleConfiguration.Builder

slowestQueries() - Method in interface xtdb.api.IXtdb

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

sortOrder(HistoryOptions.SortOrder) - Method in class xtdb.api.HistoryOptions

startNode() - Static method in interface xtdb.api.IXtdb

Starts an in-memory query node.

startNode(File) - Static method in interface xtdb.api.IXtdb

Starts an XTDB node using the provided configuration.

startNode(URL) - Static method in interface xtdb.api.IXtdb

Starts an XTDB node using the provided configuration.

startNode(Consumer<NodeConfiguration.Builder>) - Static method in interface xtdb.api.IXtdb

Starts an XTDB node using the provided configuration.

startNode(Map<?, ?>) - Static method in interface xtdb.api.IXtdb

Starts an XTDB node using the provided configuration.

startNode(NodeConfiguration) - Static method in interface xtdb.api.IXtdb

startTransaction(TransactionInstant) - Method in class xtdb.api.HistoryOptions

Sets the starting transaction.

startTransactionTime(Date) - Method in class xtdb.api.HistoryOptions

Sets the starting transaction time.

startValidTime(Date) - Method in class xtdb.api.HistoryOptions

Sets the starting valid time.

status() - Method in interface xtdb.api.IXtdb

Returns the status of this node as a map.

submitTx(List<List<?>>) - Method in interface xtdb.api.IXtdbSubmitClient

Deprecated.

in favour of IXtdbSubmitClient.submitTx(Transaction)

submitTx(Transaction) - Method in interface xtdb.api.IXtdbSubmitClient

Writes transactions to the log for processing.

submitTxAsync(List<List<?>>) - Method in interface xtdb.api.IXtdbSubmitClient

Deprecated.

in favour of IXtdbSubmitClient.submitTxAsync(Transaction)

submitTxAsync(Transaction) - Method in interface xtdb.api.IXtdbSubmitClient

Writes transactions to the log for processing.

sync(Duration) - Method in interface xtdb.api.IXtdb

Blocks until the node has caught up indexing to the latest tx available at the time this method is called.

T

toMap() - Method in class xtdb.api.DBBasis

Not intended for public use, may be removed.

toMap() - Method in class xtdb.api.HistoryOptions

Not intended for public use, may be removed.

toMap() - Method in class xtdb.api.ModuleConfiguration

Not for public use, may be removed.

toMap() - Method in class xtdb.api.NodeConfiguration

Not for public use - may be removed.

toMap() - Method in class xtdb.api.TransactionInstant

Not for public use, may be removed.

toMap() - Method in class xtdb.api.XtdbDocument

Not intended for public use, may be removed.

Transaction - Class in xtdb.api.tx

Transaction.Builder - Class in xtdb.api.tx

TransactionInstant - Class in xtdb.api

A POJO representing the identity of a transaction, comprised of a transaction ID and a transaction time.

TransactionOperation - Class in xtdb.api.tx

TransactionOperation() - Constructor for class xtdb.api.tx.TransactionOperation

TransactionOperation.Visitor<E> - Interface in xtdb.api.tx

transactionTime() - Method in interface xtdb.api.IXtdbDatasource

TX_INDEXED_EVENT_OPTS - Static variable in interface xtdb.api.IXtdb

Temporary helper value to pass to `listen`, to subscribe to tx-indexed events.

V

validTime() - Method in interface xtdb.api.IXtdbDatasource

The valid time of this db.

valueOf(String) - Static method in enum class xtdb.api.HistoryOptions.SortOrder

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class xtdb.api.IQueryState.QueryStatus

Returns the enum constant of this class with the specified name.

values() - Static method in enum class xtdb.api.HistoryOptions.SortOrder

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class xtdb.api.IQueryState.QueryStatus

Returns an array containing the constants of this enum class, in the order they are declared.

visit(DeleteOperation) - Method in interface xtdb.api.tx.TransactionOperation.Visitor

visit(EvictOperation) - Method in interface xtdb.api.tx.TransactionOperation.Visitor

visit(InvokeFunctionOperation) - Method in interface xtdb.api.tx.TransactionOperation.Visitor

visit(MatchOperation) - Method in interface xtdb.api.tx.TransactionOperation.Visitor

visit(PutOperation) - Method in interface xtdb.api.tx.TransactionOperation.Visitor

W

with(String) - Method in class xtdb.api.ModuleConfiguration.Builder

Adds the submodule to this module with the default parameters

with(String) - Method in class xtdb.api.NodeConfiguration.Builder

Adds the module to the node configuration, with the default parameters.

with(String, String) - Method in class xtdb.api.ModuleConfiguration.Builder

Adds an existing top-level module to this submodule as a dependency.

with(String, Consumer<ModuleConfiguration.Builder>) - Method in class xtdb.api.ModuleConfiguration.Builder

Adds the submodule to this module with the given configuration

with(String, Consumer<ModuleConfiguration.Builder>) - Method in class xtdb.api.NodeConfiguration.Builder

Adds the given module to the node configuration.

with(String, ModuleConfiguration) - Method in class xtdb.api.ModuleConfiguration.Builder

Adds the submodule to this module with the given configuration

with(String, ModuleConfiguration) - Method in class xtdb.api.NodeConfiguration.Builder

Adds the given module to the node configuration.

withCorrections(boolean) - Method in class xtdb.api.HistoryOptions

Specifies whether to return bitemporal corrections in the history response.

withDocs(boolean) - Method in class xtdb.api.HistoryOptions

Specifies whether to return documents in the history response.

withTx(List<List<?>>) - Method in interface xtdb.api.IXtdbDatasource

Deprecated.

in favour of IXtdbDatasource.withTx(Transaction)

withTx(Transaction) - Method in interface xtdb.api.IXtdbDatasource

Returns a new db value with the txOps speculatively applied.

withTxTime(Date) - Method in class xtdb.api.tx.Transaction.Builder

Overrides the txTime of the transaction, for use in imports.

X

xtdb.api - package xtdb.api

xtdb.api.tx - package xtdb.api.tx

XtdbDocument - Class in xtdb.api

XtdbDocument.Builder - Class in xtdb.api

A B C D E F G H I J L M N O P Q R S T V W X
All Classes and Interfaces|All Packages|Serialized Form