App Engine Python SDK  v1.6.9 rev.445
The Python runtime is available as an experimental Preview feature.
Classes | Public Member Functions | Static Public Attributes | List of all members
google.appengine.api.datastore.MultiQuery Class Reference
Inheritance diagram for google.appengine.api.datastore.MultiQuery:
google.appengine.api.datastore.Query

Classes

class  SortOrderEntity
 

Public Member Functions

def __init__
 
def __str__
 
def Get
 
def Run
 
def Count
 
def GetIndexList
 
def GetCursor
 
def __setitem__
 
def __delitem__
 
def __iter__
 
- Public Member Functions inherited from google.appengine.api.datastore.Query
def __init__
 
def Order
 
def Hint
 
def Ancestor
 
def IsKeysOnly
 
def GetQueryOptions
 
def GetQuery
 
def GetOrder
 
def GetFilterPredicate
 
def GetDistinct
 
def GetIndexList
 
def GetCursor
 
def GetBatcher
 
def Run
 
def Get
 
def Count
 
def __iter__
 
def __getstate__
 
def __setstate__
 
def __setitem__
 
def setdefault
 
def __delitem__
 
def update
 
def copy
 

Static Public Attributes

 GetCompiledCursor = GetCursor
 
 GetCompiledQuery = _GetCompiledQuery
 
- Static Public Attributes inherited from google.appengine.api.datastore.Query
 ASCENDING = datastore_query.PropertyOrder.ASCENDING
 
 DESCENDING = datastore_query.PropertyOrder.DESCENDING
 
 ORDER_FIRST = datastore_query.QueryOptions.ORDER_FIRST
 
 ANCESTOR_FIRST = datastore_query.QueryOptions.ANCESTOR_FIRST
 
 FILTER_FIRST = datastore_query.QueryOptions.FILTER_FIRST
 
dictionary OPERATORS = {'==': datastore_query.PropertyFilter._OPERATORS['=']}
 
 INEQUALITY_OPERATORS = datastore_query.PropertyFilter._INEQUALITY_OPERATORS
 
tuple UPPERBOUND_INEQUALITY_OPERATORS = frozenset(['<', '<='])
 
tuple FILTER_REGEX
 
 GetCompiledQuery = _GetCompiledQuery
 
 GetCompiledCursor = GetCursor
 

Detailed Description

Class representing a query which requires multiple datastore queries.

This class is actually a subclass of datastore.Query as it is intended to act
like a normal Query object (supporting the same interface).

Does not support keys only queries, since it needs whole entities in order
to merge sort them. (That's not true if there are no sort orders, or if the
sort order is on __key__, but allowing keys only queries in those cases, but
not in others, would be confusing.)

Member Function Documentation

def google.appengine.api.datastore.MultiQuery.__delitem__ (   self,
  query_filter 
)
Delete a filter by deleting it from all subqueries.

If a KeyError is raised during the attempt, it is ignored, unless
every subquery raised a KeyError. If any other exception is
raised, any deletes will be rolled back.

Args:
  query_filter: the filter to delete.

Raises:
  KeyError: No subquery had an entry containing query_filter.
def google.appengine.api.datastore.MultiQuery.__setitem__ (   self,
  query_filter,
  value 
)
Add a new filter by setting it on all subqueries.

If any of the setting operations raise an exception, the ones
that succeeded are undone and the exception is propagated
upward.

Args:
  query_filter: a string of the form "property operand".
  value: the value that the given property is compared against.
def google.appengine.api.datastore.MultiQuery.Count (   self,
  limit = 1000,
  kwargs 
)
Return the number of matched entities for this query.

Will return the de-duplicated count of results.  Will call the more
efficient Get() function if a limit is given.

Args:
  limit: maximum number of entries to count (for any result > limit, return
  limit).
  config: Optional Configuration to use for this request.

Returns:
  count of the number of entries returned.
def google.appengine.api.datastore.MultiQuery.Get (   self,
  limit,
  offset = 0,
  kwargs 
)
Deprecated, use list(Run(...)) instead.

Args:
  limit: int or long representing the maximum number of entities to return.
  offset: int or long representing the number of entities to skip
  kwargs: Any keyword arguments accepted by datastore_query.QueryOptions().

Returns:
  A list of entities with at most "limit" entries (less if the query
  completes before reading limit values).
def google.appengine.api.datastore.MultiQuery.Run (   self,
  kwargs 
)
Return an iterable output with all results in order.

Merge sort the results. First create a list of iterators, then walk
though them and yield results in order.

Args:
  kwargs: Any keyword arguments accepted by datastore_query.QueryOptions().

Returns:
  An iterator for the result set.

The documentation for this class was generated from the following file: