REST Resource: projects.databases.indexes

リソース: Index

インデックスの定義。

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

string

インデックスのリソース名。出力のみ。
collectionId

string

このインデックスが適用されるコレクション ID。必須。
fields[]

object (IndexField)

インデックスを付けるフィールド。
state

enum (State)

インデックスの状態。出力のみ。

IndexField

インデックスのフィールド。

JSON 表現 
{
  "fieldPath": string,
  "mode": enum (Mode)
}
フィールド
fieldPath

string

フィールドのパス。[google.firestore.v1beta1.Document.fields][fields] で記述されているフィールドパス指定と一致する必要があります。特殊フィールドのパス __name__ は、単独で使用することも、パスの末尾で使用することもできます。__type__ はパスの末尾でのみ使用できます。
mode

enum (Mode)

フィールドのモード。

モード

このモードにより、フィールドに対するインデックスの作成方法が決まります。

列挙型
MODE_UNSPECIFIED モードが指定されていません。
ASCENDING フィールドの値は、昇順の順序付けをサポートし、<、>、<=、>=、= によるクエリもできるように、インデックスが付けられます。
DESCENDING フィールドの値は、降順の順序付けをサポートし、<、>、<=、>=、= によるクエリもできるように、インデックスが付けられます。
ARRAY_CONTAINS ARRAY_CONTAINS クエリを使用してメンバーシップをサポートするように、フィールドの配列値にインデックスが付けられます。

状態

インデックスの状態。インデックスの作成中、インデックスは CREATING 状態になります。インデックスが正常に作成されると、READY 状態に移行します。インデックスを作成できない場合は、ERROR 状態に移行します。

列挙型
STATE_UNSPECIFIED 状態は指定されていません。
CREATING インデックスを作成しています。インデックスに対してアクティブな長時間実行オペレーションがあります。インデックスは、ドキュメントの書き込み時に更新されます。一部のインデックス データが存在する可能性があります。
READY インデックスを使用する準備ができました。インデックスは、ドキュメントの書き込み時に更新されます。インデックスは、適用先の保存されているすべてのドキュメントから完全に入力されます。
ERROR インデックスの作成中に問題が発生しました。インデックスに対してアクティブな長時間実行オペレーションがなく、最後に完了した長時間実行オペレーションが失敗しました。ドキュメントの書き込み時にインデックスは更新されません。一部のインデックス データが存在する可能性があります。

Methods

create

 指定されたインデックスを作成します。

delete

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

get

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

list

 指定されたフィルタに一致するインデックスを一覧表示します。