Cloud Firestore ดูแลให้การค้นหามีประสิทธิภาพโดยกำหนดให้ต้องมีดัชนีสำหรับทุกการค้นหา ดัชนีที่จำเป็นสำหรับการค้นหาขั้นพื้นฐานที่สุดจะสร้างให้คุณโดยอัตโนมัติ เมื่อคุณใช้และทดสอบแอป Cloud Firestore จะสร้างข้อความแสดงข้อผิดพลาดที่ช่วยคุณสร้างดัชนีเพิ่มเติมที่แอปต้องการ หน้านี้จะอธิบายวิธีจัดการดัชนีช่องเดียวและคอมโพสิต
สร้างดัชนีที่หายไปผ่านข้อความแสดงข้อผิดพลาด
หากคุณพยายามใช้การค้นหาแบบผสมที่มีเงื่อนไขช่วงที่ไม่ได้แมปกับดัชนีที่มีอยู่ คุณจะได้รับข้อผิดพลาด ข้อความแสดงข้อผิดพลาดจะมีลิงก์โดยตรงเพื่อสร้างดัชนีที่หายไปในคอนโซล Firebase
ตามลิงก์ที่สร้างขึ้นไปยังคอนโซล Firebase ตรวจสอบข้อมูลที่ระบบป้อนโดยอัตโนมัติ แล้วคลิกสร้าง
บทบาทและสิทธิ์
ก่อนที่จะสร้างดัชนีใน Cloud Firestore ได้ คุณต้องกำหนดบทบาทใดบทบาทหนึ่งต่อไปนี้
roles/datastore.owner
roles/datastore.indexAdmin
roles/editor
roles/owner
หากคุณกำหนดบทบาทที่กำหนดเอง ให้มอบหมายสิทธิ์ต่อไปนี้ทั้งหมดเพื่อสร้างดัชนี
datastore.indexes.create
datastore.indexes.delete
datastore.indexes.get
datastore.indexes.list
datastore.indexes.update
ใช้คอนโซล Firebase
วิธีสร้างดัชนีใหม่ด้วยตนเองจากคอนโซล Firebase
- ไปที่ส่วน Cloud Firestore ของคอนโซล Firebase
- ไปที่แท็บดัชนี แล้วคลิกเพิ่มดัชนี
- ป้อนชื่อคอลเล็กชันและตั้งค่าช่องที่คุณต้องการเรียงลำดับดัชนี
- คลิกสร้าง
ช่องดัชนีต้องสอดคล้องกับข้อจํากัดในเส้นทางช่อง
ระบบอาจใช้เวลา 2-3 นาทีในการสร้างดัชนี ทั้งนี้ขึ้นอยู่กับขนาดของการค้นหา หลังจากที่สร้างแล้ว คุณจะดูดัชนีและสถานะของดัชนีได้ในส่วนดัชนีผสม หากพวกเขายังคงสร้างอยู่ คอนโซล Firebase จะมีแถบสถานะอาคาร
นําดัชนีออก
หากต้องการลบดัชนี ให้ทำดังนี้
- ไปที่ส่วน Cloud Firestore ของคอนโซล Firebase
- คลิกแท็บดัชนี
- วางเมาส์เหนือดัชนีที่ต้องการลบ แล้วเลือกลบจากเมนูตามบริบท
- ยืนยันว่าต้องการลบการแจ้งเตือนโดยคลิกลบจากการแจ้งเตือน
ใช้ Firebase CLI
นอกจากนี้คุณยังทำให้ดัชนีใช้งานได้ด้วย Firebase CLI
ในการเริ่มต้นใช้งาน ให้เรียกใช้ firebase init firestore
ในไดเรกทอรีโปรเจ็กต์
ในระหว่างการตั้งค่า Firebase CLI จะสร้างไฟล์ JSON ที่มีดัชนีเริ่มต้นในรูปแบบที่ถูกต้อง แก้ไขไฟล์เพื่อเพิ่มดัชนีและทำให้ใช้งานได้ด้วยคำสั่ง firebase deploy
หากต้องการทำให้ดัชนีและกฎ Cloud Firestore ใช้งานได้เท่านั้น ให้เพิ่มแฟล็ก --only firestore
หากคุณแก้ไขดัชนีโดยใช้คอนโซล Firebase โปรดอัปเดตไฟล์ดัชนีในเครื่องด้วย โปรดดูข้อมูลอ้างอิงคำจำกัดความดัชนี JSON
ใช้ Terraform
กำลังสร้างดัชนีในฐานข้อมูล
ฐานข้อมูล Cloud Firestore อาจมีดัชนีช่องเดียวหรือดัชนีผสม คุณสามารถแก้ไขไฟล์การกำหนดค่า Terraform เพื่อสร้างดัชนีสำหรับฐานข้อมูลของคุณได้
ดัชนีช่องเดียว
ตัวอย่างต่อไปนี้ของไฟล์การกำหนดค่า Terraform จะสร้างดัชนีช่องเดียวในช่อง name
ในคอลเล็กชัน chatrooms
firestore.tf
resource "random_id" "variable"{ byte_length = 8 } resource "google_firestore_field" "single-index" { project = "project-id" database = "database-id" collection = "chatrooms_${random_id.variable.hex}" field = "name" index_config { indexes { order = "ASCENDING" query_scope = "COLLECTION_GROUP" } indexes { array_config = "CONTAINS" } } ttl_config {} }
- แทนที่ project-id ด้วยรหัสโปรเจ็กต์ รหัสโปรเจ็กต์ต้องไม่ซ้ำกัน
- แทนที่ database-id ด้วยรหัสฐานข้อมูล
ดัชนีผสม
ตัวอย่างต่อไปนี้ของไฟล์การกำหนดค่า Terraform จะสร้างดัชนีผสมสำหรับชุดค่าผสมของฟิลด์ name
และช่อง description
ในคอลเล็กชัน chatrooms
firestore.tf
resource "google_firestore_index" "composite-index" { project = "project-id" database = "database-id" collection = "chatrooms" fields { field_path = "name" order = "ASCENDING" } fields { field_path = "description" order = "DESCENDING" } }
- แทนที่ project-id ด้วยรหัสโปรเจ็กต์ รหัสโปรเจ็กต์ต้องไม่ซ้ำกัน
- แทนที่ database-id ด้วยรหัสฐานข้อมูล
เวลาในการสร้างดัชนี
หากต้องการสร้างดัชนี Cloud Firestore ต้องตั้งค่าดัชนีแล้วทดแทนดัชนีด้วยข้อมูลที่มีอยู่ เวลาสร้างดัชนีคือผลรวมของเวลาตั้งค่าและเวลาโฆษณาทดแทน ดังนี้
การตั้งค่าดัชนีจะใช้เวลา 2-3 นาที เวลาบิลด์ขั้นต่ำสำหรับดัชนีคือ 2-3 นาที แม้ว่าฐานข้อมูลจะว่างเปล่าก็ตาม
เวลาในการทดแทนข้อมูลจะขึ้นอยู่กับปริมาณข้อมูลที่มีอยู่ในดัชนีใหม่ ยิ่งค่าในช่องที่ตรงกับคำจำกัดความของดัชนีมากเท่าไร ก็จะยิ่งใช้เวลาในการทดแทนดัชนีนานขึ้นเท่านั้น
บิลด์ดัชนีเป็นการดำเนินการที่ใช้เวลานาน
หลังจากที่เริ่มต้นบิลด์ดัชนีแล้ว Cloud Firestore จะกำหนดชื่อที่ไม่ซ้ำกันให้การดำเนินการ ชื่อการดำเนินการจะมี projects/[PROJECT_ID]/databases/(default)/operations/
นำหน้า เช่น
projects/project-id/databases/(default)/operations/ASA1MTAwNDQxNAgadGx1YWZlZAcSeWx0aGdpbi1zYm9qLW5pbWRhEgopEg
แต่คุณไม่ต้องใส่คำนำหน้าเมื่อระบุชื่อการดำเนินการสำหรับคำสั่ง describe
แสดงรายการการดำเนินการที่ใช้เวลานานทั้งหมด
หากต้องการแสดงรายการการดำเนินการที่ใช้เวลานาน ให้ใช้คำสั่ง gcloudfirestore Operations list คำสั่งนี้จะแสดงการดำเนินการที่ดำเนินอยู่และที่เพิ่งเสร็จสิ้นไป ระบบจะแสดงการดำเนินการภายใน 2-3 วันหลังจากเสร็จสิ้น
gcloud firestore operations list
ตรวจสอบสถานะการดำเนินการ
แทนที่จะแสดงรายการการดำเนินการที่ใช้เวลานานทั้งหมด คุณระบุรายละเอียดของการดำเนินการเดียวได้ดังนี้
gcloud firestore operations describe operation-name
การประมาณเวลาเสร็จสมบูรณ์
ขณะที่การดำเนินการทำงาน ให้ดูค่าในช่อง state
เพื่อดูสถานะโดยรวมของการดำเนินการ
คำขอสำหรับสถานะของการดำเนินการที่ใช้เวลานานจะแสดงผลเมตริก workEstimated
และ workCompleted
ด้วย ระบบจะแสดงเมตริกเหล่านี้ตามจำนวนเอกสาร workEstimated
แสดงจำนวนเอกสารทั้งหมดโดยประมาณที่การดำเนินการจะประมวลผล workCompleted
แสดงจำนวนเอกสารที่มีการประมวลผลจนถึงปัจจุบัน หลังจากดำเนินการเสร็จสมบูรณ์ workCompleted
จะแสดงจำนวนเอกสารทั้งหมดที่ได้รับการประมวลผลจริง ซึ่งอาจต่างจากค่าของ workEstimated
หาร workCompleted
ด้วย workEstimated
เพื่อดูความคืบหน้าโดยประมาณ ค่าประมาณอาจไม่ถูกต้องเนื่องจากขึ้นอยู่กับการรวบรวมสถิติที่ล่าช้า
ตัวอย่างเช่น สถานะความคืบหน้าของบิลด์ดัชนีมีดังนี้
{ "operations": [ { "name": "projects/project-id/operations/AyAyMDBiM2U5NTgwZDAtZGIyYi0zYjc0LTIzYWEtZjg1ZGdWFmZWQHEjF0c2Flc3UtcmV4ZWRuaS1uaW1kYRUKSBI", "metadata": { "@type": "type.googleapis.com/google.firestore.admin.v1.IndexOperationMetadata", "common": { "operationType": "CREATE_INDEX", "startTime": "2020-06-23T16:52:25.697539Z", "state": "PROCESSING" }, "progressDocuments": { "workCompleted": "219327", "workEstimated": "2198182" } }, }, ...
เมื่อการดำเนินการเสร็จสิ้น คำอธิบายการดำเนินการจะมีคำว่า "done":
true
อยู่ ดูค่าในช่อง state
สำหรับผลลัพธ์ของการดำเนินการ หากไม่ได้ตั้งค่าช่อง done
ในการตอบกลับ ค่าจะเป็น false
อย่าพึ่งพาค่า done
ที่มีอยู่สำหรับการดำเนินการที่กำลังดำเนินการ
ข้อผิดพลาดในการสร้างดัชนี
คุณอาจพบข้อผิดพลาดในการสร้างดัชนีเมื่อจัดการดัชนีผสมและการยกเว้นดัชนีช่องเดียว การดำเนินการจัดทำดัชนีอาจล้มเหลวหาก Cloud Firestore พบปัญหาเกี่ยวกับข้อมูลที่จัดทำดัชนี โดยทั่วไปแล้วหมายความว่าถึงขีดจํากัดของดัชนีแล้ว เช่น การดำเนินการอาจมีรายการดัชนีถึงจำนวนสูงสุดต่อเอกสารแล้ว
หากสร้างดัชนีไม่สำเร็จ คุณจะเห็นข้อความแสดงข้อผิดพลาดในคอนโซล หลังจากตรวจสอบแล้วพบว่าดัชนียังเป็นไปตามขีดจำกัดของดัชนี ให้ลองดำเนินการเกี่ยวกับดัชนีอีกครั้ง