REST Resource: projects.databases.collectionGroups.indexes

リソース: Index

Cloud Firestore インデックスを使用すると、データベース内のドキュメントに対して単純なクエリや複雑なクエリを実行できます。

JSON 表現 
{
  "name": string,
  "queryScope": enum (QueryScope),
  "apiScope": enum (ApiScope),
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
フィールド
name

string

出力専用。このインデックスのサーバー定義名。複合インデックスの場合、この名前の形式は projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id} になります。単一フィールド インデックスの場合、このフィールドは空になります。
queryScope

enum (QueryScope)

コレクション クエリ スコープが指定されたインデックスでは、クエリ時に指定され、同じコレクション ID を持つ特定のドキュメントの子であるコレクションに対してクエリを実行できます。

コレクション グループのクエリ スコープが指定されたインデックスでは、クエリ時に指定された特定のドキュメントの子孫で、このインデックスと同じコレクション ID を持つすべてのコレクションに対してクエリが許可されます。
apiScope

enum (ApiScope)

このインデックスでサポートされている API スコープ。
fields[]

object (IndexField)

このインデックスでサポートされているフィールド。

複合インデックスの場合、2 ～ 100 個のフィールドが必要です。最後のフィールド エントリは、常にフィールドパス __name__ のものです。作成時に __name__ が最後のフィールドとして指定されていない場合は、最後に定義されたフィールドと同じ方向で自動的に追加されます。複合インデックスの最後のフィールドに方向性がない場合、__name__ は（明示的に指定しない限り）ASCENDING に並べ替えられます。

単一フィールド インデックスの場合、これは常に 1 つのエントリであり、関連フィールドのフィールドパスと等しいフィールドパスを持ちます。
state

enum (State)

出力専用。インデックスの提供状態。

メソッド

create

 複合インデックスを作成します。

delete

 複合インデックスを削除します。

get

 複合インデックスを取得します。

list

 複合インデックスを一覧表示します。