REST Resource: projects.databases.collectionGroups.indexes

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

string

النتائج فقط. اسم محدد من قِبل الخادم لهذا الفهرس. سيكون هذا الاسم للفهارس المركّبة كما يلي: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id} بالنسبة إلى فهارس الحقل الفردي، سيكون هذا الحقل فارغًا.

enum (QueryScope)

تسمح الفهارس ذات نطاق طلب بحث المجموعة المحدد بطلبات البحث ضمن مجموعة تابعة لمستند معيّن، والتي تم تحديدها في وقت طلب البحث، وتحتوي على معرّف المجموعة نفسه.

إنّ الفهارس ذات نطاق طلبات البحث المحدّدة لمجموعة المجموعات تسمح بطلبات البحث مقابل كل المجموعات الواردة من مستند معيّن، والتي يتم تحديدها في وقت طلب البحث، والتي لها معرّف المجموعة نفسه كهذا الفهرس.

object (IndexField)

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

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

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

enum (State)

النتائج فقط. حالة عرض الفهرس