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