Index interface

يتم توفير واجهة برمجة التطبيقات هذه كمعاينة للمطوّرين، وقد تتغير استنادًا إلى الملاحظات التي نتلقّاها. لا تستخدم واجهة برمجة التطبيقات هذه في بيئة إنتاج.

بدلاً من إنشاء فهارس ذاكرة التخزين المؤقت يدويًا، يمكنك استخدام enablePersistentCacheIndexAutoCreation() للسماح لحزمة تطوير البرامج (SDK) بتحديد ما إذا كانت ستنشئ فهارس ذاكرة التخزين المؤقت لطلبات البحث التي يتم تشغيلها محليًا.

تعريف حزمة تطوير البرامج (SDK) لفهرس Firestore

Signature:

export declare interface Index 

أماكن إقامة

الموقع النوع الوصف
collectionGroup السلسلة (إصدار تجريبي) معرّف المجموعة المطلوب فهرستها.
الحقول حقل الفهرس[] (إصدار تجريبي) قائمة بالحقول المطلوب فهرستها

Index.collectionGroup

يتم توفير واجهة برمجة التطبيقات هذه كمعاينة للمطوّرين، وقد تتغير استنادًا إلى الملاحظات التي نتلقّاها. لا تستخدم واجهة برمجة التطبيقات هذه في بيئة إنتاج.

رقم تعريف المجموعة المراد فهرستها.

Signature:

readonly collectionGroup: string;

حقول الفهرس

يتم توفير واجهة برمجة التطبيقات هذه كمعاينة للمطوّرين، وقد تتغير استنادًا إلى الملاحظات التي نتلقّاها. لا تستخدم واجهة برمجة التطبيقات هذه في بيئة إنتاج.

قائمة بالحقول المطلوب فهرستها.

Signature:

readonly fields?: IndexField[];