Python 2 は、コミュニティによるサポートを終了しました。Python 2 アプリを Python 3 に移行することをおすすめします。

index.yaml リファレンス

App Engine では、エンティティの各プロパティに単純なインデックスが事前定義されています。さらに、App Engine アプリケーションでは、index.yaml というインデックス構成ファイルでカスタム インデックスを定義できます。アプリをテストしている間、開発用サーバーで、これらのクエリを実行するときに、アプリケーションで必要となるインデックス構成を生成できます。アプリケーションをアップロードする前に index.yaml ファイルを編集することで、インデックスを手動で調整できます。インデックス構成をデプロイして管理する方法については、データストア インデックスの構成をご覧ください。

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

# This pound sign is the syntax for a comment.

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

構文

index.yaml の構文は YAML 形式です。index.yaml ファイルには、indexes という名前のリスト要素が 1 つだけあります。このリストに含まれる各要素で、アプリケーションのインデックスを表します。

個々のインデックスは、次の要素を持つことができます。

要素 説明
kind 必須。クエリに対応するエンティティの種類です。これは通常、エンティティのモデルを定義するモデルクラスの名前です。
properties

インデックスの列として並べ替え順で指定したプロパティのリストです。まず、等式フィルタで使用するプロパティ、次に、不等式フィルタで使用するプロパティ、そして並べ替え順序とその方向を指定します。

このリスト内の各要素には、次の要素を指定します。

name
プロパティのデータストア名です。
direction
並べ替える方向。昇順は asc、降順は desc。この値は、クエリの並べ替え順序で使用するプロパティについてのみ必要です。また、クエリで使用する方向と同じである必要があります。デフォルトは asc です。
ancestor クエリに祖先句(Query.ancestor() または GQL ANCESTOR IS 句)がある場合は yes です。デフォルトは no です。

自動インデックスと手動インデックス

開発用ウェブサーバーが生成されたインデックス定義を index.yaml に追加すると、次の行の下に必要に応じて定義が挿入されます。

# AUTOGENERATED

開発用ウェブサーバーはこの行の下のすべてのインデックス定義を自動インデックスとみなします。つまり、この行の下にある既存の定義は、アプリケーションが実行したクエリに応じて更新されることがあります。

この行の上のインデックス定義は、すべて手動で管理されているものとみなされ、開発用ウェブサーバーによって更新されることはありません。アプリケーションによって実行されるクエリに対応するインデックスが、index.yaml ファイルのどこにも記載されていない場合に限り、ウェブサーバーはこの行の下にのみを変更を加えます。自動インデックス定義を管理するには、この行を上に移動します。

インデックス構成ファイルのデプロイ

インデックス構成ファイルをデプロイするには、次のコマンドを実行します。

gcloud

gcloud app deploy index.yaml

appcfg

元の App Engine SDK をインストールする場合は、次のコマンドを実行できます。

appcfg.py update_indexes [YOUR_APP_DIR]

使用されていないインデックスの削除

インデックス構成でインデックスを変更または削除しても、元のインデックスは App Engine から自動的に削除されません。これにより、新しいインデックスを作成しながらアプリの古いバージョンを実行したり、新しいバージョンで問題が発見されたらすぐに古いバージョンを復元したりできます。

古いインデックスが不要になったことが確実である場合には、次のコマンドによって App Engine から削除できます。

gcloud datastore cleanup-indexes index.yaml