google.appengine.ext.ndb.metadata モジュール

概要

アプリのデータストア メタデータにアクセスするためのモデルとヘルパー関数。

これらのエンティティはユーザーが作成することはできませんが、__namespace__、__kind__、__property__、__entity_group__ メタデータ クエリまたは取得の結果として作成されます。

簡易 API も提供されています。

ndb.metadata.get_namespaces(): 名前空間の名前のリスト。ndb.metadata.get_kinds(): 種類の名前のリスト。ndb.metadata.get_properties_of_kind(kind):

指定した種類のプロパティの名前のリスト。

ndb.metadata.get_representations_of_kind(kind):

プロパティの名前を表現 ID のリストにマッピングする辞書。

ndb.metadata.get_entity_group_version(key):

キーを含むエンティティ グループのバージョン(HRD のみ)。

get_kinds()、get_properties_of_kind()、get_representations_of_kind() は現在の名前空間に暗黙的に適用されます。

get_namespaces()、get_kinds()、get_properties_of_kind()、get_representations_of_kind() では、start <= name < end のように start 引数および end 引数を任意で指定して、クエリを指定の名前範囲に制限できます。

内容

class google.appengine.ext.ndb.metadata.Namespace(*args, **kwds)ソース

ベース: google.appengine.ext.ndb.metadata._BaseMetadata

__namespace__ メタデータ クエリ結果のモデル。

EMPTY_NAMESPACE_ID = 1
KIND_NAME = '__namespace__'
classmethod key_for_namespace(namespace)ソース

名前空間のキーを返します。

パラメータ

namespace - キーをリクエストする名前空間を示す文字列。

戻り値

名前空間のキー。

classmethod key_to_namespace(key)ソース

指定した __namespace__ キーが指す名前空間を返します。

パラメータ

key - 名前をリクエストするキー。

戻り値

キーが指す名前空間。

namespace_name

このエンティティのキーが指す名前空間の名前を返します。

class google.appengine.ext.ndb.metadata.Kind(*args, **kwds)ソース

ベース: google.appengine.ext.ndb.metadata._BaseMetadata

__kind__ メタデータ クエリ結果のモデル。

KIND_NAME = '__kind__'
classmethod key_for_kind(kind)ソース

種類の __kind__ キーを返します。

パラメータ

kind - キーをリクエストする種類。

戻り値

種類のキー。

classmethod key_to_kind(key)ソース

指定した __kind__ キーが指す種類を返します。

パラメータ

key - 名前をリクエストするキー。

戻り値

キーが指す種類。

kind_name

このエンティティのキーが指す種類の名前を返します。

class google.appengine.ext.ndb.metadata.Property(*args, **kwds)ソース

ベース: google.appengine.ext.ndb.metadata._BaseMetadata

__property__ メタデータ クエリ結果のモデル。

KIND_NAME = '__property__'
classmethod key_for_kind(kind)ソース

種類の __property__ キーを返します。

パラメータ

kind - キーをリクエストする種類。

戻り値

種類の __property__ キーの親キー。

classmethod key_for_property(kind, property)ソース

種類のプロパティの __property__ キーを返します。

パラメータ
  • kind - キーをリクエストする種類。

  • property - キーをリクエストするプロパティ。

戻り値

種類のプロパティのキー。

classmethod key_to_kind(key)ソース

指定した __property__ キーが指す種類を返します。

パラメータ

key - 種類の名前をリクエストするキー。

戻り値

キーが指す種類。

classmethod key_to_property(key)ソース

指定した __property__ キーが指すプロパティを返します。

パラメータ

key - プロパティの名前をリクエストするキー。

戻り値

キーが指すプロパティ、またはキーが種類のみを指す場合は None。

kind_name

このエンティティのキーが指す種類の名前を返します。

property_name

このエンティティのキーが指すプロパティの名前を返します。

property_representation

値が長さ制限付きのテキスト文字列であるインデックス登録済みプロパティ。

class google.appengine.ext.ndb.metadata.EntityGroup(*args, **kwds)ソース

ベース: google.appengine.ext.ndb.metadata._BaseMetadata

__entity_group__ メタデータのモデル(HR データストアでのみ利用可能)。

このメタデータには、数値の __version__ プロパティが含まれています。このプロパティの値は、エンティティ グループに変更が加えられるたびに増分します。ユーザーが認識できない変更がエンティティ グループに加えられた場合でも、バージョンが増分することがあります。エンティティ グループが一度も書き込まれていない場合は、__entity_group__ エンティティは存在しません。

ID = 1
KIND_NAME = '__entity_group__'
classmethod key_for_entity_group(key)ソース

キーを含むエンティティ グループのキーを返します。

パラメータ

key - 目的の __entity_group__ キーを持つエンティティ グループのキー。

戻り値

キーを含むエンティティ グループの __entity_group__ キー。

version

値が Python int または long(または bool)のプロパティ。

google.appengine.ext.ndb.metadata.get_namespaces(start=None, end=None)ソース

指定した範囲に含まれるすべての名前空間を返します。

パラメータ
  • start - start が None でない場合、start の値と同じか、それより大きい名前空間のみが返されます。

  • end - end が None でない場合、end の値より小さい名前空間のみが返されます。

戻り値

(省略可能な)start 値と end 値の範囲に含まれるすべての名前空間の名前のリスト。

google.appengine.ext.ndb.metadata.get_kinds(start=None, end=None)ソース

現在の名前空間を対象として、指定した範囲に含まれるすべての種類を返します。

パラメータ
  • start - start が None でない場合、start の値と同じか、それより大きい種類のみが返されます。

  • end - end が None でない場合、end の値より小さい種類のみが返されます。

戻り値

(省略可能な)start 値と end 値の範囲に含まれるすべての種類の名前のリスト。

google.appengine.ext.ndb.metadata.get_properties_of_kind(kind, start=None, end=None)ソース

指定した範囲に含まれる特定の種類のすべてのプロパティを返します。

注: この関数ではインデックスに登録されていないプロパティは返されません。

パラメータ
  • kind - 目的のプロパティが属する種類の名前。

  • start - start が None でない場合、start の値と同じか、それより大きいプロパティのみが返されます。

  • end - end が None でない場合、end の値より小さいプロパティのみが返されます。

戻り値

(省略可能な)start 値と end 値の範囲に含まれる特定の種類のプロパティの名前のリスト。

google.appengine.ext.ndb.metadata.get_representations_of_kind(kind, start=None, end=None)ソース

指定した範囲に含まれる特定の種類のプロパティのすべての表現を返します。

注: この関数ではインデックスに登録されていないプロパティは返されません。

パラメータ
  • kind - 目的のプロパティが属する種類の名前。

  • start - start が None でない場合、start の値と同じか、それより大きいプロパティのみが返されます。

  • end - end が None でない場合、end の値より小さいプロパティのみが返されます。

戻り値

プロパティの名前をその表現のリストにマッピングする辞書。

google.appengine.ext.ndb.metadata.get_entity_group_version(key)ソース

キーを含むエンティティ グループのバージョンを返します。

パラメータ

key - 目的の __entity_group__ キーを持つエンティティ グループのキー。

戻り値

キーを含むエンティティ グループのバージョン。このバージョンは、エンティティ グループに変更が加えられるたびに増分します。ユーザーが認識できない変更がエンティティ グループに加えられた場合でも、バージョンが増分することがあります。エンティティ グループが一度も書き込まれていない場合は、None を返すことがあります。

非 HR データストアの場合、この関数は None を返します。

このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...

Python の App Engine スタンダード環境