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

Public Member Functions

def __init__
 
def name
 
def expression
 
def __repr__
 

Static Public Attributes

int MAXIMUM_EXPRESSION_LENGTH = 1000
 
int MAXIMUM_OPERATOR_LENGTH = 100
 

Detailed Description

Represents an expression that will be computed for each result returned.

For example,
  FieldExpression(name='content_snippet',
                  expression='snippet("very important", content)')
means a computed field 'content_snippet' will be returned with each search
result, which contains HTML snippets of the 'content' field which match
the query 'very important'.

Constructor & Destructor Documentation

def google.appengine.api.search.search.FieldExpression.__init__ (   self,
  name,
  expression 
)
Initializer.

Args:
  name: The name of the computed field for the expression.
  expression: The expression to evaluate and return in a field with
given name in results. See
https://developers.google.com/appengine/docs/python/search/overview#Expressions
for a list of legal expressions.

Raises:
  TypeError: If any of the parameters has an invalid type, or an unknown
attribute is passed.
  ValueError: If any of the parameters has an invalid value.
  ExpressionError: If the expression string is not parseable.

Member Function Documentation

def google.appengine.api.search.search.FieldExpression.expression (   self)
Returns a string containing an expression returned in search results.
def google.appengine.api.search.search.FieldExpression.name (   self)
Returns name of the expression to return in search results.

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