Package com.couchbase.analytics.client.java

Class QueryResultHandle

java.lang.Object

com.couchbase.analytics.client.java.QueryResultHandle

All Implemented Interfaces:

RowSource

@ThreadSafe
public class QueryResultHandle
extends Object

A handle for the result of a completed query.

See Also:

• RowSource.streamRows(Consumer, Consumer)
• RowSource.bufferRows(Consumer)

Method Summary

Modifier and Type	Method	Description
void	discard()
boolean	ordered()
List<PartitionHandle>	partitions()
long	rowCount()	Returns the number of result rows.
QueryMetadata	streamRows(Consumer<Row> rowAction, Consumer<RowOptions> options)	Fetches result rows and passes them to the given rowAction callback, one by one as they arrive from the server.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.couchbase.analytics.client.java.RowSource

bufferRows, bufferRows, streamRows

Method Details

ordered

public boolean ordered()

partitions

@Experimental
public List<PartitionHandle> partitions()

discard

public void discard()

rowCount

public long rowCount()

Description copied from interface: RowSource

Returns the number of result rows.

Specified by:

rowCount in interface RowSource

streamRows

public QueryMetadata streamRows(Consumer<Row> rowAction,
 Consumer<RowOptions> options)

Description copied from interface: RowSource

Fetches result rows and passes them to the given rowAction callback, one by one as they arrive from the server.

The callback action is guaranteed to execute in the same thread (or virtual thread) that called this method. If the callback throws an exception, the exception is re-thrown by this method.

Prefer this over RowSource.bufferRows() when it's unknown whether the rows fit in memory.

Specified by:

streamRows in interface RowSource

Parameters:

options - A callback for specifying custom options.