App Engine Python SDK  v1.6.9 rev.445
The Python runtime is available as an experimental Preview feature.
Public Member Functions | Static Public Attributes | List of all members
google.appengine.datastore.datastore_rpc.Configuration Class Reference
Inheritance diagram for google.appengine.datastore.datastore_rpc.Configuration:
google.appengine.datastore.datastore_rpc.BaseConfiguration google.appengine.datastore.datastore_query.FetchOptions google.appengine.datastore.datastore_rpc.TransactionOptions google.appengine.datastore.datastore_query.QueryOptions

Public Member Functions

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__
 

Static Public Attributes

int STRONG_CONSISTENCY = 0
 
int EVENTUAL_CONSISTENCY = 1
 
int APPLY_ALL_JOBS_CONSISTENCY = 2
 
tuple ALL_READ_POLICIES
 

Detailed Description

Configuration parameters for datastore RPCs.

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_'.

The options defined on this class include generic RPC parameters (deadline)
but also datastore-specific parameters (on_completion and read_policy).

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

Member Function Documentation

def google.appengine.datastore.datastore_rpc.Configuration.deadline (   value)
The deadline for any RPC issued.

If unset the system default will be used which is typically 5 seconds.

Raises:
  BadArgumentError if value is not a number or is less than zero.
def google.appengine.datastore.datastore_rpc.Configuration.force_writes (   value)
If a write request should succeed even if the app is read-only.

This only applies to user controlled read-only periods.
def google.appengine.datastore.datastore_rpc.Configuration.max_allocate_ids_keys (   value)
The maximum number of keys in a v4 AllocateIds rpc.
def google.appengine.datastore.datastore_rpc.Configuration.max_delete_keys (   value)
The maximum number of keys in a Delete without batching.
def google.appengine.datastore.datastore_rpc.Configuration.max_entity_groups_per_rpc (   value)
The maximum number of entity groups that can be represented in one rpc.

For a non-transactional operation that involves more entity groups than the
maximum, the operation will be performed by executing multiple, asynchronous
rpcs to the datastore, each of which has no more entity groups represented
than the maximum.  So, if a put() operation has 8 entity groups and the
maximum is 3, we will send 3 rpcs, 2 with 3 entity groups and 1 with 2
entity groups.  This is a performance optimization - in many cases
multiple, small, concurrent rpcs will finish faster than a single large
rpc.  The optimal value for this property will be application-specific, so
experimentation is encouraged.
def google.appengine.datastore.datastore_rpc.Configuration.max_get_keys (   value)
The maximum number of keys in a Get without batching.
def google.appengine.datastore.datastore_rpc.Configuration.max_put_entities (   value)
The maximum number of entities in a Put without batching.
def google.appengine.datastore.datastore_rpc.Configuration.max_rpc_bytes (   value)
The maximum serialized size of a Get/Put/Delete without batching.
def google.appengine.datastore.datastore_rpc.Configuration.on_completion (   value)
A callback that is invoked when any RPC completes.

If specified, it will be called with a UserRPC object as argument when an
RPC completes.

NOTE: There is a subtle but important difference between
UserRPC.callback and Configuration.on_completion: on_completion is
called with the RPC object as its first argument, where callback is
called without arguments.  (Because a Configuration's on_completion
function can be used with many UserRPC objects, it would be awkward
if it was called without passing the specific RPC.)
def google.appengine.datastore.datastore_rpc.Configuration.read_policy (   value)
The read policy to use for any relevent RPC.

if unset STRONG_CONSISTENCY will be used.

Raises:
  BadArgumentError if value is not a known read policy.

Member Data Documentation

tuple google.appengine.datastore.datastore_rpc.Configuration.ALL_READ_POLICIES
static
Initial value:
1 = frozenset((STRONG_CONSISTENCY,
2  EVENTUAL_CONSISTENCY,
3  APPLY_ALL_JOBS_CONSISTENCY,
4  ))

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