本頁面由 Cloud Translation API 翻譯而成。

使用查詢說明功能瞭解查詢效能

您可以透過查詢說明，將 Cloud Firestore 項查詢提交至並且接收後端查詢執行的詳細效能統計資料。傳回的結果。其功能與許多 EXPLAIN [ANALYZE] 運算類似關聯資料庫系統

您可以使用 Firestore 伺服器用戶端程式庫傳送查詢說明要求。

查詢說明結果有助您瞭解查詢內容以顯示出效率不佳與可能伺服器端的位置

查詢說明：

提供查詢規劃階段的洞察資料，協助您調整查詢索引並提高效率。
使用分析選項，您就能瞭解並針對不同查詢執行快速疊代才能最佳化用量

，瞭解如何調查及移除這項存取權。

瞭解查詢說明選項：預設與分析

查詢說明作業可以使用 default 選項或 analyze 選項。

若以預設選項，Query Explain 能規劃查詢，但會略過執行預測系統隨即會傳回規劃工具的階段資訊。你可以用於檢查查詢是否具備必要的索引，並找出索引。這有助於您驗證查詢是使用複合式索引，而且必須在許多不同的索引。

使用分析選項時，「查詢說明」會同時執行兩個計畫。這會傳回所有先前提及的規劃工具資訊，以及查詢執行執行階段的統計資料包括帳單以及查詢的系統層級深入分析您可以使用這項工具測試各種查詢和索引來最佳化成本和延遲時間

什麼是查詢說明費用？

透過預設選項使用查詢說明時，則不會執行索引或讀取作業執行指令無論查詢的複雜度為何，系統都會收取一項讀取作業的費用。

當您使用「查詢說明」搭配「分析」選項時，系統會執行索引和讀取作業，因此會照常向您收取查詢費用。分析活動不會產生額外費用，只會產生執行查詢的一般費用。

以預設選項使用查詢說明

您可以使用用戶端程式庫提交預設選項要求。

請注意，系統會使用 IAM 驗證要求權限較高的政策其他驗證技術，例如 Firebase Authentication) 已忽略。詳情請參閱伺服器用戶端程式庫適用的 IAM。

Java (管理員)


Query q = db.collection("col").whereGreaterThan("a", 1);
ExplainOptions options = ExplainOptions.builder().build();

ExplainResults<QuerySnapshot> explainResults = q.explain(options).get();
ExplainMetrics metrics = explainResults.getMetrics();
PlanSummary planSummary = metrics.getPlanSummary();

節點 (管理員)


const q = db.collection('col').where('country', '=', 'USA');
const options = { analyze : 'false' };

const explainResults = await q.explain(options);

const metrics = explainResults.metrics;
const plan = metrics.planSummary;

回應的確切格式視執行環境而定。傳回的結果可以轉換為 JSON。例如：

{
    "indexes_used": [
        {"query_scope": "Collection", "properties": "(category ASC, __name__ ASC)"},
        {"query_scope": "Collection", "properties": "(country ASC, __name__ ASC)"},
    ]
}

詳情請參閱「查詢解釋報表參考資料」。

使用「查詢說明」與「分析」選項

您可以使用用戶端程式庫提交分析選項要求。

請注意，要求會透過 IAM 驗證，並使用一般查詢作業的相同權限。其他驗證技術，例如 Firebase Authentication) 已忽略。詳情請參閱伺服器用戶端程式庫適用的 IAM。

Java (管理員)


Query q = db.collection("col").whereGreaterThan("a", 1);

ExplainOptions options = ExplainOptions.builder().setAnalyze(true).build();

ExplainResults<QuerySnapshot> explainResults = q.explain(options).get();

ExplainMetrics metrics = explainResults.getMetrics();
PlanSummary planSummary = metrics.getPlanSummary();
List<Map<String, Object>> indexesUsed = planSummary.getIndexesUsed();
ExecutionStats stats = metrics.getExecutionStats();

節點 (管理員)


const q = db.collection('col').where('country', '=', 'USA');

const options = { analyze : 'true' };

const explainResults = await q.explain(options);

const metrics = explainResults.metrics;
const plan = metrics.planSummary;
const indexesUsed = plan.indexesUsed;
const stats = metrics.executionStats;

以下範例顯示除了 planInfo 以外，系統傳回的 stats 物件。回應的確切格式視執行環境而定。範例回應為 JSON 格式。

{
    "resultsReturned": "5",
    "executionDuration": "0.100718s",
    "readOperations": "5",
    "debugStats": {
               "index_entries_scanned": "95000",
               "documents_scanned": "5"
               "billing_details": {
                     "documents_billable": "5",
                     "index_entries_billable": "0",
                     "small_ops": "0",
                     "min_query_cost": "0",
               }
    }

}

詳情請參閱查詢說明報表參考資料。

解讀結果並進行調整

以下舉例說明，我們會依據類型和製作國家/地區查詢電影。

為說明這項功能，請假設您使用的是這個 SQL 查詢的對等項目。

SELECT *
FROM /movies
WHERE category = 'Romantic' AND country = 'USA';

如果我們使用分析選項，傳回的指標就會顯示查詢內容會在兩個單一欄位索引 ((category ASC, __name__ ASC)) 上執行 (country ASC, __name__ ASC)。它會掃描 16500 個索引項目，但只會傳回 1200 個文件。

// Output query planning info
{
    "indexes_used": [
        {"query_scope": "Collection", "properties": "(category ASC, __name__ ASC)"},
        {"query_scope": "Collection", "properties": "(country ASC, __name__ ASC)"},
    ]
}

// Output query status
{
    "resultsReturned": "1200",
    "executionDuration": "0.118882s",
    "readOperations": "1200",
    "debugStats": {
               "index_entries_scanned": "16500",
               "documents_scanned": "1200"
               "billing_details": {
                     "documents_billable": "1200",
                     "index_entries_billable": "0",
                     "small_ops": "0",
                     "min_query_cost": "0",
               }
    }
}

如要最佳化執行查詢的效能，您可以建立完全涵蓋的複合索引 (category ASC, country ASC, __name__ ASC)。

再次使用分析選項執行查詢為這項查詢選取新建立的索引，該查詢的執行速度會更快更有效率地

// Output query planning info
{
    "indexes_used": [
        {"query_scope": "Collection", "properties": "(category ASC, country ASC,  __name__ ASC)"}
    ]
}

// Output query stats
{
    "resultsReturned": "1200",
    "executionDuration": "0.026139s",
    "readOperations": "1200",
    "debugStats": {
               "index_entries_scanned": "1200",
               "documents_scanned": "1200"
               "billing_details": {
                     "documents_billable": "1200",
                     "index_entries_billable": "0",
                     "small_ops": "0",
                     "min_query_cost": "0",
               }
    }
}