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)

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

ฟิลด์ดัชนี

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

การแสดง 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

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