Package com.twicedb.client.api

Interface Client

All Known Implementing Classes:

ClientImpl

public interface Client

A TwiceDB client. This interface provides the API for storing and retrieving data.

Method Summary

Modifier and Type	Method	Description
Lsqt	catchUpLsqt(Tt catchUpTo, Duration maxWaitDuration)
boolean	checkReader()
boolean	checkWriter()
WrittenTransaction	commitTxn(Txn txn)
Future<WriteAsyncResponse>	commitTxnAsync(Txn txn)
<I extends Indexable<I>> AggregationResponse	countByIndexedQuery(IndexedQuery<I> iq, TemporalCoordinates tc)
<I extends Indexable<I>> Future<AggregationResponse>	countByIndexedQueryAsync(IndexedQuery<I> iq, TemporalCoordinates tc)
WrittenObject	delete(ObjectId objectId, Tt lastRead, Vt vtFrom)
Future<WriteAsyncResponse>	deleteAsync(ObjectId objectId, Tt lastRead, Vt vtFrom)
<I extends Indexable<I>> WrittenObject	deleteObject(I object, Vt vtFrom)
<I extends Indexable<I>> Future<WriteAsyncResponse>	deleteObjectAsync(I object, Vt vtFrom)
Tt	entitle(EmailAddress emailAddress, Fqn fqn, ReadEntitlement read, WriteEntitlement write, EntitleEntitlement entitle, Vt vt, BackfillTt backfillTt)
Lsqt	getLsqt()
ClientMetrics	getMetrics()
long	getReadQueueCap()
ServerStatus	getServerStatus(ServerType serverType)
long	getWriteQueueCap()
List<Fqn>	listLockedFqns()
Tt	lockFqn(Fqn fqn)
<I extends Indexable<I>> AggregationResponse	maxByIndexedQuery(IndexedQuery<I> iq, ProjectedFieldKey fieldKey, TemporalCoordinates tc)
<I extends Indexable<I>> Future<AggregationResponse>	maxByIndexedQueryAsync(IndexedQuery<I> iq, ProjectedFieldKey fieldKey, TemporalCoordinates tc)
<I extends Indexable<I>> AggregationResponse	meanByIndexedQuery(IndexedQuery<I> iq, ProjectedFieldKey fieldKey, TemporalCoordinates tc)
<I extends Indexable<I>> Future<AggregationResponse>	meanByIndexedQueryAsync(IndexedQuery<I> iq, ProjectedFieldKey fieldKey, TemporalCoordinates tc)
<I extends Indexable<I>> AggregationResponse	medianByIndexedQuery(IndexedQuery<I> iq, ProjectedFieldKey fieldKey, TemporalCoordinates tc)
<I extends Indexable<I>> Future<AggregationResponse>	medianByIndexedQueryAsync(IndexedQuery<I> iq, ProjectedFieldKey fieldKey, TemporalCoordinates tc)
<I extends Indexable<I>> AggregationResponse	minByIndexedQuery(IndexedQuery<I> iq, ProjectedFieldKey fieldKey, TemporalCoordinates tc)
<I extends Indexable<I>> Future<AggregationResponse>	minByIndexedQueryAsync(IndexedQuery<I> iq, ProjectedFieldKey fieldKey, TemporalCoordinates tc)
<I extends Indexable<I>> AggregationResponse	percentileByIndexedQuery(IndexedQuery<I> iq, ProjectedFieldKey fieldKey, Percentile p, TemporalCoordinates tc)
<I extends Indexable<I>> Future<AggregationResponse>	percentileByIndexedQueryAsync(IndexedQuery<I> iq, ProjectedFieldKey fieldKey, Percentile p, TemporalCoordinates tc)
WrittenObject	put(ObjectId objectId, Tt lastRead, Vt vtFrom, Blob blob)
Future<WriteAsyncResponse>	putAsync(ObjectId objectId, Tt lastRead, Vt vtFrom, Blob blob)
<I extends Indexable<I>> WrittenObject	putObject(I object, Vt vtFrom)
<I extends Indexable<I>> Future<WriteAsyncResponse>	putObjectAsync(I object, Vt vtFrom)
<E extends Event<E>> E	readEvent(EventId eventId, Fqn fqn, Tt tt)
<E extends Event<E>> Future<E>	readEventAsync(EventId eventId, Fqn fqn, Tt tt)
<I extends Indexable<I>, E extends Event<E>> E	readEventForObject(Indexable<I> ixbl)
<I extends Indexable<I>, E extends Event<E>> Future<E>	readEventForObjectAsync(Indexable<I> ixbl)
Lsqt	readLsqt()
<I extends Indexable<I>> ReadObject	readObject(I ixbl, TemporalCoordinates tc)
<I extends Indexable<I>> Future<ReadObject>	readObjectAsync(I ixbl, TemporalCoordinates tc)
<I extends Indexable<I>> List<I>	readObjects(I object, TemporalCoordinates tc)
<I extends Indexable<I>> Future<ReadAsyncResponse>	readObjectsAsync(I object, TemporalCoordinates tc)
<I extends Indexable<I>> List<I>	readObjectsAtTt(I ixbl, Tt tt)
<I extends Indexable<I>> Future<ReadAsyncResponse>	readObjectsAtTtAsync(I ixbl, Tt tt)
<I extends Indexable<I>> List<I>	readObjectsAtVt(I ixbl, TemporalCoordinates tc)
<I extends Indexable<I>> Future<ReadAsyncResponse>	readObjectsAtVtAsync(I ixbl, TemporalCoordinates tc)
<I extends Indexable<I>, E extends Event<E>> List<I>	readObjectsByEvent(E e)
<I extends Indexable<I>, E extends Event<E>> Future<List<I>>	readObjectsByEventAsync(E e)
<I extends Indexable<I>> List<I>	readObjectsByFqn(Fqn fqn, Tt maxSeenTtFrom, TimesliceId maxSeenTimesliceId, Tt maxTtFrom, BatchSize batchSize)
<I extends Indexable<I>> List<I>	readObjectsByIndexedQuery(IndexedQuery<I> iq, TemporalCoordinates tc)
<I extends Indexable<I>> Future<ReadAsyncResponse>	readObjectsByIndexedQueryAsync(IndexedQuery<I> iq, TemporalCoordinates tc)
<I extends Indexable<I>> List<I>	readObjectsToIndexables(List<ReadObject> ros)
ReadObject	readPoint(ObjectId objectId, TemporalCoordinates tc)
Future<ReadAsyncResponse>	readPointAsync(ObjectId objectId, TemporalCoordinates tc)
<I extends Indexable<I>> WrittenObject	reindexObject(I ixbl)
<I extends Indexable<I>> Future<WriteAsyncResponse>	reindexObjectAsync(I ixbl)
WrittenObject	reinstate(ObjectId objectId, Tt lastRead, Vt vtFrom)
Future<WriteAsyncResponse>	reinstateAsync(ObjectId objectId, Tt lastRead, Vt vtFrom)
<I extends Indexable<I>> WrittenObject	reinstateObject(I object, Vt vtFrom)
<I extends Indexable<I>> Future<WriteAsyncResponse>	reinstateObjectAsync(I object, Vt vtFrom)
void	start()
<I extends Indexable<I>> AggregationResponse	stdevByIndexedQuery(IndexedQuery<I> iq, ProjectedFieldKey fieldKey, TemporalCoordinates tc)
<I extends Indexable<I>> Future<AggregationResponse>	stdevByIndexedQueryAsync(IndexedQuery<I> iq, ProjectedFieldKey fieldKey, TemporalCoordinates tc)
void	stop()
<I extends Indexable<I>> void	subscribeToIndexedQuery(IndexedQuery<I> iq, Function<SubscribeResponse,Boolean> cback)
void	subscribeToObjectId(ObjectId oid, Function<SubscribeResponse,Boolean> cback)
<I extends Indexable<I>> AggregationResponse	sumByIndexedQuery(IndexedQuery<I> iq, ProjectedFieldKey fieldKey, TemporalCoordinates tc)
<I extends Indexable<I>> Future<AggregationResponse>	sumByIndexedQueryAsync(IndexedQuery<I> iq, ProjectedFieldKey fieldKey, TemporalCoordinates tc)
Tt	unlockFqn(Fqn fqn)
<I extends Indexable<I>> AggregationResponse	varByIndexedQuery(IndexedQuery<I> iq, ProjectedFieldKey fieldKey, TemporalCoordinates tc)
<I extends Indexable<I>> Future<AggregationResponse>	varByIndexedQueryAsync(IndexedQuery<I> iq, ProjectedFieldKey fieldKey, TemporalCoordinates tc)

