Module org.neo4j.driver

Package org.neo4j.driver.internal.cursor

Class ResultCursorImpl

java.lang.Object

org.neo4j.driver.internal.cursor.AbstractRecordStateResponseHandler

org.neo4j.driver.internal.cursor.ResultCursorImpl

All Implemented Interfaces:

ResultCursor, DriverResponseHandler, org.neo4j.driver.internal.FailableCursor

public class ResultCursorImpl
extends AbstractRecordStateResponseHandler
implements ResultCursor, org.neo4j.driver.internal.FailableCursor, DriverResponseHandler

Nested Class Summary

Nested classes/interfaces inherited from class org.neo4j.driver.internal.cursor.AbstractRecordStateResponseHandler

AbstractRecordStateResponseHandler.RecordState

Field Summary

Fields

Modifier and Type	Field	Description
static final MetadataExtractor	METADATA_EXTRACTOR

Fields inherited from class org.neo4j.driver.internal.cursor.AbstractRecordStateResponseHandler

recordState

Constructor Summary

Constructors

Constructor	Description
ResultCursorImpl(DriverBoltConnection boltConnection, Query query, long fetchSize, Consumer<org.neo4j.driver.internal.DatabaseBookmark> bookmarkConsumer, boolean closeOnSummary, CompletableFuture<UnmanagedTransaction> beginFuture, Consumer<String> databaseNameConsumer, ApiTelemetryWork apiTelemetryWork, DriverObservationProvider observationProvider, Class<?> resultType)

Method Summary

Modifier and Type	Method	Description
CompletionStage<ResultSummary>	consumeAsync()	Asynchronously retrieve the result summary.
CompletionStage<Void>	consumed()
CompletionStage<Throwable>	discardAllFailureAsync(Observation parentObservation)	Discarding all unconsumed records and returning failure if there is any pull errors.
CompletionStage<ResultSummary>	forEachAsync(Consumer<Record> action)	Asynchronously apply the given action to every record in the result, yielding a summary of it.
CompletionStage<Boolean>	isOpenAsync()	Determine if result is open.
List<String>	keys()	Retrieve the keys of the records this result cursor contains.
CompletionStage<List<Record>>	listAsync()	Asynchronously retrieve and store the entire result stream.
<T> CompletionStage<List<T>>	listAsync(Function<Record,T> mapFunction)	Asynchronously retrieve and store a projection of the entire result.
CompletionStage<Record>	nextAsync()	Asynchronously navigate to and retrieve the next Record in this result.
void	onBeginSummary(org.neo4j.bolt.connection.summary.BeginSummary summary)
void	onComplete()
void	onDiscardSummary(DiscardSummary summary)
void	onError(Throwable throwable)
void	onIgnored()
void	onPullSummary(PullSummary summary)
void	onRecord(List<Value> fields)
void	onRunSummary(org.neo4j.bolt.connection.summary.RunSummary summary)
void	onTelemetrySummary(org.neo4j.bolt.connection.summary.TelemetrySummary summary)
CompletionStage<Record>	peekAsync()	Asynchronously investigate the next upcoming Record without moving forward in the result.
CompletionStage<Throwable>	pullAllFailureAsync(Observation parentObservation)	Pulling all unconsumed records into memory and returning failure if there is any pull errors.
CompletionStage<ResultCursorImpl>	resultCursor()
CompletionStage<Record>	singleAsync()	Asynchronously return the first record in the result, failing if there is not exactly one record left in the stream.

Methods inherited from class org.neo4j.driver.internal.cursor.AbstractRecordStateResponseHandler

generateGqlStatusObject, updateRecordState

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.neo4j.driver.internal.adaptedbolt.DriverResponseHandler

onCommitSummary, onLogoffSummary, onLogonSummary, onResetSummary, onRollbackSummary, onRouteSummary

Field Details

METADATA_EXTRACTOR

public static final MetadataExtractor METADATA_EXTRACTOR

Constructor Details

ResultCursorImpl

public ResultCursorImpl(DriverBoltConnection boltConnection,
 Query query,
 long fetchSize,
 Consumer<org.neo4j.driver.internal.DatabaseBookmark> bookmarkConsumer,
 boolean closeOnSummary,
 CompletableFuture<UnmanagedTransaction> beginFuture,
 Consumer<String> databaseNameConsumer,
 ApiTelemetryWork apiTelemetryWork,
 DriverObservationProvider observationProvider,
 Class<?> resultType)

Method Details

resultCursor

public CompletionStage<ResultCursorImpl> resultCursor()

keys

public List<String> keys()

Description copied from interface: ResultCursor

Retrieve the keys of the records this result cursor contains.

Specified by:

keys in interface ResultCursor

Returns:

list of all keys.

consumeAsync

public CompletionStage<ResultSummary> consumeAsync()

Description copied from interface: ResultCursor

Asynchronously retrieve the result summary.

If the records in the result is not fully consumed, then calling this method will exhausts the result.

If you want to access unconsumed records after summary, you shall use Result.list() to buffer all records into memory before summary.

Specified by:

consumeAsync in interface ResultCursor

Returns:

a CompletionStage completed with a summary for the whole query result. Stage can also be completed exceptionally if query execution fails.

nextAsync

public CompletionStage<Record> nextAsync()

Description copied from interface: ResultCursor

