Hinweis: Python 2.7 hat am 31. Januar 2024 das Ende des Supports erreicht. Ihre vorhandenen Python 2.7-Anwendungen werden weiterhin ausgeführt und erhalten Traffic. App Engine kann die erneute Bereitstellung von Anwendungen, die Laufzeiten verwenden, jedoch nach dem Enddatum des Supports blockieren. Wir empfehlen die Migration zur neuesten unterstützten Version von Python.

Modul google.appengine.ext.ndb.metadata

Übersicht

Modelle und Hilfsfunktionen für den Zugriff auf die Datenspeicher-Metadaten der Anwendung.

Diese Entitäten können nicht von Nutzern erstellt werden, sondern sind das Resultat von Metadatenabfragen vom Typ "__namespace__", "__kind__", "__property__" und "__entity_group__" oder "gets":

Eine vereinfachte API wird ebenfalls angeboten:

ndb.metadata.get_namespaces(): Eine Liste von Namespace-Namen. ndb.metadata.get_kinds(): Eine Liste von Artnamen. ndb.metadata.get_properties_of_kind(kind):

Eine Liste von Property-Namen für den angegebenen Artnamen.

ndb.metadata.get_representations_of_kind(kind):: Ein Dictionary, das Property-Namen Listen von Darstellungs-IDs zuordnet.
ndb.metadata.get_entity_group_version(key):: Die Version der Entitätengruppe, die den Schlüssel enthält (nur HRD).

get_kinds(), get_properties_of_kind(), get_representations_of_kind() gelten implizit für den aktuellen Namespace.

get_namespaces(), get_kinds(), get_properties_of_kind(), get_representations_of_kind() haben optionale Start- und Endargumente, um die Abfrage auf einen Namensbereich zu beschränken. Beispiel: "start <= name < end".

Inhalt

Klasse google.appengine.ext.ndb.metadata.Namespace(*args, **kwds)Quelle

Basis: google.appengine.ext.ndb.metadata._BaseMetadata

Modell für Ergebnisse der Metadatenabfrage "__namespace__".

EMPTY_NAMESPACE_ID = 1

KIND_NAME = '__namespace__'

classmethod key_for_namespace(namespace)source

Gibt den Schlüssel für einen Namespace zurück.

Parameter

namespace: Ein String, der den Namespace bereitstellt, dessen Schlüssel angefordert wird.

Gibt Folgendes zurück:

Den Schlüssel für den Namespace.

classmethod key_to_namespace(key)source

Gibt den durch den jeweiligen Schlüssel "__namespace__" angegebenen Namespace zurück.

Parameter

key: Der Schlüssel, dessen Name angefordert wird.

Gibt Folgendes zurück:

Den vom Schlüssel angegebenen Namespace.

namespace_name: Gibt den vom Schlüssel dieser Entität festgelegten Namespace-Namen zurück.

Klasse google.appengine.ext.ndb.metadata.Kind(*args, **kwds)Quelle

Basis: google.appengine.ext.ndb.metadata._BaseMetadata

Modell für Ergebnisse der Metadatenabfrage "__kind__".

KIND_NAME = '__kind__'

classmethod key_for_kind(kind)source

Gibt den Schlüssel "__kind__" für den Typ zurück.

Parameter

kind: Die Art, deren Schlüssel angefordert wird.

Gibt Folgendes zurück:

Den Schlüssel für die Art.

classmethod key_to_kind(key)source

Gibt die Art zurück, die durch den jeweiligen Schlüssel "__kind__" angegeben wurde.

Parameter

key: Der Schlüssel, dessen Name angefordert wird.

Gibt Folgendes zurück:

Die vom Schlüssel angegebene Art.

kind_name: Gibt den vom Schlüssel dieser Entität festgelegten Artnamen zurück.

Klasse google.appengine.ext.ndb.metadata.Property(*args, **kwds)Quelle

Basis: google.appengine.ext.ndb.metadata._BaseMetadata

Modell für Ergebnisse der Metadatenabfrage "__property__".

KIND_NAME = '__property__'

classmethod key_for_kind(kind)source

Gibt den Schlüssel "__property__" für die Art zurück.

Parameter

kind: Die Art, deren Schlüssel angefordert wird.

Gibt Folgendes zurück:

Den übergeordneten Schlüssel für die Schlüssel "__property__" der Art.

classmethod key_for_property(kind, property)source

Gibt den Schlüssel "__property__" für die Property der Art zurück.

Parameter

kind: Die Art, deren Schlüssel angefordert wird.
property: Die Property, deren Schlüssel angefordert wird.

Returns

Den Schlüssel für die Property der Art.

classmethod key_to_kind(key)source

Gibt die Art zurück, die durch den jeweiligen Schlüssel "__property__" angegeben wurde.

Parameter

key: Der Schlüssel, dessen Artname angefordert wird.

Gibt Folgendes zurück:

Die vom Schlüssel angegebene Art.

classmethod key_to_property(key)source

Gibt die Property zurück, die durch den jeweiligen Schlüssel "__property__" angegeben wurde.

