ทำความเข้าใจประสิทธิภาพของการค้นหาโดยใช้คำอธิบายการค้นหา

Query Explain ช่วยให้คุณส่งการค้นหา Cloud Firestore ไปยัง แบ็กเอนด์และรับสถิติประสิทธิภาพโดยละเอียดเกี่ยวกับการดำเนินการค้นหาแบ็กเอนด์ กลับมา โดยจะทำงานเหมือนกับการดำเนินการ EXPLAIN [ANALYZE] ในระบบฐานข้อมูลเชิงสัมพันธ์หลายระบบ

คุณสามารถส่งคำขอ Query Explain ได้โดยใช้ ไลบรารีของไคลเอ็นต์เซิร์ฟเวอร์ Firestore

ผลลัพธ์ของ Query Explain จะช่วยให้คุณเข้าใจวิธีดำเนินการค้นหา โดยแสดงจุดที่ไม่มีประสิทธิภาพและตำแหน่งของคอขวดที่อาจเกิดขึ้นที่ฝั่งเซิร์ฟเวอร์

Query Explain

• ให้ข้อมูลเชิงลึกเกี่ยวกับระยะการวางแผนการค้นหาเพื่อให้คุณปรับดัชนีการค้นหาและเพิ่มประสิทธิภาพได้
• การใช้ตัวเลือกวิเคราะห์จะช่วยให้คุณเข้าใจต้นทุนและประสิทธิภาพของการค้นหาแต่ละครั้ง และช่วยให้คุณวนซ้ำรูปแบบการค้นหาต่างๆ ได้อย่างรวดเร็วเพื่อเพิ่มประสิทธิภาพการใช้งาน

ทำความเข้าใจตัวเลือก Query Explain: ค่าเริ่มต้นและวิเคราะห์

คุณสามารถดำเนินการ Query Explain ได้โดยใช้ตัวเลือก ค่าเริ่มต้น หรือตัวเลือก วิเคราะห์

ตัวเลือกค่าเริ่มต้นจะให้ Query Explain วางแผนการค้นหา แต่ข้ามขั้นตอนการดำเนินการ ซึ่งจะแสดงข้อมูลระยะการวางแผน คุณสามารถใช้ตัวเลือกนี้เพื่อตรวจสอบว่าการค้นหามีดัชนีที่จำเป็นและทำความเข้าใจว่ามีการใช้ดัชนีใดบ้าง ซึ่งจะช่วยให้คุณยืนยันได้ เช่น การค้นหาหนึ่งๆ ใช้ดัชนีรวมแทนที่จะต้องตัดกันในดัชนีต่างๆ มากมาย

ตัวเลือกวิเคราะห์จะให้ Query Explain ทั้งวางแผนและดำเนินการค้นหา ซึ่งจะแสดงข้อมูลการวางแผนทั้งหมดที่กล่าวถึงก่อนหน้านี้พร้อมกับสถิติจากรันไทม์การดำเนินการค้นหา ซึ่งจะรวมถึงข้อมูลการเรียกเก็บเงินของการค้นหาพร้อมกับข้อมูลเชิงลึกระดับระบบเกี่ยวกับการดำเนินการค้นหา คุณสามารถใช้เครื่องมือนี้เพื่อทดสอบการกำหนดค่าการค้นหาและดัชนีต่างๆ เพื่อเพิ่มประสิทธิภาพต้นทุนและเวลาในการตอบสนอง

Query Explain มีค่าใช้จ่ายเท่าใด

เมื่อคุณใช้ Query Explain กับตัวเลือกค่าเริ่มต้น ระบบจะไม่ดำเนินการดัชนีหรือการอ่าน และจะเรียกเก็บเงินสำหรับการดำเนินการอ่าน 1 ครั้ง ไม่ว่าการค้นหาจะซับซ้อนเพียงใดก็ตาม

เมื่อคุณใช้ Query Explain กับตัวเลือกวิเคราะห์ ระบบจะดำเนินการดัชนีและการอ่าน ดังนั้นคุณจะถูกเรียกเก็บเงินสำหรับการค้นหาตามปกติ โดยจะไม่มีการเรียกเก็บเงินเพิ่มเติมสำหรับกิจกรรมการวิเคราะห์ แต่จะเรียกเก็บเงินตามปกติสำหรับการค้นหาที่ดำเนินการ

ใช้ Query Explain กับตัวเลือกค่าเริ่มต้น

คุณสามารถใช้ไลบรารีของไคลเอ็นต์เพื่อส่งคำขอตัวเลือกค่าเริ่มต้น

โปรดทราบว่าระบบจะตรวจสอบสิทธิ์คำขอด้วย IAM โดยใช้สิทธิ์เดียวกันกับการดำเนินการค้นหาปกติ และจะละเว้นเทคนิคการตรวจสอบสิทธิ์อื่นๆ เช่น Firebase Authentication ดูข้อมูลเพิ่มเติมได้ในคู่มือเกี่ยวกับ IAM สำหรับไลบรารีของไคลเอ็นต์เซิร์ฟเวอร์

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)"},
    ]
}

ดูข้อมูลเพิ่มเติมได้ที่ข้อมูลอ้างอิงรายงาน Query Explain

ใช้ Query Explain กับตัวเลือกวิเคราะห์

คุณสามารถใช้ไลบรารีของไคลเอ็นต์เพื่อส่งคำขอตัวเลือกวิเคราะห์

โปรดทราบว่าระบบจะตรวจสอบสิทธิ์คำขอด้วย IAM โดยใช้สิทธิ์เดียวกันกับการดำเนินการค้นหาปกติ และจะละเว้นเทคนิคการตรวจสอบสิทธิ์อื่นๆ เช่น Firebase Authentication ดูข้อมูลเพิ่มเติมได้ในคู่มือเกี่ยวกับ IAM สำหรับไลบรารีของไคลเอ็นต์เซิร์ฟเวอร์

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;

    

ตัวอย่างต่อไปนี้แสดงออบเจ็กต์ stats ที่แสดงนอกเหนือจาก planInfo รูปแบบที่แน่นอนของการตอบกลับจะขึ้นอยู่กับสภาพแวดล้อมการดำเนินการ โดยการตอบกลับตัวอย่างอยู่ในรูปแบบ 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",
               }
    }

}

ดูข้อมูลเพิ่มเติมได้ที่ข้อมูลอ้างอิงรายงาน Query Explain

ตีความผลลัพธ์และทำการปรับเปลี่ยน

มาดูสถานการณ์ตัวอย่างที่เราค้นหาภาพยนตร์ตามประเภทและประเทศที่ผลิต

สมมติว่าเราใช้การค้นหา SQL ที่เทียบเท่ากับการค้นหาต่อไปนี้

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

หากเราใช้ตัวเลือกวิเคราะห์ เมตริกที่แสดงจะแสดงว่าการค้นหาทำงานบนดัชนี 2 รายการที่มีดัชนีเดียว (category ASC, __name__ ASC) และ (country ASC, __name__ ASC) โดยจะสแกนรายการดัชนี 16,500 รายการ แต่แสดงเอกสารเพียง 1,200 รายการ

// 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",
               }
    }
}