Method Details

getReadQueueCap

long getReadQueueCap()

getWriteQueueCap

long getWriteQueueCap()

getLsqt

Lsqt getLsqt()

readLsqt

Lsqt readLsqt()

catchUpLsqt

Lsqt catchUpLsqt(Tt catchUpTo,
 Duration maxWaitDuration)

getMetrics

ClientMetrics getMetrics()

start

void start()

stop

void stop()

checkReader

boolean checkReader()

checkWriter

boolean checkWriter()

readEvent

<E extends Event<E>> E readEvent(EventId eventId,
 Fqn fqn,
 Tt tt)

readEventAsync

<E extends Event<E>> Future<E> readEventAsync(EventId eventId,
 Fqn fqn,
 Tt tt)

readEventForObject

<I extends Indexable<I>,
E extends Event<E>> E readEventForObject(Indexable<I> ixbl)

readEventForObjectAsync

<I extends Indexable<I>,
E extends Event<E>>
Future<E> readEventForObjectAsync(Indexable<I> ixbl)

readObjectsByEvent

<I extends Indexable<I>,
E extends Event<E>> List<I> readObjectsByEvent(E e)

readObjectsByEventAsync

<I extends Indexable<I>,
E extends Event<E>>
Future<List<I>> readObjectsByEventAsync(E e)

