Class GqlQuery<V> (2.19.0)

Version latest

• 2.19.0 (latest)
• 2.18.5
• 2.17.6

public final class GqlQuery<V> extends Query<V> implements RecordQuery<V>

A Google Cloud Datastore GQL query.

A usage example:

When the type of the results is known the preferred usage would be:

 Query<Entity> query =
     Query.newGqlQueryBuilder(Query.ResultType.ENTITY, "select * from kind").build();
 QueryResults<Entity> results = datastore.run(query);
 while (results.hasNext()) {
   Entity entity = results.next();
   ...
 }
 

When the type of the results is unknown you can use this approach:

 Query query = Query.newGqlQueryBuilder("select __key__ from kind").build();
 QueryResults results = datastore.run(query);
 if (Key.class.isAssignableFrom(results.getResultClass())) {
   QueryResults<Key> keys = (QueryResults<Key>) results;
   while (keys.hasNext()) {
     Key key = keys.next();
     ...
   }
 }
 

See Also: GQL Reference

Inheritance

Object > Query > GqlQuery<V>

Implements

RecordQuery<V>

Inherited Members

Query.<V>newGqlQueryBuilder(Query.ResultType<V>,String)

Query.getNamespace()

Query.newAggregationQueryBuilder()

Query.newEntityQueryBuilder()

Query.newGqlQueryBuilder(String)

Query.newKeyQueryBuilder()

Query.newProjectionEntityQueryBuilder()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Type Parameter
Name	Description
V

Methods

allowLiteral()

public boolean allowLiteral()

Returns whether the query string can contain literals. When false, the query string must not contain any literals and instead must bind all values.

Returns
Type	Description
boolean

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

Object.equals(Object)

getNamedBindings()

public Map<String,Object> getNamedBindings()

Returns an immutable map of named bindings.

Returns
Type	Description
Map<String,Object>

getNamedBindingsMap()

public Map<String,GqlQuery.Binding> getNamedBindingsMap()

Returns
Type	Description
Map<String,com.google.cloud.datastore.GqlQuery.Binding>

getNumberArgs()

public List<Object> getNumberArgs()

Returns an immutable list of positional bindings (using original order).

Returns
Type	Description
List<Object>

getPositionalBindingsMap()

public List<GqlQuery.Binding> getPositionalBindingsMap()

Returns
Type	Description
List<com.google.cloud.datastore.GqlQuery.Binding>

getQueryString()

public String getQueryString()

Returns the query string for this query.

Returns
Type	Description
String

getType()

public Query.ResultType<V> getType()

Returns
Type	Description
ResultType<V>

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

Object.hashCode()

nextQuery(RunQueryResponse responsePb)

public RecordQuery<V> nextQuery(RunQueryResponse responsePb)

Parameter
Name	Description
responsePb	RunQueryResponse

Returns
Type	Description
RecordQuery<V>

populatePb(RunQueryRequest.Builder requestPb)

public void populatePb(RunQueryRequest.Builder requestPb)

Parameter
Name	Description
requestPb	RunQueryRequest.Builder

toString()

public String toString()

Returns
Type	Description
String

Overrides

Object.toString()