Notice: Over the next few months, we're reorganizing the App Engine documentation site to make it easier to find content and better align with the rest of Google Cloud products. The same content will be available, but the navigation will now match the rest of the Cloud products.

Python 3.10 is now generally available.

Module: google.appengine.datastore.datastore_query

A thin wrapper around datastore query RPC calls.

This provides wrappers around the internal only datastore_pb library and is designed to be the lowest-level API to be used by all Python datastore client libraries for executing queries. It provides a layer of protection so the actual RPC syntax can change without affecting client libraries.

Any class, function, field or argument starting with an '_' is for INTERNAL use only and should not be used by developers!

Classes

class Batch: A batch of results returned by a query.

class Batcher: A class that implements the Iterator interface for Batches.

class CompositeFilter: An immutable filter predicate that combines other predicates.

class CompositeOrder: An immutable class that represents a sequence of Orders.

class CorrelationFilter: A filter that isolates correlated values and applies a sub-filter on them.

class Cursor: An immutable class that represents a relative position in a query.

class FetchOptions: An immutable class that contains all options for fetching results.

class FilterPredicate: An abstract base class for all query filters.

class Order: A base class that represents a sort order on a query.

class PropertyFilter: An immutable filter predicate that constrains a single property.

class PropertyOrder: An immutable class that represents a sort order for a single property.

class Query: An immutable class that represents a query signature.

class QueryOptions: An immutable class that contains all options for running a query.

class ResultsIterator: An iterator over the results from Batches obtained from a Batcher.

Functions

apply_query(...): Performs the given query on a set of in-memory results.

inject_results(...): Creates a query object that will inject changes into results.

make_filter(...): Constructs a FilterPredicate from the given name, op and values.