Query Explain レポートのリファレンス

Query Explain レポートのリファレンス

次の値は、Firestore　クエリ Explain で実行されたオペレーションの結果として返されます。

注: Query Explain は、有用なアドホック分析を目的として設計されています。レポートの形式は、機械処理に適しているというより、読みやすさと理解しやすさを最大化するように進化していきます。一部の指標は、ネイティブ モードの Firestore が進化すると（指標が追加、削除、更新される可能性がある）、変化が予想され、他のネイティブ モードの Firestore API と同じ非推奨ポリシーの対象にはなりません。次の表は、データのどの部分が変更されることになるかを示しています。

プランの記録

キー	タイプ	変更されることがある項目ですか？	説明
indexes_used	汎用構造体のリスト	はい、構造体レスポンスの内容は変更される可能性があります。	このクエリ用に選択されたインデックスのリスト。以下をご覧ください。

使用されたインデックス

使用されるインデックスの内容は、ネイティブ モードの Firestore の進化に伴って変更される可能性があります。

キー	タイプ	説明
query_scope	文字列	クエリが実行されるスコープ。たとえば Collection、Collection Group、Includes Ancestors。
properties	文字列	形式内のインデックス フィールド。例: 　　　　　　　　　　　　　　　(age ASC, __name__ ASC)。

実行統計情報

クエリの集計された実行統計情報。

キー	種類	変更されることがある項目ですか？	説明
results_returned	long	×	ドキュメント、射影、集計結果、キーなど、返される結果の合計数。
execution_duration	所要時間	×	バックエンドでのクエリの実行時間の合計。
read_operations	long	×	課金対象の読み取りオペレーションの合計数。
debug_stats	汎用構造体	はい、構造体レスポンスの内容は変更される可能性があります。	クエリ実行の統計情報のデバッグ。以下をご覧ください。

デバッグ統計情報

次の結果は、ユースケースのデバッグや、未加工の任意の統計情報の分析に役立ちます。

デバッグ統計情報の内容は、ネイティブ モードの Firestore の進化に伴って変化することがあります。

キー	種類	説明
index_entries_scanned	String（文字列）	クエリ中に検査されたインデックス エントリの合計数。
documents_scanned	String（文字列）	クエリ中にスキャンされたドキュメントの合計数。
billing_details	汎用構造体	課金の詳細（「documents_billable」、「index_entries_billable」、「knn_vector_index_entries_billable」、「min_query_cost」などの指標）。