يحدد التكوينات المخصصة لمثيل Cloud Firestore الخاص بك. يجب عليك تعيين هذه قبل استدعاء أي طرق أخرى.
إمضاء:
export declare interface FirestoreSettings
ملكيات
| ملكية | يكتب | وصف |
|---|---|---|
| cacheSizeBytes | رقم | ملاحظة: سيتم إهمال هذا الحقل في إصدار رئيسي مستقبلي. استخدم حقل cache بدلاً من ذلك لتحديد حجم ذاكرة التخزين المؤقت وتكوينات ذاكرة التخزين المؤقت الأخرى. حد تقريبي لحجم ذاكرة التخزين المؤقت للبيانات الموجودة على القرص. إذا تجاوزت ذاكرة التخزين المؤقت هذا الحجم، فسيبدأ Firestore في إزالة البيانات التي لم يتم استخدامها مؤخرًا. الحجم لا يضمن بقاء ذاكرة التخزين المؤقت أقل من هذا الحجم، فقط إذا تجاوزت ذاكرة التخزين المؤقت الحجم المحدد، فستتم محاولة التنظيف. القيمة الافتراضية هي 40 ميغابايت. يجب تعيين الحد إلى 1 ميغابايت على الأقل، ويمكن ضبطه على CACHE_SIZE_UNLIMITED لتعطيل جمع البيانات المهملة. |
| التجريبيةAutoDetectLongPolling | منطقية | يقوم بتكوين النقل الأساسي لـ SDK (WebChannel) لاكتشاف ما إذا كان يجب استخدام الاستقصاء الطويل تلقائيًا. هذا مشابه جدًا لـ experimentalForceLongPolling ، ولكنه يستخدم الاستقصاء الطويل فقط إذا لزم الأمر. بعد الحصول على القيمة الافتراضية false منذ إنشائها في عام 2019، تم تغيير القيمة الافتراضية لهذا الإعداد في مايو 2023 إلى true في الإصدار 9.22.0 من Firebase JavaScript SDK. وهذا يعني أن الاكتشاف التلقائي للاستقصاء الطويل ممكّن الآن بشكل افتراضي. لتعطيله، قم بتعيين هذا الإعداد على false ، ويرجى فتح مشكلة GitHub لمشاركة المشكلات التي دفعتك إلى تعطيل الاكتشاف التلقائي للاستقصاء الطويل. لا يمكن استخدام هذا الإعداد في بيئة Node.js. |
| التجريبيةForceLongPolling | منطقية | يفرض على نقل الشبكة الأساسي لـ SDK (WebChannel) استخدام الاستقصاء الطويل. سيتم إغلاق كل استجابة من الواجهة الخلفية فورًا بعد أن ترسل الواجهة الخلفية البيانات (افتراضيًا، تظل الاستجابات مفتوحة في حالة وجود المزيد من البيانات لإرسالها في الواجهة الخلفية). يؤدي هذا إلى تجنب مشكلات عدم التوافق مع بعض الوكلاء، وبرامج مكافحة الفيروسات، وما إلى ذلك، التي تقوم بتخزين حركة المرور مؤقتًا بشكل غير صحيح إلى أجل غير مسمى. سيؤدي استخدام هذا الخيار إلى تدهور الأداء بالرغم من ذلك. لا يمكن استخدام هذا الإعداد مع experimentalAutoDetectLongPolling وقد تتم إزالته في إصدار مستقبلي. إذا وجدت نفسك تستخدمه لحل مشكلة معينة تتعلق بموثوقية الشبكة، فيرجى إخبارنا عنها في https://github.com/firebase/firebase-js-sdk/issues/1674. لا يمكن استخدام هذا الإعداد في بيئة Node.js. |
| التجريبيةLongPollingOptions | خيارات الاستطلاع الطويلة التجريبية | الخيارات التي تقوم بتكوين نقل الشبكة الأساسي لـ SDK (WebChannel) عند استخدام الاستقصاء الطويل. يتم استخدام هذه الخيارات فقط إذا كانت experimentalForceLongPolling صحيحة أو إذا كانت experimentalAutoDetectLongPolling صحيحة وحدد الاكتشاف التلقائي أن الاستقصاء الطويل مطلوب. وإلا فإن هذه الخيارات ليس لها أي تأثير. |
| يستضيف | خيط | اسم المضيف الذي سيتم الاتصال به. |
| تجاهلUnknownProperties | منطقية | ما إذا كان سيتم تخطي الخصائص المتداخلة التي تم تعيينها على undefined أثناء تسلسل الكائنات. إذا تم تعيينها على true ، فسيتم تخطي هذه الخصائص ولن تتم كتابتها في Firestore. إذا تم تعيينه على false أو تم حذفه، فسيطرح SDK استثناءً عندما يواجه خصائص من النوع undefined . |
| localCache | FirestoreLocalCache | يحدد ذاكرة التخزين المؤقت التي يستخدمها SDK. الخيارات المتاحة هي MemoryLocalCache و PersistentLocalCache ، ولكل منهما خيارات تكوين مختلفة. عندما يكون غير محدد، سيتم استخدام MemoryLocalCache بشكل افتراضي. ملاحظة: سيؤدي تعيين هذا الحقل و cacheSizeBytes في نفس الوقت إلى حدوث استثناء أثناء تهيئة SDK. بدلاً من ذلك، استخدم التكوين الموجود في كائن FirestoreLocalCache لتحديد حجم ذاكرة التخزين المؤقت. |
| ssl | منطقية | ما إذا كان سيتم استخدام SSL عند الاتصال. |
FirestoreSettings.cacheSizeBytes
ملاحظة: سيتم إهمال هذا الحقل في إصدار رئيسي مستقبلي. استخدم حقل cache بدلاً من ذلك لتحديد حجم ذاكرة التخزين المؤقت وتكوينات ذاكرة التخزين المؤقت الأخرى.
حد تقريبي لحجم ذاكرة التخزين المؤقت للبيانات الموجودة على القرص. إذا تجاوزت ذاكرة التخزين المؤقت هذا الحجم، فسيبدأ Firestore في إزالة البيانات التي لم يتم استخدامها مؤخرًا. الحجم لا يضمن بقاء ذاكرة التخزين المؤقت أقل من هذا الحجم، فقط إذا تجاوزت ذاكرة التخزين المؤقت الحجم المحدد، فستتم محاولة التنظيف.
القيمة الافتراضية هي 40 ميغابايت. يجب تعيين الحد إلى 1 ميغابايت على الأقل، ويمكن ضبطه على CACHE_SIZE_UNLIMITED لتعطيل جمع البيانات المهملة.
إمضاء:
cacheSizeBytes?: number;
FirestoreSettings.experimentalAutoDetectLongPolling
يقوم بتكوين النقل الأساسي لـ SDK (WebChannel) لاكتشاف ما إذا كان يجب استخدام الاستقصاء الطويل تلقائيًا. هذا مشابه جدًا لـ experimentalForceLongPolling ، ولكنه يستخدم الاستقصاء الطويل فقط إذا لزم الأمر.
بعد الحصول على القيمة الافتراضية false منذ إنشائها في عام 2019، تم تغيير القيمة الافتراضية لهذا الإعداد في مايو 2023 إلى true في الإصدار 9.22.0 من Firebase JavaScript SDK. وهذا يعني أن الاكتشاف التلقائي للاستقصاء الطويل ممكّن الآن بشكل افتراضي. لتعطيله، قم بتعيين هذا الإعداد إلى false ، ويرجى فتح مشكلة GitHub لمشاركة المشكلات التي دفعتك إلى تعطيل الاكتشاف التلقائي للاستقصاء الطويل.
لا يمكن استخدام هذا الإعداد في بيئة Node.js.
إمضاء:
experimentalAutoDetectLongPolling?: boolean;
FirestoreSettings.experimentalForceLongPolling
يفرض على نقل الشبكة الأساسي لـ SDK (WebChannel) استخدام الاستقصاء الطويل. سيتم إغلاق كل استجابة من الواجهة الخلفية فورًا بعد أن ترسل الواجهة الخلفية البيانات (افتراضيًا، تظل الاستجابات مفتوحة في حالة وجود المزيد من البيانات لإرسالها في الواجهة الخلفية). يؤدي هذا إلى تجنب مشكلات عدم التوافق مع بعض الوكلاء، وبرامج مكافحة الفيروسات، وما إلى ذلك، التي تقوم بتخزين حركة المرور مؤقتًا بشكل غير صحيح إلى أجل غير مسمى. سيؤدي استخدام هذا الخيار إلى تدهور الأداء بالرغم من ذلك.
لا يمكن استخدام هذا الإعداد مع experimentalAutoDetectLongPolling وقد تتم إزالته في إصدار مستقبلي. إذا وجدت نفسك تستخدمه لحل مشكلة معينة تتعلق بموثوقية الشبكة، فيرجى إخبارنا عنها في https://github.com/firebase/firebase-js-sdk/issues/1674.
لا يمكن استخدام هذا الإعداد في بيئة Node.js.
إمضاء:
experimentalForceLongPolling?: boolean;
FirestoreSettings.experimentalLongPollingOptions
الخيارات التي تقوم بتكوين نقل الشبكة الأساسي لـ SDK (WebChannel) عند استخدام الاستقصاء الطويل.
يتم استخدام هذه الخيارات فقط إذا كانت experimentalForceLongPolling صحيحة أو إذا كانت experimentalAutoDetectLongPolling صحيحة وحدد الاكتشاف التلقائي أن الاستقصاء الطويل مطلوب. وإلا فإن هذه الخيارات ليس لها أي تأثير.
إمضاء:
experimentalLongPollingOptions?: ExperimentalLongPollingOptions;
FirestoreSettings.host
اسم المضيف الذي سيتم الاتصال به.
إمضاء:
host?: string;
FirestoreSettings.ignoreUnifiedProperties
ما إذا كان سيتم تخطي الخصائص المتداخلة التي تم تعيينها على undefined أثناء تسلسل الكائنات. إذا تم تعيينه على true ، يتم تخطي هذه الخصائص ولا تتم كتابتها في Firestore. إذا تم تعيينه على false أو تم حذفه، فسيقوم SDK بطرح استثناء عندما يواجه خصائص من النوع undefined .
إمضاء:
ignoreUndefinedProperties?: boolean;
FirestoreSettings.localCache
يحدد ذاكرة التخزين المؤقت التي يستخدمها SDK. الخيارات المتاحة هي MemoryLocalCache و PersistentLocalCache ، ولكل منها خيارات تكوين مختلفة.
عندما يكون غير محدد، سيتم استخدام MemoryLocalCache بشكل افتراضي.
ملاحظة: سيؤدي تعيين هذا الحقل و cacheSizeBytes في نفس الوقت إلى حدوث استثناء أثناء تهيئة SDK. بدلاً من ذلك، استخدم التكوين الموجود في كائن FirestoreLocalCache لتحديد حجم ذاكرة التخزين المؤقت.
إمضاء:
localCache?: FirestoreLocalCache;
FirestoreSettings.ssl
ما إذا كان سيتم استخدام SSL عند الاتصال.
إمضاء:
ssl?: boolean;