Python 3.9 is now generally available.

google.appengine.ext.ndb.StructuredProperty

A Property whose value is itself an entity.

Inherits From: Property, ModelAttribute, expected_type

The values of the sub-entity are indexed and can be queried.

See the module docstring for details.

Methods

IN

View source

Comparison operator for the 'in' comparison operator.

The Python 'in' operator cannot be overloaded in the way we want to, so we define a method. For example::

Employee.query(Employee.rank.IN([4, 5, 6]))

Note that the method is called ._IN() but may normally be invoked as .IN(); ._IN() is provided for the case you have a StructuredProperty with a model that has a Property named IN.

__eq__

View source

Return a FilterNode instance representing the '=' comparison.

__ge__

View source

Return a FilterNode instance representing the '>=' comparison.

__gt__

View source

Return a FilterNode instance representing the '>' comparison.

__le__

View source

Return a FilterNode instance representing the '<=' comparison.

__lt__

View source

Return a FilterNode instance representing the '<' comparison.

__ne__

View source

Return a FilterNode instance representing the '!=' comparison.

__neg__

View source

Return a descending sort order on this Property.

For example::

Employee.query().order(-Employee.rank)

__pos__

View source

Return an ascending sort order on this Property.

Note that this is redundant but provided for consistency with neg. For example, the following two are equivalent::

Employee.query().order(+Employee.rank) Employee.query().order(Employee.rank)