Parameter

key: Der Schlüssel, dessen Property-Name angefordert wird.

Gibt Folgendes zurück:

Die vom Schlüssel angegebene Property, oder "None", wenn mit dem Schlüssel nur eine Art angegeben wurde.

kind_name: Gibt den vom Schlüssel dieser Entität festgelegten Artnamen zurück.

property_name: Gibt den vom Schlüssel dieser Entität festgelegten Property-Namen zurück.

property_representation: Eine indexierte Property, deren Wert ein Textstring begrenzter Länge ist.

Klasse google.appengine.ext.ndb.metadata.EntityGroup(*args, **kwds)Quelle

Basis: google.appengine.ext.ndb.metadata._BaseMetadata

Modell für Metadaten vom Typ "__entity_group__" (nur im HR-Datenspeicher verfügbar).

Diese Metadaten enthalten die numerische Property "__version__", die sich bei jeder Änderung an der Entitätengruppe garantiert erhöht. Die Version kann sogar erhöht werden, wenn keine für den Nutzer sichtbaren Änderungen an der Entitätengruppe vorhanden sind. Die Entität "__entity_group__" existiert möglicherweise nicht, wenn nie in die Entitätengruppe geschrieben wurde.

ID = 1

KIND_NAME = '__entity_group__'

Klassenmethode key_for_entity_group(key)source

Gibt den Schlüssel für die Entitätengruppe zurück, die den Schlüssel enthält.

Parameter

key: Ein Schlüssel für eine Entitätengruppe, deren Schlüssel für "__entity_group__" Sie abrufen möchten.

Gibt Folgendes zurück:

Den Schlüssel "__entity_group__" für die Entitätengruppe, die den Schlüssel enthält.

version: Eine Property, deren Wert den Python-Typ "int" oder "long" (oder "bool") hat.

google.appengine.ext.ndb.metadata.get_namespaces(start=None, end=None)source

Gibt alle Namespaces im angegebenen Bereich zurück.

Parameter

start: Gibt nur Namespaces ">= start" zurück, wenn der Startwert nicht auf "None" gesetzt ist.
end: Gibt nur Namespaces "< end" zurück, wenn der Endwert nicht auf "None" gesetzt ist.

Returns

Eine Liste von Namespace-Namen zwischen den (optionalen) Start- und Endwerten.

google.appengine.ext.ndb.metadata.get_kinds(start=None, end=None)source

Gibt alle Arten im angegebenen Bereich für den aktuellen Namespace zurück.

Parameter

start: Gibt nur Arten ">= start" zurück, wenn der Startwert nicht auf "None" gesetzt ist.
end: Gibt nur Arten "< end" zurück, wenn der Endwert nicht auf "None" gesetzt ist.

Returns

Eine Liste von Artnamen zwischen den (optionalen) Start- und Endwerten.

google.appengine.ext.ndb.metadata.get_properties_of_kind(kind, start=None, end=None)source

Gibt alle Properties der Art im angegebenen Bereich zurück.

HINWEIS: Mit dieser Funktion werden keine nicht indexierten Properties zurückgegeben.

Parameter

kind: Name der Art, deren Properties Sie abrufen möchten.
start: Gibt nur Properties ">= start" zurück, wenn der Startwert nicht auf "None" gesetzt ist.
end: Gibt nur Properties "< end" zurück, wenn der Endwert nicht auf "None" gesetzt ist.

Returns

Eine Liste von Property-Namen der Art zwischen den (optionalen) Start- und Endwerten.

google.appengine.ext.ndb.metadata.get_representations_of_kind(kind, start=None, end=None)source

Gibt alle Darstellungen von Properties der Art im angegebenen Bereich zurück.

HINWEIS: Mit dieser Funktion werden keine nicht indexierten Properties zurückgegeben.

Parameter

kind: Name der Art, deren Properties Sie abrufen möchten.
start: Gibt nur Properties ">= start" zurück, wenn der Startwert nicht auf "None" gesetzt ist.
end: Gibt nur Properties "< end" zurück, wenn der Endwert nicht auf "None" gesetzt ist.

Returns

Ein Dictionary, das der Liste von Darstellungen Property-Namen zuordnet.

google.appengine.ext.ndb.metadata.get_entity_group_version(key)source

Gibt die Version der Entitätengruppe zurück, die den Schlüssel enthält.

Parameter

key: Ein Schlüssel für eine Entitätengruppe, deren Schlüssel für "__entity_group__" Sie abrufen möchten.

Gibt Folgendes zurück:

Die Version der Entitätengruppe, die den Schlüssel enthält. Diese Version wird garantiert bei jeder Änderung der Entitätengruppe erhöht. Die Version kann sogar erhöht werden, wenn keine für den Nutzer sichtbaren Änderungen an der Entitätengruppe vorhanden sind. Kann "None" zurückgeben, wenn nie in die Entitätengruppe geschrieben wurde.

Bei Nicht-HR-Datenspeichern gibt diese Funktion "None" zurück.