com.google.cloud.datastore

Class GqlQuery<V>

java.lang.Object

com.google.cloud.datastore.Query<V>

com.google.cloud.datastore.GqlQuery<V>

Type Parameters:

V - the type of the result values this query will produce

All Implemented Interfaces:

Serializable

public final class GqlQuery<V>
extends Query<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, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GqlQuery.Builder<V> A GQL query builder.

Nested classes/interfaces inherited from class com.google.cloud.datastore.Query

Query.ResultType<V>

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowLiteral() Returns whether the query string can contain literals.
boolean	equals(Object obj)
Map<String,Object>	getNamedBindings() Returns an immutable map of named bindings.
List<Object>	getNumberArgs() Returns an immutable list of positional bindings (using original order).
String	getQueryString() Returns the query string for this query.
int	hashCode()
Map<String,Object>	namedBindings() Deprecated.
List<Object>	numberArgs() Deprecated.
String	queryString() Deprecated.
String	toString()

Methods inherited from class com.google.cloud.datastore.Query

entityQueryBuilder, getNamespace, gqlQueryBuilder, gqlQueryBuilder, keyQueryBuilder, namespace, newEntityQueryBuilder, newGqlQueryBuilder, newGqlQueryBuilder, newKeyQueryBuilder, newProjectionEntityQueryBuilder, projectionEntityQueryBuilder

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

queryString

@Deprecated
public String queryString()

Deprecated.

Returns the query string for this query.

getQueryString

public String getQueryString()

Returns the query string for this query.

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.

namedBindings

@Deprecated
public Map<String,Object> namedBindings()

Deprecated.

Returns an immutable map of named bindings.

getNamedBindings

public Map<String,Object> getNamedBindings()

Returns an immutable map of named bindings.

numberArgs

@Deprecated
public List<Object> numberArgs()

Deprecated.

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

getNumberArgs

public List<Object> getNumberArgs()

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

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object