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)

نطاق واجهة برمجة التطبيقات المتوافق مع هذا الفهرس.

object (IndexField)

الحقول التي يتيحها هذا الفهرس.

بالنسبة إلى الفهارس المركّبة، يتطلب هذا الأمر حقلين كحد أدنى و100 حقل كحد أقصى. يكون إدخال الحقل الأخير دائمًا لمسار الحقل __name__. في حال عدم تحديد "__name__" كحقل أخير عند الإنشاء، ستتم إضافته تلقائيًا باتجاه الحقل الأخير المحدّد. إذا لم يكن الحقل الأخير في الفهرس المركب توجيهيًا، سيتم ترتيب __name__ تصاعديًا (ما لم يتم تحديد ذلك بشكل صريح).

بالنسبة إلى فهارس الحقل الأحادي، سيكون هذا دائمًا إدخالاً واحدًا فقط مع مسار حقل مساوٍ لمسار الحقل الخاص بالحقل المرتبط.

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).