リソース: Index
インデックスの定義。
JSON 表現 |
---|
{ "name": string, "collectionId": string, "fields": [ { object ( |
フィールド | |
---|---|
name |
インデックスのリソース名。出力のみ。 |
collectionId |
このインデックスが適用されるコレクション ID。必須。 |
fields[] |
インデックスを付けるフィールド。 |
state |
インデックスの状態。出力のみ。 |
IndexField
インデックスのフィールド。
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 |
インデックスの作成中に問題が発生しました。インデックスに対してアクティブな長時間実行オペレーションがなく、最後に完了した長時間実行オペレーションが失敗しました。ドキュメントの書き込み時にインデックスは更新されません。一部のインデックス データが存在する可能性があります。 |
Methods |
|
---|---|
|
指定されたインデックスを作成します。 |
|
インデックスを削除します。 |
|
インデックスを取得します。 |
|
指定されたフィルタに一致するインデックスを一覧表示します。 |