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)

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

object (IndexField)

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

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

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

enum (State)

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

الطُرق

create

 ينشئ فهرسًا مركبًا.

delete

 حذف فهرس مركب.

get

 الحصول على فهرس مركب.

list

 يدرج الفهارس المركّبة.