מציין תצורות מותאמות אישית עבור מופע Cloud Firestore שלך. עליך להגדיר את אלה לפני שתפעיל שיטות אחרות.
חֲתִימָה:
export declare interface FirestoreSettings
נכסים
| תכונה | סוּג | תיאור |
|---|---|---|
| cacheSizeBytes | מספר | הערה: שדה זה ייצא משימוש במהדורה גדולה עתידית. השתמש בשדה cache במקום זאת כדי לציין גודל מטמון ותצורות מטמון אחרות. סף משוער של גודל מטמון עבור הנתונים בדיסק. אם המטמון יגדל מעבר לגודל זה, Firestore תתחיל להסיר נתונים שלא נעשה בהם שימוש לאחרונה. הגודל אינו ערובה לכך שהמטמון יישאר מתחת לגודל זה, רק שאם המטמון חורג מהגודל הנתון, יתבצע ניסיון ניקוי. ערך ברירת המחדל הוא 40 MB. יש להגדיר את הסף ל-1 MB לפחות, וניתן להגדיר אותו ל- CACHE_SIZE_UNLIMITED כדי להשבית את איסוף האשפה. |
| ניסויAutoDetectLongPolling | בוליאני | מגדיר את התחבורה הבסיסית של ה-SDK (WebChannel) כדי לזהות אוטומטית אם יש להשתמש בסקר ארוך. זה דומה מאוד ל- experimentalForceLongPolling , אבל משתמש רק ב-long-polling במידת הצורך. לאחר שהיה לו ערך ברירת מחדל של false מאז הקמתה ב-2019, ערך ברירת המחדל של הגדרה זו שונה במאי 2023 ל- true בגרסה 9.22.0 של Firebase JavaScript SDK. כלומר, זיהוי אוטומטי של סקר ארוך מופעל כעת כברירת מחדל. כדי להשבית אותו, הגדר את ההגדרה הזו ל- false , ופתח בעיית GitHub כדי לשתף את הבעיות שהניעו אותך להשבית את הזיהוי האוטומטי של סקר ארוך. לא ניתן להשתמש בהגדרה זו בסביבת Node.js. |
| experimentalForceLongPolling | בוליאני | מאלץ את תעבורת הרשת הבסיסית של ה-SDK (WebChannel) להשתמש בסקר ארוך. כל תגובה מה-backend תיסגר מיד לאחר שה-backend שולח נתונים (כברירת מחדל תגובות נשמרות פתוחות למקרה של backend יש יותר נתונים לשלוח). זה ימנע בעיות אי-תאימות עם פרוקסי מסוימים, תוכנות אנטי-וירוס וכו' שחוסמות תעבורה שגויה ללא הגבלת זמן. שימוש באפשרות זו יגרום לירידה מסוימת בביצועים. לא ניתן להשתמש בהגדרה זו עם experimentalAutoDetectLongPolling וייתכן שהיא תוסר במהדורה עתידית. אם אתה מוצא את עצמך משתמש בו כדי לעקוף בעיית אמינות רשת ספציפית, אנא ספר לנו עליה ב-https://github.com/firebase/firebase-js-sdk/issues/1674. לא ניתן להשתמש בהגדרה זו בסביבת Node.js. |
| experimentalLongPollingOptions | ExperimentalLongPollingOptions | אפשרויות שמגדירות את תעבורת הרשת הבסיסית של ה-SDK (WebChannel) כאשר נעשה שימוש בסקר ארוך. אפשרויות אלה משמשות רק אם experimentalForceLongPolling נכון או אם experimentalAutoDetectLongPolling נכון והזיהוי האוטומטי קבע שיש צורך בסקר ארוך. אחרת, לאפשרויות אלה אין השפעה. |
| מנחה | חוּט | שם המארח שאליו יש להתחבר. |
| ignoreUndefinedProperties | בוליאני | האם לדלג על מאפיינים מקוננים שהוגדרו כבלתי undefined במהלך סידור אובייקטים. אם מוגדר כ- true , מאפיינים אלו מדלגים ולא נכתבים ל-Firestore. אם מוגדר כ- false או מושמט, ה-SDK זורק חריג כאשר הוא נתקל במאפיינים מסוג undefined . |
| localCache | FirestoreLocalCache | מציין את המטמון בשימוש ה-SDK. האפשרויות הזמינות הן MemoryLocalCache ו- PersistentLocalCache , כל אחת עם אפשרויות תצורה שונות. כאשר לא צוין, MemoryLocalCache ישמש כברירת מחדל. הערה: הגדרת שדה זה ו- cacheSizeBytes בו-זמנית תגרום לחריגה במהלך אתחול SDK. במקום זאת, השתמש בתצורה באובייקט FirestoreLocalCache כדי לציין את גודל המטמון. |
| ssl | בוליאני | האם להשתמש ב-SSL בעת חיבור. |
FirestoreSettings.cacheSizeBytes
הערה: שדה זה ייצא משימוש במהדורה גדולה עתידית. השתמש בשדה cache במקום זאת כדי לציין גודל מטמון ותצורות מטמון אחרות.
סף משוער של גודל מטמון עבור הנתונים בדיסק. אם המטמון יגדל מעבר לגודל זה, Firestore תתחיל להסיר נתונים שלא נעשה בהם שימוש לאחרונה. הגודל אינו ערובה לכך שהמטמון יישאר מתחת לגודל זה, רק שאם המטמון חורג מהגודל הנתון, יתבצע ניסיון ניקוי.
ערך ברירת המחדל הוא 40 MB. יש להגדיר את הסף ל-1 MB לפחות, וניתן להגדיר אותו ל- 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) להשתמש בסקר ארוך. כל תגובה מה-backend תיסגר מיד לאחר שה-backend שולח נתונים (כברירת מחדל תגובות נשמרות פתוחות למקרה של backend יש יותר נתונים לשלוח). זה ימנע בעיות אי-תאימות עם פרוקסי מסוימים, תוכנות אנטי-וירוס וכו' שחוסמות תעבורה שגויה ללא הגבלת זמן. שימוש באפשרות זו יגרום לירידה מסוימת בביצועים.
לא ניתן להשתמש בהגדרה זו עם 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.ignoreUndefinedProperties
האם לדלג על מאפיינים מקוננים שהוגדרו כבלתי undefined במהלך סידור אובייקטים. אם מוגדר כ- true , מאפיינים אלו מדלגים ואינם נכתבים ל-Firestore. אם מוגדר כ- false או מושמט, ה-SDK זורק חריג כאשר הוא נתקל במאפיינים מסוג undefined .
חֲתִימָה:
ignoreUndefinedProperties?: boolean;
FirestoreSettings.localCache
מציין את המטמון בשימוש ה-SDK. האפשרויות הזמינות הן MemoryLocalCache ו- PersistentLocalCache , כל אחד עם אפשרויות תצורה שונות.
כאשר לא צוין, MemoryLocalCache ישמש כברירת מחדל.
הערה: הגדרת שדה זה ו- cacheSizeBytes בו-זמנית תגרום לחריגה במהלך אתחול SDK. במקום זאת, השתמש בתצורה באובייקט FirestoreLocalCache כדי לציין את גודל המטמון.
חֲתִימָה:
localCache?: FirestoreLocalCache;
FirestoreSettings.ssl
האם להשתמש ב-SSL בעת חיבור.
חֲתִימָה:
ssl?: boolean;