使用 index.yaml 設定 Datastore 索引

您可以使用 Cloud Datastore 為在標準環境中執行的應用程式儲存資料。Cloud Datastore 會對應用程式執行的每個查詢套用索引。這些索引會隨著實體的變更一併更新,因此應用程式執行查詢時,能夠快速得到結果。Cloud Datastore 必須事先知道應用程式將會執行哪些查詢,才能達到此目的。您會在 index.yaml 設定檔中指定應用程式需要的索引。請使用 Cloud Datastore 模擬器在您測試應用程式時自動產生檔案,或是自行撰寫檔案。您在部署應用程式時,必須上傳 index.yaml 檔案。

關於 index.yaml

應用程式執行的每個 Cloud Datastore 查詢都必須有一個對應的索引。系統會自動建立基本查詢的索引 (例如針對單一屬性的查詢),但是您必須在名為 index.yaml 的設定檔中定義複雜查詢的索引。此檔案會隨應用程式一起上傳,然後就會在 Cloud Datastore 中建立索引。

以下是 index.yaml 檔案範例:

indexes:

- kind: Cat
  ancestor: no
  properties:
  - name: name
  - name: age
    direction: desc

- kind: Cat
  properties:
  - name: name
    direction: asc
  - name: whiskers
    direction: desc

- kind: Store
  ancestor: yes
  properties:
  - name: business
    direction: asc
  - name: owner
    direction: asc

index.yaml 的語法為 YAML 格式。如要進一步瞭解這種語法,請參閱 YAML 網站

索引定義

index.yaml 具有名為 indexes 的單一清單元素。清單中的每個元素都代表應用程式的一個索引。

索引元素可以有下列元素:

kind
查詢的實體種類。此元素為必要元素。
properties

按照排列順序,以索引欄形式加入的屬性清單:首先為用於等號篩選器的屬性,其次為用於非等號篩選器的屬性,接著是排列順序及其排序方向。

此清單中的每個元素都具有下列元素:

name
屬性的資料儲存庫名稱。
direction
排序方向,asc 代表遞增,desc 代表遞減。只有用於查詢的排序順序屬性才需要此排序方向,且必須符合查詢所使用的方向。預設值為 asc
ancestor

如果查詢包含祖系子句 (),則為 yes。預設值為 no

建立索引檔案

您可以使用文字編輯器並遵循上述檔案配置,以手動方式建立索引檔案。在本機測試應用程式時自動產生檔案則更有效率。您可以結合這兩種方法。

測試本機環境時,您可以使用 gcloud 模擬器指令啟動模擬 Cloud Datastore 的服務,然後再執行應用程式:

gcloud beta emulators datastore start --data-dir DATA-DIR

使用 --data-dir 標記指定自動產生的 index.yaml 檔案將會顯示在哪個目錄。

當您測試應用程式時,每次產生一個 Cloud Datastore 查詢,模擬器就會將產生的索引定義新增至 index.yaml。所有自動產生的索引都會顯示在下方行列底下的檔案中:

# AUTOGENERATED

系統會將所有位在這個行列上方的索引定義視為手動控制,因此開發網路伺服器不會更新這些定義。網路伺服器僅會變更該行下方的定義,且僅在完整的 index.yaml 檔案沒有描述負責應用程式所執行查詢的索引時,才會進行。如要控制自動索引定義,請將其移至該行的上方。

應用程式執行查詢時,模擬器可能會更新這個行列底下的現有定義。當您測試應用程式時,如果應用程式產生其能執行的每個查詢,則 index.yaml 中會具備完整的產生項目。您可能需要手動編輯檔案,刪除不是在實際工作環境中使用的索引,或定義非在測試期間建立的索引。

部署索引檔案

您應該先使用 gcloud 指令部署 index.yaml 檔案,然後再部署應用程式:

gcloud app deploy index.yaml
本頁內容對您是否有任何幫助?請提供意見:

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

這個網頁
App Engine standard environment for Node.js docs