REST Resource: projects.databases.indexes

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

คำจำกัดความของดัชนี

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

string

ชื่อทรัพยากรของดัชนี เอาต์พุตเท่านั้น
collectionId

string

รหัสคอลเล็กชันที่ใช้ดัชนีนี้ ต้องระบุ
fields[]

object (IndexField)

ฟิลด์ที่จะทำดัชนี
state

enum (State)

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

IndexField

ช่องของดัชนี

การแสดง JSON 
{
  "fieldPath": string,
  "mode": enum (Mode)
}
ช่อง
fieldPath

string

เส้นทางของช่อง ต้องตรงกับข้อกำหนดเส้นทางช่องที่อธิบายโดย [google.firestore.v1beta1.Document.fields][fields] คุณใช้เส้นทางช่องพิเศษ __name__ แบบเดี่ยวๆ หรือที่ส่วนท้ายของเส้นทางได้ ใช้ __type__ ได้เฉพาะที่ส่วนท้ายของเส้นทางเท่านั้น
mode

enum (Mode)

โหมดของช่อง

โหมด

โหมดจะเป็นตัวกำหนดวิธีจัดทำดัชนีช่อง

Enum
MODE_UNSPECIFIED ไม่ได้ระบุโหมด
ASCENDING ระบบจะจัดทําดัชนีค่าของช่องเพื่อรองรับการเรียงลำดับจากน้อยไปหามากและข้อความค้นหาตาม <, >, <=, >= และ =
DESCENDING ระบบจะจัดทําดัชนีค่าของช่องเพื่อรองรับการเรียงลำดับจากมากไปหาน้อยและยังค้นหาตาม <, >, <=, >= และ = ด้วย
ARRAY_CONTAINS ระบบจะจัดทำดัชนีค่าอาร์เรย์ของช่องเพื่อรองรับการเป็นสมาชิกโดยใช้การค้นหา ARRAY_CONTAINS

รัฐ

สถานะของดัชนี ในระหว่างการสร้างดัชนี ดัชนีจะอยู่ในสถานะ CREATING หากสร้างดัชนีเรียบร้อยแล้ว ดัชนีจะเปลี่ยนเป็นสถานะ READY หากสร้างดัชนีไม่ได้ ดัชนีจะเปลี่ยนเป็นสถานะ ERROR

Enum
STATE_UNSPECIFIED ไม่ได้ระบุรัฐ
CREATING กำลังสร้างดัชนี มีการดำเนินการที่ใช้เวลานานสำหรับดัชนีที่ใช้งานอยู่ ดัชนีจะมีการอัปเดตเมื่อเขียนเอกสาร อาจมีข้อมูลดัชนีบางอย่างอยู่
READY ดัชนีพร้อมใช้งานแล้ว ดัชนีจะมีการอัปเดตเมื่อเขียนเอกสาร ระบบจะป้อนข้อมูลดัชนีทั้งหมดจากเอกสารที่จัดเก็บทั้งหมดที่ใช้
ERROR กำลังสร้างดัชนี แต่เกิดข้อผิดพลาดขึ้น ไม่มีการดำเนินการแบบระยะยาวที่ดำเนินอยู่สำหรับดัชนี และการดำเนินการที่ใช้เวลานานล่าสุดที่เสร็จสิ้นล้มเหลว ดัชนีไม่อัปเดตเมื่อเขียนเอกสาร อาจมีข้อมูลดัชนีบางอย่างอยู่

วิธีการ

create

 สร้างดัชนีที่ระบุ

delete

 ลบดัชนี

get

 รับดัชนี

list

 แสดงรายการดัชนีที่ตรงกับตัวกรองที่ระบุ