App Engine Python SDK  v1.6.9 rev.445
The Python runtime is available as an experimental Preview feature.
Public Member Functions | List of all members
google.appengine.ext.db.GqlQuery Class Reference
Inheritance diagram for google.appengine.ext.db.GqlQuery:
google.appengine.ext.db._BaseQuery google.appengine.ext.blobstore.blobstore._GqlQuery

Public Member Functions

def __init__
 
def is_keys_only
 
def projection
 
def is_distinct
 
def bind
 
def run
 
- Public Member Functions inherited from google.appengine.ext.db._BaseQuery
def __init__
 
def is_keys_only
 
def projection
 
def is_distinct
 
def run
 
def __iter__
 
def __getstate__
 
def get
 
def count
 
def fetch
 
def index_list
 
def cursor
 
def with_cursor
 
def __getitem__
 

Detailed Description

A Query class that uses GQL query syntax instead of .filter() etc.

Constructor & Destructor Documentation

def google.appengine.ext.db.GqlQuery.__init__ (   self,
  query_string,
  args,
  kwds 
)
Constructor.

Args:
  query_string: Properly formatted GQL query string.
  *args: Positional arguments used to bind numeric references in the query.
  **kwds: Dictionary-based arguments for named references.

Raises:
  PropertyError if the query filters or sorts on a property that's not
  indexed.

Member Function Documentation

def google.appengine.ext.db.GqlQuery.bind (   self,
  args,
  kwds 
)
Bind arguments (positional or keyword) to the query.

Note that you can also pass arguments directly to the query
constructor.  Each time you call bind() the previous set of
arguments is replaced with the new set.  This is useful because
the hard work in in parsing the query; so if you expect to be
using the same query with different sets of arguments, you should
hold on to the GqlQuery() object and call bind() on it each time.

Args:
  *args: Positional arguments used to bind numeric references in the query.
  **kwds: Dictionary-based arguments for named references.
def google.appengine.ext.db.GqlQuery.run (   self,
  kwargs 
)
Iterator for this query that handles the LIMIT clause property.

If the GQL query string contains a LIMIT clause, this function fetches
all results before returning an iterator. Otherwise results are retrieved
in batches by the iterator.

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

Returns:
  Iterator for this query.

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