readObjectsToIndexables

<I extends Indexable<I>> List<I> readObjectsToIndexables(List<ReadObject> ros)

readObjectsByFqn

<I extends Indexable<I>> List<I> readObjectsByFqn(Fqn fqn,
 Tt maxSeenTtFrom,
 TimesliceId maxSeenTimesliceId,
 Tt maxTtFrom,
 BatchSize batchSize)

readObject

<I extends Indexable<I>> ReadObject readObject(I ixbl,
 TemporalCoordinates tc)

readObjectAsync

<I extends Indexable<I>> Future<ReadObject> readObjectAsync(I ixbl,
 TemporalCoordinates tc)

readPoint

ReadObject readPoint(ObjectId objectId,
 TemporalCoordinates tc)

readPointAsync

Future<ReadAsyncResponse> readPointAsync(ObjectId objectId,
 TemporalCoordinates tc)

readObjects

<I extends Indexable<I>> List<I> readObjects(I object,
 TemporalCoordinates tc)

readObjectsAsync

<I extends Indexable<I>> Future<ReadAsyncResponse> readObjectsAsync(I object,
 TemporalCoordinates tc)

readObjectsByIndexedQuery

<I extends Indexable<I>> List<I> readObjectsByIndexedQuery(IndexedQuery<I> iq,
 TemporalCoordinates tc)

readObjectsByIndexedQueryAsync

<I extends Indexable<I>> Future<ReadAsyncResponse> readObjectsByIndexedQueryAsync(IndexedQuery<I> iq,
 TemporalCoordinates tc)

readObjectsAtVt

<I extends Indexable<I>> List<I> readObjectsAtVt(I ixbl,
 TemporalCoordinates tc)

readObjectsAtVtAsync

<I extends Indexable<I>> Future<ReadAsyncResponse> readObjectsAtVtAsync(I ixbl,
 TemporalCoordinates tc)

readObjectsAtTt

<I extends Indexable<I>> List<I> readObjectsAtTt(I ixbl,
 Tt tt)

readObjectsAtTtAsync

<I extends Indexable<I>> Future<ReadAsyncResponse> readObjectsAtTtAsync(I ixbl,
 Tt tt)

delete

WrittenObject delete(ObjectId objectId,
 Tt lastRead,
 Vt vtFrom)

deleteAsync

Future<WriteAsyncResponse> deleteAsync(ObjectId objectId,
 Tt lastRead,
 Vt vtFrom)

deleteObject

<I extends Indexable<I>> WrittenObject deleteObject(I object,
 Vt vtFrom)

deleteObjectAsync

<I extends Indexable<I>> Future<WriteAsyncResponse> deleteObjectAsync(I object,
 Vt vtFrom)

put

WrittenObject put(ObjectId objectId,
 Tt lastRead,
 Vt vtFrom,
 Blob blob)

putAsync

Future<WriteAsyncResponse> putAsync(ObjectId objectId,
 Tt lastRead,
 Vt vtFrom,
 Blob blob)

putObject

<I extends Indexable<I>> WrittenObject putObject(I object,
 Vt vtFrom)

putObjectAsync

<I extends Indexable<I>> Future<WriteAsyncResponse> putObjectAsync(I object,
 Vt vtFrom)

reinstate

WrittenObject reinstate(ObjectId objectId,
 Tt lastRead,
 Vt vtFrom)

reinstateAsync

Future<WriteAsyncResponse> reinstateAsync(ObjectId objectId,
 Tt lastRead,
 Vt vtFrom)

reinstateObject

<I extends Indexable<I>> WrittenObject reinstateObject(I object,
 Vt vtFrom)

reinstateObjectAsync

<I extends Indexable<I>> Future<WriteAsyncResponse> reinstateObjectAsync(I object,
 Vt vtFrom)

commitTxn

WrittenTransaction commitTxn(Txn txn)

commitTxnAsync

Future<WriteAsyncResponse> commitTxnAsync(Txn txn)

countByIndexedQuery

<I extends Indexable<I>> AggregationResponse countByIndexedQuery(IndexedQuery<I> iq,
 TemporalCoordinates tc)

countByIndexedQueryAsync

<I extends Indexable<I>>
Future<AggregationResponse> countByIndexedQueryAsync(IndexedQuery<I> iq,
 TemporalCoordinates tc)

