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)

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

حقل الفهرس

حقل في فهرس

تمثيل JSON 
{
  "fieldPath": string,
  "mode": enum (Mode)
}
الحقول
fieldPath

string

مسار الحقل. يجب أن يتطابق مع مواصفات مسار الحقل الموضّحة في [google.firestore.v1beta1.Document.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

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