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.datastore.datastore_query.FetchOptions Class Reference
Inheritance diagram for google.appengine.datastore.datastore_query.FetchOptions:
google.appengine.datastore.datastore_rpc.Configuration google.appengine.datastore.datastore_rpc.BaseConfiguration google.appengine.datastore.datastore_query.QueryOptions

Public Member Functions

def produce_cursors
 
def offset
 
def batch_size
 
- Public Member Functions inherited from google.appengine.datastore.datastore_rpc.Configuration
def deadline
 
def on_completion
 
def read_policy
 
def force_writes
 
def max_entity_groups_per_rpc
 
def max_allocate_ids_keys
 
def max_rpc_bytes
 
def max_get_keys
 
def max_put_entities
 
def max_delete_keys
 
- Public Member Functions inherited from google.appengine.datastore.datastore_rpc.BaseConfiguration
def __new__
 
def __eq__
 
def __ne__
 
def __hash__
 
def __repr__
 
def is_configuration
 
def merge
 
def __getstate__
 
def __setstate__
 

Additional Inherited Members

- Static Public Attributes inherited from google.appengine.datastore.datastore_rpc.Configuration
int STRONG_CONSISTENCY = 0
 
int EVENTUAL_CONSISTENCY = 1
 
int APPLY_ALL_JOBS_CONSISTENCY = 2
 
tuple ALL_READ_POLICIES
 

Detailed Description

An immutable class that contains all options for fetching results.

These options apply to any request that pulls results from a query.

This class reserves the right to define configuration options of any name
except those that start with 'user_'. External subclasses should only define
function or variables with names that start with in 'user_'.

Options are set by passing keyword arguments to the constructor corresponding
to the configuration options defined below and in datastore_rpc.Configuration.

This object can be used as the default config for a datastore_rpc.Connection
but in that case some options will be ignored, see option documentation below
for details.

Member Function Documentation

def google.appengine.datastore.datastore_query.FetchOptions.batch_size (   value)
The number of results to attempt to retrieve in a batch.

Raises:
  datastore_errors.BadArgumentError if value is not a integer or is not
  greater than zero.
def google.appengine.datastore.datastore_query.FetchOptions.offset (   value)
The number of results to skip before returning the first result.

Only applies to the first request it is used with and is ignored if present
on datastore_rpc.Connection.config.

Raises:
  datastore_errors.BadArgumentError if value is not a integer or is less
  than zero.
def google.appengine.datastore.datastore_query.FetchOptions.produce_cursors (   value)
If a Cursor should be returned with the fetched results.

Raises:
  datastore_errors.BadArgumentError if value is not a bool.

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