REST Resource: projects.databases.collectionGroups.indexes

משאב: אינדקס

האינדקסים של Cloud Firestore מאפשרים לבצע שאילתות פשוטות ומורכבות על מסמכים במסד נתונים.

ייצוג JSON 
{
  "name": string,
  "queryScope": enum (QueryScope),
  "apiScope": enum (ApiScope),
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
שדות
name

string

פלט בלבד. שם שהוגדר על ידי שרת לאינדקס הזה. אופן השם של אינדקסים מרוכבים יהיה: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id} אם מדובר באינדקסים עם שדה יחיד, השדה הזה יהיה ריק.
queryScope

enum (QueryScope)

אינדקסים עם היקף שאילתת אוסף שצוין מאפשרים שאילתות באוסף שהוא הצאצא של מסמך ספציפי, שצוין בזמן השאילתה ושיש לו אותו מזהה אוסף.

אינדקסים עם היקף שאילתות של קבוצת אוספים שצוין מאפשרים שאילתות לכל האוספים שיוצאים ממסמך ספציפי, שצוינו בזמן השאילתה ושיש להם אותו מזהה אוסף כמו האינדקס הזה.
apiScope

enum (ApiScope)

היקף ההרשאות של ממשק ה-API שנתמך על ידי האינדקס הזה.
fields[]

object (IndexField)

השדות שנתמכים על ידי האינדקס הזה.

כדי ליצור אינדקסים מורכבים, צריך בין 2 ל-100 שדות לפחות. הערך האחרון בשדה הוא תמיד לנתיב השדה __name__. אם בזמן היצירה, __name__ לא צוין כשדה האחרון, הוא יתווסף באופן אוטומטי עם אותו כיוון כמו זה של השדה האחרון שהוגדר. אם השדה הסופי באינדקס מורכב אינו כיווני, הערך של __name__ יאורגן לפי ASCENDING (אלא אם צוין במפורש).

באינדקסים של שדה יחיד, זו תמיד תהיה רשומה אחת בדיוק עם נתיב שדה ששווה לנתיב השדה של השדה המשויך.
state

enum (State)

פלט בלבד. מצב ההצגה של האינדקס.

שיטות

create

 יצירת אינדקס מורכב.

delete

 מחיקת אינדקס מורכב.

get

 הפונקציה מקבלת אינדקס מורכב.

list

 בתיבת הדו-שיח הזו מפורטים אינדקסים מורכבים.