Cloud Firestore örneğiniz için özel yapılandırmaları belirtir. Diğer yöntemleri çağırmadan önce bunları ayarlamanız gerekir.
İmza:
export declare interface FirestoreSettings
Özellikler
| Özellik | Tür | Açıklama |
|---|---|---|
| cacheSizeBytes | sayı | NOT: Bu alan, gelecekteki bir ana sürümde kullanımdan kaldırılacaktır. Önbellek boyutunu ve diğer önbellek yapılandırmalarını belirtmek için bunun yerine cache alanını kullanın.Diskteki veriler için yaklaşık bir önbellek boyutu eşiği. Önbellek bu boyutu aşarsa Firestore, yakın zamanda kullanılmayan verileri kaldırmaya başlar. Boyut, önbelleğin belirtilen boyutun altında kalacağını garanti etmez. Yalnızca önbelleğin belirtilen boyutu aşması durumunda temizlemeye çalışılır.Varsayılan değer 40 MB'tır. Eşik en az 1 MB olarak ayarlanmalıdır. Bu eşik, atık toplamayı devre dışı bırakmak için CACHE_SIZE_UNLIMITED olarak ayarlanabilir. |
| DeneyselAutoDetectLongPolling | boolean | Uzun anketin kullanılıp kullanılmayacağını otomatik olarak algılamak için SDK'nın temel aktarımını (WebChannel) yapılandırır. Bu, experimentalForceLongPolling özelliğine çok benzer, ancak yalnızca gerektiğinde uzun anket yöntemini kullanır.2019'daki başlangıcından bu yana varsayılan değer false olan bu ayarın varsayılan değeri, Mayıs 2023'te Firebase JavaScript SDK'nın 9.22.0 sürümünde true olarak değiştirildi. Yani uzun yoklamanın otomatik algılanması artık varsayılan olarak etkin. Devre dışı bırakmak için bu ayarı false olarak belirleyin ve uzun anketler için otomatik algılamayı devre dışı bırakmanıza neden olan sorunları paylaşmak üzere bir GitHub sorununu açın.Bu ayar Node.js ortamında kullanılamaz. |
| DeneyselForceLongPolling | boolean | SDK'nın temel ağ aktarımını (WebChannel) uzun anket kullanmaya zorlar. Arka uçtan gelen her yanıt, arka uç veri gönderdikten hemen sonra kapatılır (Arka ucun gönderilecek daha fazla veri olması durumunda varsayılan olarak yanıtlar açık tutulur). Bu sayede, trafiği sürekli olarak yanlış bir şekilde arabelleğe alan belirli proxy'ler, virüsten koruma yazılımları vb. ile ilgili uyumsuzluk sorunları önlenir. Bu seçeneğin kullanılması performansta bir miktar düşüşe neden olur.Bu ayar experimentalAutoDetectLongPolling ile kullanılamaz ve gelecekteki bir sürümde kaldırılabilir. Bu özelliği belirli bir ağ güvenilirliği sorununu çözmek için kullanıyorsanız lütfen https://github.com/firebase/firebase-js-sdk/issues/1674 sayfasında bunu bize bildirin.Bu ayar, Node.js ortamında kullanılamaz. |
| DeneyselLongPollingOptions | DeneyselLongPollingOptions | Uzun anket kullanılırken SDK'nın temel ağ aktarımını (WebChannel) yapılandıran seçenekler.Bu seçenekler yalnızca experimentalForceLongPolling doğru veya experimentalAutoDetectLongPolling doğruysa ve otomatik algılama tarafından uzun anket yapılması gerektiğini belirlendiyse kullanılır. Aksi takdirde bu seçeneklerin herhangi bir etkisi olmaz. |
| ana makine | dize | Bağlanılacak ana makinenin adı. |
| ignoreUndefinedProperties | boolean | Nesne serileştirme sırasında undefined olarak ayarlanmış iç içe yerleştirilmiş özelliklerin atlanıp atlanmayacağı. true olarak ayarlanırsa bu özellikler atlanır ve Firestore'a yazılmaz. false olarak ayarlanırsa veya atlanırsa SDK, undefined türündeki özelliklerle karşılaştığında bir istisna bildirir. |
| localCache | FirestoreLocalCache | SDK tarafından kullanılan önbelleği belirtir. Her biri farklı yapılandırma seçeneklerine sahip MemoryLocalCache ve PersistentLocalCache seçenekleri kullanılabilir.Belirtilmediğinde varsayılan olarak MemoryLocalCache kullanılır.NOT: Bu alanın ve cacheSizeBytes'in aynı anda ayarlanması, SDK başlatma sırasında istisna oluşturur. Bunun yerine, önbellek boyutunu belirtmek için FirestoreLocalCache nesnesindeki yapılandırmayı kullanın. |
| ssl | boolean | Bağlanırken SSL kullanılıp kullanılmayacağını belirler. |
FirestoreSettings.cacheSizeBytes
NOT: Bu alan, gelecekteki bir ana sürümde kullanımdan kaldırılacaktır. Önbellek boyutunu ve diğer önbellek yapılandırmalarını belirtmek için bunun yerine cache alanını kullanın.
Disk üzerindeki veriler için yaklaşık bir önbellek boyutu eşiği. Önbellek bu boyutu aşarsa Firestore, yakın zamanda kullanılmayan verileri kaldırmaya başlar. Boyut, önbelleğin belirtilen boyutun altında kalacağını garanti etmez. Yalnızca önbelleğin belirtilen boyutu aşması durumunda temizleme girişiminde bulunulur.
Varsayılan değer 40 MB'tır. Eşik en az 1 MB olarak ayarlanmalıdır. Bu eşik, atık toplamayı devre dışı bırakmak için CACHE_SIZE_UNLIMITED olarak ayarlanabilir.
İmza:
cacheSizeBytes?: number;
FirestoreSettings.experimentalAutoDetectLongPolling.
Uzun anketin kullanılıp kullanılmayacağını otomatik olarak algılamak için SDK'nın temel aktarımını (WebChannel) yapılandırır. Bu, experimentalForceLongPolling ile çok benzerdir ancak yalnızca gerektiğinde uzun anketler kullanır.
2019'daki başlangıcından bu yana varsayılan değer false olan bu ayarın varsayılan değeri, Mayıs 2023'te Firebase JavaScript SDK'nın 9.22.0 sürümünde true olarak değiştirildi. Yani uzun yoklamanın otomatik algılanması artık varsayılan olarak etkin. Özelliği devre dışı bırakmak için bu ayarı false olarak belirleyin. Ayrıca, uzun anketler için otomatik algılamayı devre dışı bırakmanıza neden olan sorunları paylaşmak üzere bir GitHub sorununu açın.
Bu ayar, Node.js ortamında kullanılamaz.
İmza:
experimentalAutoDetectLongPolling?: boolean;
FirestoreSettings.experimentalForceLongPolling
SDK'nın temel ağ aktarımını (WebChannel) uzun anket kullanmaya zorlar. Arka uçtan gelen her yanıt, arka uç veri gönderdikten hemen sonra kapatılır (Arka ucun gönderilecek daha fazla veri olması durumunda varsayılan olarak yanıtlar açık tutulur). Bu sayede, trafiği sürekli olarak yanlış bir şekilde arabelleğe alan belirli proxy'ler, virüsten koruma yazılımları vb. ile ilgili uyumsuzluk sorunları önlenir. Bu seçeneğin kullanılması performansta bir miktar düşüşe neden olur.
Bu ayar experimentalAutoDetectLongPolling ile kullanılamaz ve gelecekteki bir sürümde kaldırılabilir. Belirli bir ağ güvenilirliği sorununu çözmek için bu API'yi kullandığınızı düşünüyorsanız lütfen https://github.com/firebase/firebase-js-sdk/issues/1674 adresinden bize bildirin.
Bu ayar, Node.js ortamında kullanılamaz.
İmza:
experimentalForceLongPolling?: boolean;
FirestoreSettings.experimentalLongPollingOptions
Uzun anket kullanılırken SDK'nın temel ağ aktarımını (WebChannel) yapılandıran seçenekler.
Bu seçenekler yalnızca experimentalForceLongPolling doğru veya experimentalAutoDetectLongPolling doğru ise ve otomatik algılama tarafından uzun anket yapılması gerektiği belirlendiyse kullanılır. Aksi takdirde bu seçeneklerin herhangi bir etkisi olmaz.
İmza:
experimentalLongPollingOptions?: ExperimentalLongPollingOptions;
FirestoreSettings.host
Bağlanılacak ana makinenin adı.
İmza:
host?: string;
FirestoreSettings.ignoreUndefinedProperties
Nesne serileştirme sırasında undefined olarak ayarlanmış iç içe yerleştirilmiş özelliklerin atlanıp atlanmayacağı. true olarak ayarlanırsa bu özellikler atlanır ve Firestore'a yazılmaz. false olarak ayarlanırsa veya atlanırsa SDK, undefined türündeki özelliklerle karşılaştığında bir istisna bildirir.
İmza:
ignoreUndefinedProperties?: boolean;
FirestoreSettings.localCache
SDK tarafından kullanılan önbelleği belirtir. Her biri farklı yapılandırma seçeneklerine sahip olan MemoryLocalCache ve PersistentLocalCache seçenekleri kullanılabilir.
Belirtilmemesi durumunda varsayılan olarak MemoryLocalCache kullanılır.
NOT: Bu alanın ve cacheSizeBytes öğesinin aynı anda ayarlanması, SDK başlatma sırasında istisna oluşturur. Bunun yerine, önbellek boyutunu belirtmek için FirestoreLocalCache nesnesindeki yapılandırmayı kullanın.
İmza:
localCache?: FirestoreLocalCache;
FirestoreSettings.ssl
Bağlanırken SSL kullanılıp kullanılmayacağını belirler.
İmza:
ssl?: boolean;