REST Resource: projects.databases.indexes

リソース: インデックス

インデックス定義。

JSON表現
{
  "name": string,
  "collectionId": string,
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
田畑
name

string

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

collectionId

string

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

fields[]

object ( IndexField )

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

state

enum ( State )

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

インデックスフィールド

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

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インデックスの作成中に問題が発生しました。インデックスに対してアクティブな長時間実行操作はなく、最後に終了した長時間実行操作は失敗しました。ドキュメントの作成時にインデックスは更新されません。インデックスデータが存在する場合があります。

メソッド

create

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

delete

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

get

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

list

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