Metadatenentitäten-Python-Referenz

Hinweis: Entwicklern von neuen Anwendungen wird dringend empfohlen, die NDB-Clientbibliothek zu verwenden. Diese bietet im Vergleich zur vorliegenden Clientbibliothek verschiedene Vorteile, z. B. das automatische Caching von Entitäten über die Memcache API. Wenn Sie derzeit die ältere DB-Clientbibliothek verwenden, lesen Sie die Anleitung zur Migration von DB zu NDB.

Die Modellklassen EntityGroup, Namespace, Kind und Property repräsentieren die Ergebnisse des Abrufens oder Abfragens von Metadatentypen. Diese Klassen sind im Paket google.appengine.ext.db.metadata definiert. Weitere Informationen und Beispiele zur Verwendung finden Sie auf der Seite Metadaten.

Hilfsfunktionen

Die folgenden Hilfsfunktionen stehen zum Erhalten von Metadateninformationen zur Verfügung, ohne eine explizite Abfrage oder ein explizites Abrufen (get) auszugeben:

get_entity_group_version(entity_or_key)

Gibt die Version der Entitätengruppe zurück, die entity_or_key enthält. Diese Version erhöht sich garantiert bei jeder Änderung der Entitätengruppe. Die Version kann auch erhöht werden, wenn keine für den Nutzer sichtbaren Änderungen an der Entitätengruppe vorhanden sind. None kann zurückgegeben werden, wenn nie in die Entitätengruppe geschrieben wurde. Bei Nicht-HR-Datenspeichern gibt diese Funktion None zurück.

Argumente:

entity_or_key
Ein Schlüssel oder eine Entität, dessen/deren Version Sie benötigen.
get_namespaces(start=None, end=None)

Gibt eine Liste von Namespace-Namen zurück.

Argumente

start

Liefern nur Namespace-Namen größer oder gleich dem angegebenen Wert, wenn nicht None.

end

Liefern nur Namespace-Namen, die kleiner als der angegebene Wert sind, wenn nicht None.

get_kinds(start=None, end=None)

Gibt eine Liste von Entitätstypnamen zurück.

Argumente

start

Liefern nur Typnamen größer oder gleich dem angegebenen Wert, wenn nicht None.

end

Liefern nur Typnamen, die kleiner als der angegebene Wert sind, wenn nicht None.

get_properties_of_kind(kind, start=None, end=None)

Liefert eine Liste indexierter Property-Namen für einen bestimmten Typ. Nicht indexierte Properties sind nicht enthalten.

Argumente

kind

Der Typ, dessen Property-Namen angefordert werden.

start

Liefert nur Property-Namen größer oder gleich dem angegebenen Wert, wenn nicht None.

end

Liefern nur Property-Namen, die kleiner als der angegebene Wert sind, wenn nicht None.

get_representations_of_kind(kind, start=None, end=None)

Liefert ein Dictionary, das jeden indexierten Property-Namen für einen bestimmten Typ einer Liste seiner Darstellungen zuordnet. Nicht indexierte Properties sind nicht enthalten.

Argumente

kind

Der Typ, dessen Property-Darstellungen angefordert werden.

start

Liefern nur Darstellungen für Properties, deren Namen größer oder gleich dem angegebenen Wert sind, wenn nicht None.

end

Liefern nur Darstellungen für Properties, deren Namen kleiner als der angegebene Wert sind, wenn nicht None.

EntityGroup-Klasse

Modell für __entity_group__-Metadaten (nur in HR-Datenspeicher verfügbar)

Diese Metadaten enthalten die numerische Property __version__, die sich bei jeder Änderung der Entitätengruppe garantiert erhöht. Die Version kann auch 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.

Property

version
Versionsnummer

Klassenmethode

key_for_entity(entity_or_key)
Liefern den Metadatenschlüssel für die Entitätengruppe mit entity_or_key. Verwenden Sie diesen Schlüssel als Argument für das get() der Metadatenentität __entity_group__ für die Entitätengruppe, die entity_or_key enthält.

