Package com.apple.foundationdb.record.provider.foundationdb

Class KeyValueCursor

java.lang.Object

com.apple.foundationdb.record.cursors.AsyncIteratorCursor<KeyValue>

com.apple.foundationdb.record.provider.foundationdb.KeyValueCursor

All Implemented Interfaces:

BaseCursor<KeyValue>, RecordCursor<KeyValue>, AutoCloseable, Iterator<KeyValue>

@API(MAINTAINED)
public class KeyValueCursor
extends AsyncIteratorCursor<KeyValue>
implements BaseCursor<KeyValue>

The basic cursor for scanning ranges of the FDB database.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KeyValueCursor.Builder	A builder for KeyValueCursor.

Nested classes/interfaces inherited from interface com.apple.foundationdb.record.RecordCursor

RecordCursor.NoNextReason

Field Summary

Fields

Modifier and Type	Field	Description
protected Executor	executor
protected CompletableFuture<Boolean>	hasNextFuture
protected C	iterator
protected boolean	mayGetContinuation
protected RecordCursorResult<T>	nextResult
protected int	valuesSeen

Method Summary

Modifier and Type	Method	Description
boolean	accept(RecordCursorVisitor visitor)	Accept a visit from hierarchical visitor, which implements RecordCursorVisitor.
void	close()
protected RecordCursorResult<T>	computeNextResult(boolean hasNext)
byte[]	getContinuation()	Deprecated.
Executor	getExecutor()
RecordCursorResult<KeyValue>	getNext()	Get the next result from this cursor.
RecordCursor.NoNextReason	getNoNextReason()	Deprecated.
T	next()	Deprecated.
CompletableFuture<Boolean>	onHasNext()	Deprecated.
CompletableFuture<RecordCursorResult<KeyValue>>	onNext()	Asynchronously return the next result from this cursor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Methods inherited from interface com.apple.foundationdb.record.RecordCursor

accept, asIterator, asList, close, filter, filterAsync, filterAsyncInstrumented, filterAsyncInstrumented, filterInstrumented, filterInstrumented, first, flatMapPipelined, forEach, forEachAsync, forEachResult, forEachResultAsync, getContinuation, getCount, getExecutor, getNoNextReason, hasNext, limitRowsTo, limitTo, map, mapEffect, mapEffect, mapPipelined, next, onHasNext, orElse, reduce, skip, skipThenLimit

Field Detail

executor

@Nonnull
protected final Executor executor

iterator

@Nonnull
protected final C extends Iterator<T> iterator

valuesSeen

protected int valuesSeen

hasNextFuture

@Nullable
protected CompletableFuture<Boolean> hasNextFuture

nextResult

@Nullable
protected RecordCursorResult<T> nextResult

mayGetContinuation

protected boolean mayGetContinuation

Method Detail

onNext

@Nonnull
public CompletableFuture<RecordCursorResult<KeyValue>> onNext()

Description copied from interface: RecordCursor

Asynchronously return the next result from this cursor. When complete, the future will contain a RecordCursorResult, which represents exactly one of the following:

1. The next object of type T produced by the cursor. In addition to the next record, this result includes a RecordCursorContinuation that can be used to continue the cursor after the last record returned. The returned continuation is guaranteed not to be an "end continuation" representing the end of the cursor: specifically, RecordCursorContinuation.isEnd() is always false on the returned continuation.
2. The fact that the cursor is stopped and cannot produce another record and a RecordCursor.NoNextReason that explains why no record could be produced. The result include a continuation that can be used to continue the cursor after the last record returned. If the result's NoNextReason is anything other than RecordCursor.NoNextReason.SOURCE_EXHAUSTED, the returned continuation must not be an end continuation. Conversely, if the result's NoNextReason is SOURCE_EXHAUSTED, then the returned continuation must be an an "end continuation".

In either case, the returned RecordCursorContinuation can be serialized to an opaque byte array using RecordCursorContinuation.toBytes(). This can be passed back into a new cursor of the same type, with all other parameters remaining the same.

Specified by:

onNext in interface RecordCursor<KeyValue>

Overrides:

onNext in class AsyncIteratorCursor<KeyValue>

Returns:

a future for the next result from this cursor representing either the next record or an indication of why the cursor stopped

See Also:

RecordCursorResult, RecordCursorContinuation

getNext

@Nonnull
public RecordCursorResult<KeyValue> getNext()

Description copied from interface: RecordCursor

Get the next result from this cursor. In many cases, this is a blocking operation and should not be called within asynchronous contexts. The non-blocking version of this function, RecordCursor.onNext(), should be preferred in such circumstances.

Specified by:

getNext in interface RecordCursor<KeyValue>

Returns:

the next result from this cursor representing either the next record or an indication of why the cursor stopped

See Also:

RecordCursor.onNext(), RecordCursorResult, RecordCursorContinuation

computeNextResult

protected RecordCursorResult<T> computeNextResult(boolean hasNext)

onHasNext

@Nonnull
@Deprecated
@API(DEPRECATED)
public CompletableFuture<Boolean> onHasNext()

Deprecated.

Description copied from interface: RecordCursor

Asynchronously check whether there are more records available from the cursor.

Specified by:

onHasNext in interface RecordCursor<T>

Returns:

a future that when complete will hold true if RecordCursor.next() would return a record.

See Also:

AsyncIterator.onHasNext()

next

@Nullable
@Deprecated
@API(DEPRECATED)
public T next()

Deprecated.

Description copied from interface: RecordCursor

Return the next value.

Specified by:

next in interface Iterator<T>

Specified by:

next in interface RecordCursor<T>

Returns:

the next value

getContinuation

@Nullable
@Deprecated
@API(DEPRECATED)
public byte[] getContinuation()

Deprecated.

Description copied from interface: RecordCursor

Get a byte string that can be used to continue a query after the last record returned.

Specified by:

getContinuation in interface RecordCursor<T>

Returns:

opaque byte array denoting where the cursor should pick up. This can be passed back into a new cursor of the same type, with all other parameters remaining the same. Returns null if the underlying source is completely exhausted, independent of any limit passed to the cursor creator. Since such creators generally accept null to mean no continuation, that is, start from the beginning, one must check for null from getContinuation to keep from starting over. Result is not always defined if called before onHasNext or before next after onHasNext has returned true. That is, a continuation is only guaranteed when called "between" records from a while (hasNext) next loop or after its end.

getNoNextReason

@Nonnull
@Deprecated
@API(DEPRECATED)
public RecordCursor.NoNextReason getNoNextReason()

Deprecated.

Description copied from interface: RecordCursor

Get the reason that the cursor has reached the end and returned false for RecordCursor.hasNext(). If hasNext was not called or returned true last time, the result is undefined and may be an exception.

Specified by:

getNoNextReason in interface RecordCursor<T>

Returns:

the reason that the cursor stopped

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface RecordCursor<T>

getExecutor

@Nonnull
public Executor getExecutor()

Specified by:

getExecutor in interface RecordCursor<T>

accept

public boolean accept(@Nonnull
                      RecordCursorVisitor visitor)

Description copied from interface: RecordCursor

Accept a visit from hierarchical visitor, which implements RecordCursorVisitor. By contract, implementations of this method must return the value of visitor.visitLeave(this), which determines whether or not subsequent siblings of this cursor should be visited.

Specified by:

accept in interface RecordCursor<T>

Parameters:

visitor - a hierarchical visitor

Returns:

true if the subsequent siblings of the cursor should be visited, and false otherwise