Notice: Over the next few months, we're reorganizing the App Engine documentation site to make it easier to find content and better align with the rest of Google Cloud products. The same content will be available, but the navigation will now match the rest of the Cloud products.

Python 3.10 is now available in preview.

google.appengine.api.datastore.Index

A datastore index.

Inherits From: expected_type

index_id Required long; Uniquely identifies the index
kind Required string; Specifies the kind of the entities to index
has_ancestor Required boolean; indicates if the index supports a query that filters entities by the entity group parent
properties Required list of (string, int) tuples; The entity properties to index. First item in a tuple is the property name and the second item is the sorting direction (ASCENDING|DESCENDING). The order of the properties is based on the order in the index.

Methods

HasAncestor

View source

Indicates if this is an ancestor index, a boolean.

Id

View source

Returns the index id, a long.

Kind

View source

Returns the index kind, a string. Empty string ('') if none.

Properties

View source

Returns the index properties. a tuple of (index name as a string, [ASCENDING|DESCENDING]) tuples.

__eq__

View source

Return self==value.

__ne__

View source

Return self!=value.

ASCENDING 1
BUILDING 0
DELETING 2
DESCENDING 2
ERROR 3
SERVING 1