maxByIndexedQuery

<I extends Indexable<I>> AggregationResponse maxByIndexedQuery(IndexedQuery<I> iq,
 ProjectedFieldKey fieldKey,
 TemporalCoordinates tc)

maxByIndexedQueryAsync

<I extends Indexable<I>>
Future<AggregationResponse> maxByIndexedQueryAsync(IndexedQuery<I> iq,
 ProjectedFieldKey fieldKey,
 TemporalCoordinates tc)

meanByIndexedQuery

<I extends Indexable<I>> AggregationResponse meanByIndexedQuery(IndexedQuery<I> iq,
 ProjectedFieldKey fieldKey,
 TemporalCoordinates tc)

meanByIndexedQueryAsync

<I extends Indexable<I>>
Future<AggregationResponse> meanByIndexedQueryAsync(IndexedQuery<I> iq,
 ProjectedFieldKey fieldKey,
 TemporalCoordinates tc)

medianByIndexedQuery

<I extends Indexable<I>> AggregationResponse medianByIndexedQuery(IndexedQuery<I> iq,
 ProjectedFieldKey fieldKey,
 TemporalCoordinates tc)

medianByIndexedQueryAsync

<I extends Indexable<I>>
Future<AggregationResponse> medianByIndexedQueryAsync(IndexedQuery<I> iq,
 ProjectedFieldKey fieldKey,
 TemporalCoordinates tc)

minByIndexedQuery

<I extends Indexable<I>> AggregationResponse minByIndexedQuery(IndexedQuery<I> iq,
 ProjectedFieldKey fieldKey,
 TemporalCoordinates tc)

minByIndexedQueryAsync

<I extends Indexable<I>>
Future<AggregationResponse> minByIndexedQueryAsync(IndexedQuery<I> iq,
 ProjectedFieldKey fieldKey,
 TemporalCoordinates tc)

percentileByIndexedQuery

<I extends Indexable<I>> AggregationResponse percentileByIndexedQuery(IndexedQuery<I> iq,
 ProjectedFieldKey fieldKey,
 Percentile p,
 TemporalCoordinates tc)

percentileByIndexedQueryAsync

<I extends Indexable<I>>
Future<AggregationResponse> percentileByIndexedQueryAsync(IndexedQuery<I> iq,
 ProjectedFieldKey fieldKey,
 Percentile p,
 TemporalCoordinates tc)

stdevByIndexedQuery

<I extends Indexable<I>> AggregationResponse stdevByIndexedQuery(IndexedQuery<I> iq,
 ProjectedFieldKey fieldKey,
 TemporalCoordinates tc)

stdevByIndexedQueryAsync

<I extends Indexable<I>>
Future<AggregationResponse> stdevByIndexedQueryAsync(IndexedQuery<I> iq,
 ProjectedFieldKey fieldKey,
 TemporalCoordinates tc)

sumByIndexedQuery

<I extends Indexable<I>> AggregationResponse sumByIndexedQuery(IndexedQuery<I> iq,
 ProjectedFieldKey fieldKey,
 TemporalCoordinates tc)

sumByIndexedQueryAsync

<I extends Indexable<I>>
Future<AggregationResponse> sumByIndexedQueryAsync(IndexedQuery<I> iq,
 ProjectedFieldKey fieldKey,
 TemporalCoordinates tc)

varByIndexedQuery

<I extends Indexable<I>> AggregationResponse varByIndexedQuery(IndexedQuery<I> iq,
 ProjectedFieldKey fieldKey,
 TemporalCoordinates tc)

varByIndexedQueryAsync

<I extends Indexable<I>>
Future<AggregationResponse> varByIndexedQueryAsync(IndexedQuery<I> iq,
 ProjectedFieldKey fieldKey,
 TemporalCoordinates tc)

listLockedFqns

List<Fqn> listLockedFqns()

lockFqn

Tt lockFqn(Fqn fqn)

unlockFqn

Tt unlockFqn(Fqn fqn)

reindexObject

<I extends Indexable<I>> WrittenObject reindexObject(I ixbl)

reindexObjectAsync

<I extends Indexable<I>> Future<WriteAsyncResponse> reindexObjectAsync(I ixbl)

subscribeToIndexedQuery

<I extends Indexable<I>> void subscribeToIndexedQuery(IndexedQuery<I> iq,
 Function<SubscribeResponse,Boolean> cback)

subscribeToObjectId

void subscribeToObjectId(ObjectId oid,
 Function<SubscribeResponse,Boolean> cback)

getServerStatus

ServerStatus getServerStatus(ServerType serverType)

entitle

Tt entitle(EmailAddress emailAddress,
 Fqn fqn,
 ReadEntitlement read,
 WriteEntitlement write,
 EntitleEntitlement entitle,
 Vt vt,
 BackfillTt backfillTt)