Gibt benutzerdefinierte Konfigurationen für Ihre Cloud Firestore-Instanz an. Sie müssen diese festlegen, bevor Sie andere Methoden aufrufen.
Unterschrift:
export declare interface FirestoreSettings
Eigenschaften
| Eigentum | Typ | Beschreibung |
|---|---|---|
| CacheSizeBytes | Nummer | HINWEIS: Dieses Feld wird in einer zukünftigen Hauptversion nicht mehr unterstützt. Verwenden Sie stattdessen cache Feld, um die Cache-Größe und andere Cache-Konfigurationen anzugeben. Ein ungefährer Cache-Größenschwellenwert für die Daten auf der Festplatte. Wenn der Cache diese Größe überschreitet, beginnt Firestore damit, Daten zu entfernen, die kürzlich nicht verwendet wurden. Die Größe ist keine Garantie dafür, dass der Cache unter dieser Größe bleibt, sondern nur, dass eine Bereinigung versucht wird, wenn der Cache die angegebene Größe überschreitet. Der Standardwert ist 40 MB. Der Schwellenwert muss auf mindestens 1 MB festgelegt werden und kann auf CACHE_SIZE_UNLIMITED gesetzt werden, um die Garbage Collection zu deaktivieren. |
| experimentellAutoDetectLongPolling | Boolescher Wert | Konfiguriert den zugrunde liegenden Transport des SDK (WebChannel), um automatisch zu erkennen, ob Long-Polling verwendet werden soll. Dies ist sehr ähnlich zu experimentalForceLongPolling , verwendet jedoch nur bei Bedarf eine lange Abfrage. Nachdem es seit seiner Einführung im Jahr 2019 einen Standardwert von „ false gab, wurde der Standardwert dieser Einstellung im Mai 2023 in Version 9.22.0 des Firebase JavaScript SDK in „ true geändert. Das heißt, die automatische Erkennung langer Abfragen ist jetzt standardmäßig aktiviert. Um es zu deaktivieren, setzen Sie diese Einstellung auf false und öffnen Sie bitte ein GitHub-Problem, um die Probleme zu teilen, die Sie dazu veranlasst haben, die automatische Erkennung langer Abfragen zu deaktivieren. Diese Einstellung kann nicht in einer Node.js-Umgebung verwendet werden. |
| experimentellForceLongPolling | Boolescher Wert | Erzwingt die Verwendung von Long-Polling durch den zugrunde liegenden Netzwerktransport (WebChannel) des SDK. Jede Antwort vom Backend wird sofort geschlossen, nachdem das Backend Daten gesendet hat (standardmäßig bleiben Antworten offen, für den Fall, dass das Backend weitere Daten senden muss). Dadurch werden Inkompatibilitätsprobleme mit bestimmten Proxys, Antivirensoftware usw. vermieden, die den Datenverkehr fälschlicherweise auf unbestimmte Zeit puffern. Die Verwendung dieser Option führt jedoch zu einer gewissen Leistungseinbuße. Diese Einstellung kann nicht mit experimentalAutoDetectLongPolling verwendet werden und wird möglicherweise in einer zukünftigen Version entfernt. Wenn Sie es verwenden, um ein bestimmtes Problem mit der Netzwerkzuverlässigkeit zu umgehen, teilen Sie uns dies bitte unter https://github.com/firebase/firebase-js-sdk/issues/1674 mit. Diese Einstellung kann nicht in einer Node.js-Umgebung verwendet werden. |
| experimentellLongPollingOptions | ExperimentelleLongPollingOptions | Optionen, die den zugrunde liegenden Netzwerktransport (WebChannel) des SDK konfigurieren, wenn Long-Polling verwendet wird. Diese Optionen werden nur verwendet, wenn experimentalForceLongPolling den Wert „true“ hat oder wenn experimentalAutoDetectLongPolling “ den Wert „true“ hat und die automatische Erkennung festgestellt hat, dass eine lange Abfrage erforderlich ist. Andernfalls haben diese Optionen keine Wirkung. |
| Gastgeber | Zeichenfolge | Der Hostname, mit dem eine Verbindung hergestellt werden soll. |
| ignorierenUndefinierteEigenschaften | Boolescher Wert | Ob verschachtelte Eigenschaften übersprungen werden sollen, die während der Objektserialisierung auf undefined gesetzt sind. Bei Festlegung auf true werden diese Eigenschaften übersprungen und nicht in Firestore geschrieben. Wenn der Wert auf false gesetzt oder weggelassen wird, löst das SDK eine Ausnahme aus, wenn es auf Eigenschaften vom Typ undefined trifft. |
| localCache | FirestoreLocalCache | Gibt den vom SDK verwendeten Cache an. Verfügbare Optionen sind MemoryLocalCache und PersistentLocalCache mit jeweils unterschiedlichen Konfigurationsoptionen. Wenn keine Angabe erfolgt, wird standardmäßig MemoryLocalCache verwendet. HINWEIS: Wenn Sie dieses Feld und cacheSizeBytes gleichzeitig festlegen, wird während der SDK-Initialisierung eine Ausnahme ausgelöst. Verwenden Sie stattdessen die Konfiguration im FirestoreLocalCache Objekt, um die Cachegröße anzugeben. |
| SSL | Boolescher Wert | Ob beim Herstellen einer Verbindung SSL verwendet werden soll. |
FirestoreSettings.cacheSizeBytes
HINWEIS: Dieses Feld wird in einer zukünftigen Hauptversion nicht mehr unterstützt. Verwenden Sie stattdessen cache Feld, um die Cache-Größe und andere Cache-Konfigurationen anzugeben.
Ein ungefährer Cache-Größenschwellenwert für die Daten auf der Festplatte. Wenn der Cache diese Größe überschreitet, beginnt Firestore damit, Daten zu entfernen, die kürzlich nicht verwendet wurden. Die Größe ist keine Garantie dafür, dass der Cache unter dieser Größe bleibt, sondern nur, dass eine Bereinigung versucht wird, wenn der Cache die angegebene Größe überschreitet.
Der Standardwert ist 40 MB. Der Schwellenwert muss auf mindestens 1 MB festgelegt werden und kann auf CACHE_SIZE_UNLIMITED gesetzt werden, um die Garbage Collection zu deaktivieren.
Unterschrift:
cacheSizeBytes?: number;
FirestoreSettings.experimentalAutoDetectLongPolling
Konfiguriert den zugrunde liegenden Transport des SDK (WebChannel), um automatisch zu erkennen, ob Long-Polling verwendet werden sollte. Dies ist dem experimentalForceLongPolling sehr ähnlich , nutzt aber Long-Polling nur bei Bedarf.
Nachdem es seit seiner Einführung im Jahr 2019 einen Standardwert von „ false gab, wurde der Standardwert dieser Einstellung im Mai 2023 in Version 9.22.0 des Firebase JavaScript SDK in „ true geändert. Das heißt, die automatische Erkennung langer Abfragen ist jetzt standardmäßig aktiviert. Um es zu deaktivieren, setzen Sie diese Einstellung auf false , und öffnen Sie bitte ein GitHub-Problem, um die Probleme mitzuteilen, die Sie dazu motiviert haben, die automatische Erkennung langer Abfragen zu deaktivieren.
Diese Einstellung kann nicht in einer Node.js-Umgebung verwendet werden.
Unterschrift:
experimentalAutoDetectLongPolling?: boolean;
FirestoreSettings.experimentalForceLongPolling
Erzwingt die Verwendung von Long-Polling durch den zugrunde liegenden Netzwerktransport (WebChannel) des SDK. Jede Antwort vom Backend wird sofort geschlossen, nachdem das Backend Daten gesendet hat (standardmäßig bleiben Antworten offen, für den Fall, dass das Backend weitere Daten senden muss). Dadurch werden Inkompatibilitätsprobleme mit bestimmten Proxys, Antivirensoftware usw. vermieden, die den Datenverkehr fälschlicherweise auf unbestimmte Zeit puffern. Die Verwendung dieser Option führt jedoch zu einer gewissen Leistungseinbuße.
Diese Einstellung kann nicht mit experimentalAutoDetectLongPolling verwendet werden und wird möglicherweise in einer zukünftigen Version entfernt. Wenn Sie es verwenden, um ein bestimmtes Problem mit der Netzwerkzuverlässigkeit zu umgehen, teilen Sie uns dies bitte unter https://github.com/firebase/firebase-js-sdk/issues/1674 mit.
Diese Einstellung kann nicht in einer Node.js-Umgebung verwendet werden.
Unterschrift:
experimentalForceLongPolling?: boolean;
FirestoreSettings.experimentalLongPollingOptions
Optionen, die den zugrunde liegenden Netzwerktransport (WebChannel) des SDK konfigurieren, wenn Long-Polling verwendet wird.
Diese Optionen werden nur verwendet, wenn experimentalForceLongPolling den Wert „true“ hat oder wenn experimentalAutoDetectLongPolling “ den Wert „true“ hat und die automatische Erkennung festgestellt hat, dass eine lange Abfrage erforderlich ist. Andernfalls haben diese Optionen keine Wirkung.
Unterschrift:
experimentalLongPollingOptions?: ExperimentalLongPollingOptions;
FirestoreSettings.host
Der Hostname, mit dem eine Verbindung hergestellt werden soll.
Unterschrift:
host?: string;
FirestoreSettings.ignoreUndefinedProperties
Ob verschachtelte Eigenschaften übersprungen werden sollen, die während der Objektserialisierung auf undefined gesetzt sind. Wenn auf true gesetzt , werden diese Eigenschaften übersprungen und nicht in Firestore geschrieben. Wenn der Wert auf false gesetzt oder weggelassen wird, löst das SDK eine Ausnahme aus, wenn es auf Eigenschaften vom Typ undefined trifft .
Unterschrift:
ignoreUndefinedProperties?: boolean;
FirestoreSettings.localCache
Gibt den vom SDK verwendeten Cache an. Verfügbare Optionen sind MemoryLocalCache und PersistentLocalCache , jeweils mit unterschiedlichen Konfigurationsmöglichkeiten.
Wenn keine Angabe erfolgt, wird standardmäßig MemoryLocalCache verwendet.
HINWEIS: Wenn Sie dieses Feld und cacheSizeBytes gleichzeitig festlegen, wird während der SDK-Initialisierung eine Ausnahme ausgelöst. Verwenden Sie stattdessen die Konfiguration im FirestoreLocalCache Objekt, um die Cachegröße anzugeben.
Unterschrift:
localCache?: FirestoreLocalCache;
FirestoreSettings.ssl
Ob beim Herstellen einer Verbindung SSL verwendet werden soll.
Unterschrift:
ssl?: boolean;