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

Public Member Functions

def __init__
 
def DoDiff
 
def DoDelete
 

Public Attributes

 rpcserver
 
 error_fh
 

Detailed Description

Provide facilities for writing Index operation commands.

Constructor & Destructor Documentation

def google.appengine.tools.appcfg.IndexOperation.__init__ (   self,
  rpcserver,
  error_fh = sys.stderr 
)
Creates a new IndexOperation.

Args:
  rpcserver: The RPC server to use.  Should be an instance of HttpRpcServer
or TestRpcServer.
  error_fh: Where to send status and error messages.

Member Function Documentation

def google.appengine.tools.appcfg.IndexOperation.DoDelete (   self,
  definitions,
  app_id 
)
Delete indexes from the server.

Args:
  definitions: Index definitions to delete from datastore.
  app_id: The application id.

Returns:
  A single datstore_index.IndexDefinitions containing indexes that were
  not deleted, probably because they were already removed.  This may
  be normal behavior as there is a potential race condition between fetching
  the index-diff and sending deletion confirmation through.
def google.appengine.tools.appcfg.IndexOperation.DoDiff (   self,
  definitions 
)
Retrieve diff file from the server.

Args:
  definitions: datastore_index.IndexDefinitions as loaded from users
index.yaml file.

Returns:
  A pair of datastore_index.IndexDefinitions objects.  The first record
  is the set of indexes that are present in the index.yaml file but missing
  from the server.  The second record is the set of indexes that are
  present on the server but missing from the index.yaml file (indicating
  that these indexes should probably be vacuumed).

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