REST Resource: projects.databases.collectionGroups.indexes

{
  "name": string,
  "queryScope": enum (QueryScope),
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}

string

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

enum (QueryScope)

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

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

object (IndexField)

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

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

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

enum (State)

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