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)

מצב השדה.

מצב

המצב קובע איך השדה יתווסף לאינדקס.

טיפוסים בני מנייה (enums)
MODE_UNSPECIFIED המצב לא צוין.
ASCENDING ערכי השדה נוספים לאינדקס כדי לתמוך בסדרת רצף בסדר עולה וגם לבצע שאילתה לפי <, >, <=, >= ו-=.
DESCENDING ערכי השדה נוספים לאינדקס כדי לתמוך בסדרת רצף בסדר יורד וגם לבצע שאילתה לפי <, >, <=, >= ו-=.
ARRAY_CONTAINS ערכי המערך של השדה נוספים לאינדקס כדי לתמוך בחברות באמצעות שאילתות ARRAY_CONTAINS.

ארץ

המצב של אינדקס. במהלך יצירת האינדקס, האינדקס יהיה במצב CREATING. אם האינדקס נוצר בהצלחה, הוא יעבור למצב READY. אם לא ניתן ליצור את האינדקס, הוא יעבור למצב ERROR.

טיפוסים בני מנייה (enums)
STATE_UNSPECIFIED לא צוינה המדינה.
CREATING האינדקס נוצר. יש פעולה פעילה לאורך זמן עבור האינדקס. האינדקס מתעדכן כשכותבים מסמך. ייתכן שיהיו נתוני אינדקס מסוימים.
READY האינדקס מוכן לשימוש. האינדקס מתעדכן כשכותבים מסמך. האינדקס מאוכלס במלואו מכל המסמכים המאוחסנים בו.
ERROR האינדקס נוצר, אבל משהו השתבש. אין פעולה פעילה לטווח ארוך עבור האינדקס, והפעולה הממושכת האחרונה שהסתיימה נכשלה. האינדקס לא מתעדכן כשכותבים מסמך. ייתכן שיהיו נתוני אינדקס מסוימים.

שיטות

create

 יצירת האינדקס שצוין.

delete

 מחיקת אינדקס.

get

 מקבלת אינדקס.

list

 רשימת האינדקסים שתואמים למסננים שצוינו.