Asynchronously navigate to and retrieve the next Record in this result. Returned stage can contain null if end of records stream has been reached.

Specified by:

nextAsync in interface ResultCursor

Returns:

a CompletionStage completed with a record or null. Stage can also be completed exceptionally if query execution fails.

peekAsync

public CompletionStage<Record> peekAsync()

Description copied from interface: ResultCursor

Asynchronously investigate the next upcoming Record without moving forward in the result. Returned stage can contain null if end of records stream has been reached.

Specified by:

peekAsync in interface ResultCursor

Returns:

a CompletionStage completed with a record or null. Stage can also be completed exceptionally if query execution fails.

singleAsync

public CompletionStage<Record> singleAsync()

Description copied from interface: ResultCursor

Asynchronously return the first record in the result, failing if there is not exactly one record left in the stream.

Specified by:

singleAsync in interface ResultCursor

Returns:

a CompletionStage completed with the first and only record in the stream. Stage will be completed exceptionally with NoSuchRecordException if there is not exactly one record left in the stream. It can also be completed exceptionally if query execution fails.

forEachAsync

public CompletionStage<ResultSummary> forEachAsync(Consumer<Record> action)

Description copied from interface: ResultCursor

Asynchronously apply the given action to every record in the result, yielding a summary of it.

Specified by:

forEachAsync in interface ResultCursor

Parameters:

action - the function to be applied to every record in the result. Provided function should not block.

Returns:

a CompletionStage completed with a summary for the whole query result. Stage can also be completed exceptionally if query execution or provided function fails.

listAsync

public CompletionStage<List<Record>> listAsync()

Description copied from interface: ResultCursor

Asynchronously retrieve and store the entire result stream. This can be used if you want to iterate over the stream multiple times or to store the whole result for later use.

Note that this method can only be used if you know that the query that yielded this result returns a finite stream. Some queries can yield infinite results, in which case calling this method will lead to running out of memory.

Calling this method exhausts the result.

Specified by:

listAsync in interface ResultCursor

Returns:

a CompletionStage completed with a list of all remaining immutable records. Stage can also be completed exceptionally if query execution fails.

listAsync

public <T> CompletionStage<List<T>> listAsync(Function<Record,T> mapFunction)

Description copied from interface: ResultCursor

Asynchronously retrieve and store a projection of the entire result. This can be used if you want to iterate over the stream multiple times or to store the whole result for later use.

Note that this method can only be used if you know that the query that yielded this result returns a finite stream. Some queries can yield infinite results, in which case calling this method will lead to running out of memory.

Calling this method exhausts the result.

Specified by:

listAsync in interface ResultCursor

Type Parameters:

T - the type of result list elements

Parameters:

mapFunction - a function to map from Record to T. See Records for some predefined functions.

Returns:

a CompletionStage completed with a list of all remaining immutable records. Stage can also be completed exceptionally if query execution or provided function fails.

isOpenAsync

public CompletionStage<Boolean> isOpenAsync()

Description copied from interface: ResultCursor

Determine if result is open.

Result is considered to be open if it has not been consumed (ResultCursor.consumeAsync()) and its creator object (e.g. session or transaction) has not been closed (including committed or rolled back).

Attempts to access data on closed result will produce ResultConsumedException.

Specified by:

isOpenAsync in interface ResultCursor

Returns:

a CompletionStage completed with true if result is open and false otherwise.

onTelemetrySummary

public void onTelemetrySummary(org.neo4j.bolt.connection.summary.TelemetrySummary summary)

Specified by:

onTelemetrySummary in interface DriverResponseHandler

onBeginSummary

public void onBeginSummary(org.neo4j.bolt.connection.summary.BeginSummary summary)

Specified by:

onBeginSummary in interface DriverResponseHandler

onRunSummary

public void onRunSummary(org.neo4j.bolt.connection.summary.RunSummary summary)

Specified by:

onRunSummary in interface DriverResponseHandler

onRecord

public void onRecord(List<Value> fields)

Specified by:

onRecord in interface DriverResponseHandler

onError

public void onError(Throwable throwable)

Specified by:

onError in interface DriverResponseHandler

onIgnored

public void onIgnored()

Specified by:

onIgnored in interface DriverResponseHandler

onDiscardSummary

public void onDiscardSummary(DiscardSummary summary)

Specified by:

onDiscardSummary in interface DriverResponseHandler

onPullSummary

public void onPullSummary(PullSummary summary)

Specified by:

onPullSummary in interface DriverResponseHandler

onComplete

public void onComplete()

Specified by:

onComplete in interface DriverResponseHandler

discardAllFailureAsync

public CompletionStage<Throwable> discardAllFailureAsync(Observation parentObservation)

Description copied from interface: org.neo4j.driver.internal.FailableCursor

Discarding all unconsumed records and returning failure if there is any pull errors.

Specified by:

discardAllFailureAsync in interface org.neo4j.driver.internal.FailableCursor

pullAllFailureAsync

public CompletionStage<Throwable> pullAllFailureAsync(Observation parentObservation)

Description copied from interface: org.neo4j.driver.internal.FailableCursor

Pulling all unconsumed records into memory and returning failure if there is any pull errors.

Specified by:

pullAllFailureAsync in interface org.neo4j.driver.internal.FailableCursor

consumed

public CompletionStage<Void> consumed()

Specified by:

consumed in interface org.neo4j.driver.internal.FailableCursor