Argumente:

entity_or_key
Ein Schlüssel oder eine Entität, dessen/deren __entity_group__ Sie benötigen.

Namespace-Klasse

Die Klasse Namespace stellt eine Metadatenentität der speziellen Art __namespace__ dar, die als Ergebnis einer Namespace-Abfrage zurückgegeben wird. Der Schlüssel der Entität ist der Name des Namespace. (Eine Ausnahme ist der Standard-Namespace, der mit dem leeren String "" angegeben wird. Weil dies kein gültiger Schlüsselname ist, wird der Standard-Namespace stattdessen durch einen Schlüssel mit der numerischen ID 1 dargestellt.)

Property

Instanzen der Klasse Namespace haben die folgende Property:

namespace_name

Liefert den Namen des Namespace, der vom Schlüssel dieser Entität angegeben wird.

Klassenmethoden

Die Klasse Namespace hat die folgenden Klassenmethoden:

key_for_namespace(namespace)

Liefert den Schlüssel __namespace__ für den angegebenen Namespace.

Argument

Namespace

Der Namespace, dessen Schlüssel angefordert wird.

key_to_namespace(key)

Liefert den Namespace, der durch einen gegebenen __namespace__-Schlüssel angegeben wird.

Argument

key

Der Schlüssel, dessen Name angefordert wird.

Kind-Klasse

Die Klasse Kind stellt eine Metadatenentität der speziellen Art __kind__ dar, die als Ergebnis einer Artenabfrage zurückgegeben wird. Der Schlüssel der Entität ist der Name des Entitätstyps.

Property

Instanzen der Klasse Kind haben die folgende Property:

kind_name

Liefert den vom Schlüssel dieser Entität angegebenen Typnamen.

Klassenmethoden

Die Klasse Kind hat die folgenden Klassenmethoden:

key_for_kind(kind)

Liefert den Schlüssel __kind__ für den angegebenen Typ.

Argument

kind

Der Typ, dessen Schlüssel angefordert wird.

key_to_kind(key)

Liefert den Typ, der durch einen gegebenen __kind__-Schlüssel angegeben wird.

Argument

key

Der Schlüssel, dessen Typ angefordert wird.

Property-Klasse

Die Klasse Property stellt eine Metadatenentität der speziellen Art __property__ dar, die als Ergebnis einer Attributabfrage zurückgegeben wird. Die Entität, die Property P des Typs K darstellt, ist folgendermaßen aufgebaut:

  • Der Schlüssel der Entität ist vom Typ __property__ und hat den Schlüsselnamen P.
  • Der Schlüssel der übergeordneten Entität ist vom Typ __kind__ und hat den Schlüsselnamen K.

Properties

Instanzen der Klasse Property haben die folgenden Properties:

kind_name

Gibt den vom Schlüssel dieser Entität angegebenen Typnamen zurück.

property_name

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

Klassenmethoden

Die Klasse Property hat die folgenden Klassenmethoden:

key_for_kind(kind)

Gibt den übergeordneten Schlüssel für __property__-Schlüssel des angegebenen Typs zurück.

Argument

kind

Der Typ, dessen übergeordneter Schlüssel angefordert wird.

key_for_property(kind, property)

Liefert den __property__-Schlüssel für die angegebene Property und den angegebenen Typ.

Argumente

kind

Der Typ, dessen Schlüssel angefordert wird.

property

Die Property, deren Schlüssel angefordert wird.

key_to_kind(key)

Liefert den Typ, der durch einen gegebenen __property__-Schlüssel angegeben wird.

Argument

key

Der Schlüssel, dessen Typname angefordert wird.

key_to_property(key)

Liefert die Property, die durch einen gegebenen __property__-Schlüssel angegeben wird, oder None, wenn der Schlüssel nur einen Typ angibt.

Argument

key

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