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

Public Member Functions

def __init__
 
def initialize
 
def finalize
 
def apply
 
def batch_apply
 
def map_over_keys_only
 

Static Public Member Functions

def RegisterMapper
 
def RegisteredMappers
 
def RegisteredMapper
 

Static Public Attributes

 kind = None
 

Detailed Description

A base class for serializing datastore entities.

To add a handler for exporting an entity kind from your datastore,
write a subclass of this class that calls Mapper.__init__ from your
class's __init__.

You need to implement to batch_apply or apply method on your subclass
for the map to do anything.

Constructor & Destructor Documentation

def google.appengine.tools.bulkloader.Mapper.__init__ (   self,
  kind 
)
Constructor.

Populates this Mappers's kind.

Args:
  kind: a string containing the entity kind that this mapper handles

Member Function Documentation

def google.appengine.tools.bulkloader.Mapper.finalize (   self)
Performs finalization actions after the download completes.
def google.appengine.tools.bulkloader.Mapper.initialize (   self,
  mapper_opts 
)
Performs initialization.

Args:
  mapper_opts: The string given as the --mapper_opts flag argument.
def google.appengine.tools.bulkloader.Mapper.map_over_keys_only (   self)
Return whether this mapper should iterate over only keys or not.

Override this method in subclasses to return True values.

Returns:
  True or False
def google.appengine.tools.bulkloader.Mapper.RegisteredMapper (   kind)
static
Returns an mapper instance for the given kind if it exists.
def google.appengine.tools.bulkloader.Mapper.RegisteredMappers ( )
static
Returns a dictionary of the mapper instances that have been created.
def google.appengine.tools.bulkloader.Mapper.RegisterMapper (   mapper)
static
Register mapper and the Mapper instance for its kind.

Args:
  mapper: A Mapper instance.

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