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.search.SearchableEntity Class Reference
Inheritance diagram for google.appengine.ext.search.SearchableEntity:

Public Member Functions

def __init__
 
def IndexPropertyName
 

Detailed Description

A subclass of datastore.Entity that supports full text indexing.

Automatically indexes all string and Text properties, using the datastore's
built-in per-property indices. To search, use the SearchableQuery class and
its Search() method.

Constructor & Destructor Documentation

def google.appengine.ext.search.SearchableEntity.__init__ (   self,
  kind_or_entity,
  word_delimiter_regex = None,
  args,
  kwargs 
)
Constructor. May be called as a copy constructor.

If kind_or_entity is a datastore.Entity, copies it into this Entity.
datastore.Get() and Query() returns instances of datastore.Entity, so this
is useful for converting them back to SearchableEntity so that they'll be
indexed when they're stored back in the datastore.

Otherwise, passes through the positional and keyword args to the
datastore.Entity constructor.

Args:
  kind_or_entity: string or datastore.Entity
  word_delimiter_regex: a regex matching characters that delimit words

Member Function Documentation

def google.appengine.ext.search.SearchableEntity.IndexPropertyName (   cls,
  properties 
)
Given index definition, returns the name of the property to put it in.

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