Class Key (3.0.1)

Key(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A unique identifier for a Datastore entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts.

Attributes

NameDescription
partition_id .storage.PartitionId
Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
path Sequence[.storage.Key.PathElement]
The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a *root entity*, the second element identifies a *child* of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's *ancestors*. A path can never be empty, and a path can have at most 100 elements.

Classes

PathElement

PathElement(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.