中繼資料實體 Python 參考資料

附註:強烈建議建構新應用程式的開發人員使用 NDB 用戶端程式庫;相較於此用戶端程式庫,NDB 用戶端程式庫有幾項優點,例如能透過 Memcache API 自動快取實體。若您目前使用舊版的「DB 用戶端程式庫」,請參閱 DB 至 NDB 移轉指南

模型類別 EntityGroupNamespaceKindProperty 表示取得或查詢中繼資料種類的結果。 這些類別全部於 google.appengine.ext.db.metadata 套件定義。請參閱中繼資料頁面瞭解更多詳細資訊及使用範例。

輔助函式

以下輔助函式可用於取得中繼資料資訊,無需發佈明確查詢或取得:

get_entity_group_version(entity_or_key)

傳回含有 entity_or_key 實體群組的版本。每次變更實體群組,版本數字一定會增加。即使實體群組出現使用者看不見的變化,版本數字也有可能增加。若實體群組從未遭到寫入,可能傳回 None。在非 HR 資料儲存庫中,此函式會傳回 None

引數:

entity_or_key
您需要版本的金鑰或實體。
get_namespaces(start=None, end=None)

會傳回命名空間名稱清單。

引數

start

若非 None,僅傳回大於或等於指定值的命名空間名稱。

end

若非 None,僅傳回小於指定值的命名空間名稱。

get_kinds(start=None, end=None)

傳回實體種類名稱清單。

引數

start

若非 None,僅傳回大於或等於指定值的種類名稱。

end

若非 None,僅傳回小於指定值的種類名稱。

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

傳回指定種類建立索引的屬性名稱清單,不含未建立索引的屬性。

引數

kind

屬性名稱受到要求的種類。

start

若非 None,僅傳回大於或等於指定值的屬性名稱。

end

若非 None,僅傳回小於指定值的屬性名稱。

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

將指定種類各個建立索引屬性名稱的字典對應傳回至其表示法清單,不含未建立索引的屬性。

引數

kind

屬性表示法受到要求的種類。

start

若非 None,僅傳回名稱大於或等於指定值的屬性表示法。

end

若非 None,僅傳回名稱小於指定值的屬性表示法。

EntityGroup 類別

__entity_group__ 中繼資料模型 (僅於 HR 資料儲存庫提供)。

此中繼資料包含數字 __version__ 屬性,每次變更實體群組,數字一定會增加。實體群組出現使用者看不見的變化,版本數字也有可能增加。若實體群組從未遭到寫入,__entity_group__ 實體可能不存在。

屬性

版本
版本號碼

類別方法

key_for_entity(entity_or_key)
傳回含有 entity_or_key 的實體群組中繼資料金鑰。使用此金鑰作為引數,以便 get() 含有 entity_or_key 實體群組的 __entity_group__ 中繼資料實體。

引數:

entity_or_key
金鑰或實體具有您需要的 __entity_group__ 金鑰。

Namespace 類別

Namespace 類別代表特殊種類 __namespace__ 的中繼資料實體,以命名空間查詢結果傳回。 實體金鑰為命名空間名稱。(例外情況為空白字串 "" 指定的預設命名空間:由於這不是有效的金鑰名稱,預設命名空間將改以金鑰及數字 ID 1 表示。)

屬性

Namespace 類別執行個體具有下列屬性:

namespace_name

傳回此實體金鑰指定的命名空間名稱。

類別方法

Namespace 類別具有下列類別方法:

key_for_namespace(namespace)

傳回指定命名空間的 __namespace__ 金鑰。

引數

namespace

要求傳回其金鑰的命名空間。

key_to_namespace(key)

傳回特定 __namespace__ 金鑰指定的命名空間。

引數

key

要求傳回其名稱的金鑰。

Kind 類別

Kind 類別代表特殊種類 __kind__ 的中繼資料實體,以種類查詢結果傳回。實體金鑰為實體種類名稱。

屬性

Kind 類別執行個體具有下列屬性:

kind_name

傳回此實體金鑰指定的種類名稱。

類別方法

Kind 類別具有下列類別方法:

key_for_kind(kind)

傳回指定種類的 __kind__ 金鑰。

引數

kind

金鑰受到要求的種類。

key_to_kind(key)

傳回特定 __kind__ 金鑰指定的種類。

引數

key

種類受到要求的金鑰。

Property 類別

Property 類別代表特殊種類 __property__ 的中繼資料實體,以屬性查詢結果傳回。 表示種類「K」屬性「P」的實體以下列方式建構:

  • 實體金鑰具有種類 __property__ 及金鑰名稱「P」
  • 父系實體金鑰具有種類 __kind__ 及金鑰名稱「K」

屬性

Property 類別執行個體具有下列屬性:

kind_name

傳回此實體金鑰指定的種類名稱。

property_name

傳回此實體金鑰指定的屬性名稱。

類別方法

Property 類別具有下列類別方法:

key_for_kind(kind)

傳回指定種類 __property__ 金鑰的父項金鑰。

引數

kind

父項金鑰受到要求的種類。

key_for_property(kind, property)

傳回指定屬性及種類的 __property__ 金鑰。

引數

kind

金鑰受到要求的種類。

property

金鑰受到要求的屬性。

key_to_kind(key)

傳回特定 __property__ 金鑰指定的種類。

引數

key

要求傳回其類型名稱的金鑰。

key_to_property(key)

傳回特定 __property__ 金鑰指定的屬性,若金鑰僅由單一種類指定,則傳回 None

引數

key

要求傳回其屬性名稱的金鑰。

本頁內容對您是否有任何幫助?請提供意見:

傳送您對下列選項的寶貴意見...

這個網頁
Python 2 適用的 App Engine 標準環境