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)

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

インデックス フィールド

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

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

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