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)

وضع الحقل.

الوضع

يحدد الوضع كيفية فهرسة الحقل.

عمليات التعداد
MODE_UNSPECIFIED الوضع غير محدّد.
ASCENDING تتم فهرسة قيم الحقل لإتاحة التسلسل بترتيب تصاعدي وكذلك الاستعلام حسب < و> و<= و>= و =.
DESCENDING تتم فهرسة قيم الحقل لإتاحة التسلسل بترتيب تنازلي وكذلك الاستعلام حسب < و> و<= و>= و =.
ARRAY_CONTAINS تتم فهرسة قيم الصفيف في الحقل لإتاحة العضوية باستخدام طلبات البحث ARRAY_CONTAINS.

الحالة

حالة الفهرس. أثناء إنشاء الفهرس، سيكون الفهرس بالحالة CREATING. في حال إنشاء الفهرس بنجاح، سيتم نقله إلى الحالة READY. وإذا تعذّر إنشاء الفهرس، سيتم نقله إلى الحالة ERROR.

عمليات التعداد
STATE_UNSPECIFIED لم يتم تحديد الولاية.
CREATING يتم إنشاء الفهرس. هناك عملية نشطة لفترة طويلة للفهرس. يتم تحديث الفهرس عند كتابة مستند. قد تتوفر بعض بيانات الفهرس.
READY الفهرس جاهز للاستخدام. يتم تحديث الفهرس عند كتابة مستند. تتم تعبئة الفهرس بالكامل من جميع المستندات المخزنة التي ينطبق عليها.
ERROR تم إنشاء الفهرس، ولكن حدث خطأ. ليست هناك عملية نشطة لفترة طويلة للفهرس، وقد تعذّر إتمام آخر عملية طويلة الأمد تمت معالجتها مؤخرًا. لا يتم تحديث الفهرس عند كتابة مستند. قد تتوفر بعض بيانات الفهرس.

الطُرق

create

 لإنشاء الفهرس المحدد.

delete

 لحذف فهرس.

get

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

list

 يسرد الفهارس التي تتطابق مع الفلاتر المحدّدة.