REST Resource: projects.databases.collectionGroups.indexes

แหล่งข้อมูล: ดัชนี

ดัชนี Cloud Firestore เปิดใช้การค้นหาที่เรียบง่ายและซับซ้อนในเอกสารในฐานข้อมูล

การแสดง JSON 
{
  "name": string,
  "queryScope": enum (QueryScope),
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อที่เซิร์ฟเวอร์กำหนดสำหรับดัชนีนี้ รูปแบบของชื่อนี้สำหรับดัชนีผสมจะเป็น projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id} สำหรับดัชนีช่องเดียว ช่องนี้จะว่างเปล่า
queryScope

enum (QueryScope)

ดัชนีที่มีขอบเขตการค้นหาของคอลเล็กชันที่ระบุอนุญาตการค้นหากับคอลเล็กชันที่เป็นรายการย่อยของเอกสารที่เจาะจง ซึ่งระบุในเวลาสืบค้น และที่มีรหัสคอลเล็กชันเดียวกัน

ดัชนีที่มีขอบเขตการค้นหาของกลุ่มคอลเล็กชันที่ระบุอนุญาตให้มีการค้นหาในคอลเล็กชันทั้งหมดที่มาจากเอกสารที่เจาะจง ซึ่งระบุในเวลาค้นหา และที่มีรหัสคอลเล็กชันเดียวกันกับดัชนีนี้
fields[]

object (IndexField)

ช่องที่ดัชนีนี้รองรับ

สำหรับดัชนีผสม ช่องนี้จะเป็น 2 ช่องขึ้นไปเสมอ รายการช่องสุดท้ายเป็นของเส้นทางช่อง __name__ เสมอ หากเมื่อสร้าง __name__ ไม่ได้ระบุเป็นฟิลด์สุดท้าย ระบบจะเพิ่มฟิลด์นั้นโดยอัตโนมัติในทิศทางเดียวกับฟิลด์สุดท้ายที่กำหนดไว้ หากช่องสุดท้ายในดัชนีผสมไม่มีทิศทาง ระบบจะเรียงลำดับ __name__ จาก ASCENDING (เว้นแต่จะระบุอย่างชัดเจน)

สำหรับดัชนีช่องเดียว ค่านี้จะเป็น 1 รายการที่มีเส้นทางช่องเท่ากับเส้นทางช่องของช่องที่เกี่ยวข้องเสมอ
state

enum (State)

เอาต์พุตเท่านั้น สถานะการแสดงผลของดัชนี

เมธอด

create

 สร้างดัชนีผสม

delete

 ลบดัชนีผสม

get

 รับดัชนีผสม

list

 แสดงรายการดัชนีผสม