com.google.cloud.datastore

Interface QueryResults<V>

Type Parameters:

V - the type of the results value.

All Superinterfaces:

Iterator<V>

public interface QueryResults<V>
extends Iterator<V>

The result of a Google Cloud Datastore query submission. When the result is not typed it is possible to cast it to its appropriate type according to the resultClass() value. Results are loaded lazily in batches, where batch size is set by Cloud Datastore. As a result, it is possible to get a DatastoreException upon hasNext or next calls.

Method Summary

Methods

Modifier and Type	Method and Description
Cursor	cursorAfter() Deprecated.
Cursor	getCursorAfter() Returns the Cursor for the point after the value returned in the last Iterator.next() call.
Class<?>	getResultClass() Returns the actual class of the result's values.
Class<?>	resultClass() Deprecated.

Methods inherited from interface java.util.Iterator

hasNext, next, remove

Method Detail

resultClass

@Deprecated
Class<?> resultClass()

Deprecated.

Returns the actual class of the result's values.

getResultClass

Class<?> getResultClass()

Returns the actual class of the result's values.

cursorAfter

@Deprecated
Cursor cursorAfter()

Deprecated.

Returns the Cursor for the point after the value returned in the last Iterator.next() call. This cursor can be used to issue subsequent queries (with the same constraints) that may return additional results.

A simple use case:

 Query<Entity> query = Query.newEntityQueryBuilder()
     .setKind("Person")
     .setFilter(PropertyFilter.eq("favoriteFood", "pizza"))
     .build();
 QueryResults<Entity> results = datastore.run(query);
 // Consume some results (using results.next()) and do any other actions as necessary.
 query = query.toBuilder().setStartCursor(results.getCursorAfter()).build();
 results = datastore.run(query); // now we will iterate over all entities not yet consumed
 

getCursorAfter

Cursor getCursorAfter()

Returns the Cursor for the point after the value returned in the last Iterator.next() call. This cursor can be used to issue subsequent queries (with the same constraints) that may return additional results.

A simple use case:

 Query<Entity> query = Query.newEntityQueryBuilder()
     .setKind("Person")
     .setFilter(PropertyFilter.eq("favoriteFood", "pizza"))
     .build();
 QueryResults<Entity> results = datastore.run(query);
 // Consume some results (using results.next()) and do any other actions as necessary.
 query = query.toBuilder().setStartCursor(results.getCursorAfter()).build();
 results = datastore.run(query); // now we will iterate over all entities not yet consumed