Class Query.QueryPaginator (2.89.0)

public static class Query.QueryPaginator

A Query Paginator that will split a query into small chunks. See Query#createPaginator(int) for example usage.

Inheritance

java.lang.Object > Query.QueryPaginator

Methods

advance(ByteString lastSeenRowKey)

public boolean advance(ByteString lastSeenRowKey)

Construct the next query. Return true if there are more queries to return. False if we've read everything.

Parameter
Name Description
lastSeenRowKey ByteString

the key of the last row received across the pagination loop. Initialize this to ByteString#EMPTY before the loop and update it as each row is read (see #createPaginator(int)). If the first page is empty, ByteString#EMPTY signals completion; if a subsequent page is empty, passing the unchanged key from the previous page signals completion.

Returns
Type Description
boolean

getNextQuery()

public Query getNextQuery()

Return the next query.

Returns
Type Description
Query

getPageSize()

public int getPageSize()

Get the page size of the current Pagniator. For internal use only.

Returns
Type Description
int