FieldOperationMetadata

{
  "changeType": enum (ChangeType),
  "index": {
    object (Index)
  }
}

enum (ChangeType)

מציין את השינויים באינדקס.

object (Index)

האינדקס שמשתנה.

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

string

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

enum (QueryScope)

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

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

enum (ApiScope)

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

object (IndexField)

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

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

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

enum (State)

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

{
  "fieldPath": string,

  // Union field value_mode can be only one of the following:
  "order": enum (Order),
  "arrayConfig": enum (ArrayConfig),
  "vectorConfig": {
    object (VectorConfig)
  }
  // End of list of possible types for union field value_mode.
}

string

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

enum (Order)

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

enum (ArrayConfig)

השדה הזה תומך בפעולות על ערכי arrayValue.

object (VectorConfig)

מציין שהשדה הזה תומך בשכנים הקרובים ביותר ובפעולות מרחק על וקטור.

{
  "dimension": integer,

  // Union field type can be only one of the following:
  "flat": {
    object (FlatIndex)
  }
  // End of list of possible types for union field type.
}

integer

חובה. מאפיין הווקטור שעליו חלה ההגדרה הזו.

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

object (FlatIndex)

מציין שאינדקס הווקטור הוא אינדקס שטוח.

{
  "changeType": enum (ChangeType)
}

enum (ChangeType)

מציין את השינויים בהגדרות של TTL.