リソース: インデックス
インデックス定義。
JSON表現 |
---|
{ "name": string, "collectionId": string, "fields": [ { object ( |
田畑 | |
---|---|
name | インデックスのリソース名。出力のみ。 |
collectionId | このインデックスが適用されるコレクション ID。必須。 |
fields[] | インデックスを付けるフィールド。 |
state | インデックスの状態。出力のみ。 |
インデックスフィールド
インデックスのフィールド。
JSON表現 |
---|
{
"fieldPath": string,
"mode": enum ( |
田畑 | |
---|---|
fieldPath | 畑の道。 [google.firestore.v1beta1.Document.fields][fields] で説明されているフィールド パス仕様と一致する必要があります。特別なフィールド パス |
mode | フィールドのモード。 |
モード
モードによって、フィールドのインデックス付け方法が決まります。
列挙型 | |
---|---|
MODE_UNSPECIFIED | モードは指定されていません。 |
ASCENDING | フィールドの値には、昇順での順序付けと、<、>、<=、>=、および = によるクエリをサポートするためにインデックスが付けられます。 |
DESCENDING | フィールドの値には、降順での順序付けと、<、>、<=、>=、および = によるクエリをサポートするためにインデックスが付けられます。 |
ARRAY_CONTAINS | フィールドの配列値には、ARRAY_CONTAINS クエリを使用したメンバーシップをサポートするためにインデックスが付けられます。 |
州
インデックスの状態。インデックスの作成中、インデックスはCREATING
状態になります。インデックスが正常に作成されると、 READY
状態に遷移します。インデックスを作成できない場合は、 ERROR
状態に遷移します。
列挙型 | |
---|---|
STATE_UNSPECIFIED | 状態は未指定です。 |
CREATING | インデックスは作成中です。インデックスに対してアクティブな長時間実行操作が存在します。インデックスはドキュメントの作成時に更新されます。インデックスデータが存在する場合があります。 |
READY | インデックスを使用する準備ができました。インデックスはドキュメントの作成時に更新されます。インデックスは、適用されるすべての保存ドキュメントから完全に設定されます。 |
ERROR | インデックスの作成中に問題が発生しました。インデックスに対してアクティブな長時間実行操作はなく、最後に終了した長時間実行操作は失敗しました。ドキュメントの作成時にインデックスは更新されません。インデックスデータが存在する場合があります。 |
メソッド | |
---|---|
| 指定されたインデックスを作成します。 |
| インデックスを削除します。 |
| インデックスを取得します。 |
| 指定されたフィルターに一致するインデックスをリストします。 |