Ein Schreibstapel, der zum Ausführen mehrerer Schreibvorgänge als einzelne atomare Einheit verwendet wird.
Ein WriteBatch Objekt kann durch Aufrufen von writeBatch() abgerufen werden. . Es bietet Methoden zum Hinzufügen von Schreibvorgängen zum Schreibstapel. Keiner der Schreibvorgänge wird festgeschrieben (oder lokal sichtbar), bis WriteBatch.commit() aufgerufen wird.
Unterschrift:
export declare class WriteBatch
Methoden
| Methode | Modifikatoren | Beschreibung |
|---|---|---|
| begehen() | Übernimmt alle Schreibvorgänge in diesem Schreibstapel als einzelne atomare Einheit. Das Ergebnis dieser Schreibvorgänge spiegelt sich nur in Dokumentlesevorgängen wider, die nach der Auflösung des zurückgegebenen Versprechens erfolgen. Wenn der Client offline ist, schlägt der Schreibvorgang fehl. Wenn Sie lokale Änderungen oder Pufferschreibvorgänge sehen möchten, bis der Client online ist, verwenden Sie das vollständige Firestore SDK. | |
| delete(documentRef) | Löscht das Dokument, auf das durch die bereitgestellte DocumentReference verwiesen wird . | |
| set(documentRef, data) | Schreibt in das Dokument, auf das durch die bereitgestellte DocumentReference verwiesen wird . Wenn das Dokument noch nicht existiert, wird es erstellt. | |
| set(documentRef, Daten, Optionen) | Schreibt in das Dokument, auf das durch die bereitgestellte DocumentReference verwiesen wird . Wenn das Dokument noch nicht existiert, wird es erstellt. Wenn Sie merge oder mergeFields bereitstellen, können die bereitgestellten Daten in ein vorhandenes Dokument eingefügt werden. | |
| update(documentRef, data) | Aktualisiert Felder im Dokument, auf das durch die bereitgestellte DocumentReference verwiesen wird . Die Aktualisierung schlägt fehl, wenn sie auf ein nicht vorhandenes Dokument angewendet wird. | |
| update(documentRef, Feld, Wert, moreFieldsAndValues) | Aktualisiert Felder im Dokument, auf das sich diese DocumentReference bezieht . Die Aktualisierung schlägt fehl, wenn sie auf ein nicht vorhandenes Dokument angewendet wird. Verschachtelte Felder können aktualisiert werden, indem durch Punkte getrennte Feldpfadzeichenfolgen oder FieldPath Objekte bereitgestellt werden. |
WriteBatch.commit()
Übernimmt alle Schreibvorgänge in diesem Schreibstapel als einzelne atomare Einheit.
Das Ergebnis dieser Schreibvorgänge spiegelt sich nur in Dokumentlesevorgängen wider, die nach der Auflösung des zurückgegebenen Versprechens erfolgen. Wenn der Client offline ist, schlägt der Schreibvorgang fehl. Wenn Sie lokale Änderungen oder Pufferschreibvorgänge sehen möchten, bis der Client online ist, verwenden Sie das vollständige Firestore SDK.
Unterschrift:
commit(): Promise<void>;
Kehrt zurück:
Versprechen<void>
Ein Promise wird aufgelöst, sobald alle Schreibvorgänge im Stapel erfolgreich als atomare Einheit in das Backend geschrieben wurden (beachten Sie, dass es nicht aufgelöst wird, während Sie offline sind).
WriteBatch.delete()
Löscht das Dokument, auf das durch die bereitgestellte DocumentReference verwiesen wird .
Unterschrift:
delete<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): WriteBatch;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| documentRef | Dokumentverweis <AppModelType, DbModelType> | Ein Verweis auf das zu löschende Dokument. |
Kehrt zurück:
Diese WriteBatch Instanz. Wird zum Verketten von Methodenaufrufen verwendet.
WriteBatch.set()
Schreibt in das Dokument, auf das durch die bereitgestellte DocumentReference verwiesen wird . Wenn das Dokument noch nicht existiert, wird es erstellt.
Unterschrift:
set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): WriteBatch;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| documentRef | Dokumentverweis <AppModelType, DbModelType> | Ein Verweis auf das festzulegende Dokument. |
| Daten | WithFieldValue <AppModelType> | Ein Objekt der Felder und Werte für das Dokument. |
Kehrt zurück:
Diese WriteBatch Instanz. Wird zum Verketten von Methodenaufrufen verwendet.
WriteBatch.set()
Schreibt in das Dokument, auf das durch die bereitgestellte DocumentReference verwiesen wird . Wenn das Dokument noch nicht existiert, wird es erstellt. Wenn Sie merge oder mergeFields bereitstellen können die bereitgestellten Daten in ein bestehendes Dokument eingefügt werden.
Unterschrift:
set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: PartialWithFieldValue<AppModelType>, options: SetOptions): WriteBatch;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| documentRef | Dokumentverweis <AppModelType, DbModelType> | Ein Verweis auf das festzulegende Dokument. |
| Daten | PartialWithFieldValue <AppModelType> | Ein Objekt der Felder und Werte für das Dokument. |
| Optionen | SetOptions | Ein Objekt zum Konfigurieren des festgelegten Verhaltens. |
Kehrt zurück:
Diese WriteBatch Instanz. Wird zum Verketten von Methodenaufrufen verwendet.
Ausnahmen
Fehler – Wenn die bereitgestellte Eingabe kein gültiges Firestore-Dokument ist.
WriteBatch.update()
Aktualisiert Felder im Dokument, auf das durch die bereitgestellte DocumentReference verwiesen wird . Die Aktualisierung schlägt fehl, wenn sie auf ein nicht vorhandenes Dokument angewendet wird.
Unterschrift:
update<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: UpdateData<DbModelType>): WriteBatch;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| documentRef | Dokumentverweis <AppModelType, DbModelType> | Ein Verweis auf das zu aktualisierende Dokument. |
| Daten | Daten aktualisieren <DbModelType> | Ein Objekt, das die Felder und Werte enthält, mit denen das Dokument aktualisiert werden soll. Felder können Punkte enthalten, um auf verschachtelte Felder im Dokument zu verweisen. |
Kehrt zurück:
Diese WriteBatch Instanz. Wird zum Verketten von Methodenaufrufen verwendet.
Ausnahmen
Fehler – Wenn die bereitgestellte Eingabe keine gültigen Firestore-Daten ist.
WriteBatch.update()
Aktualisiert Felder im Dokument, auf das sich diese DocumentReference bezieht . Die Aktualisierung schlägt fehl, wenn sie auf ein nicht vorhandenes Dokument angewendet wird.
Verschachtelte Felder können aktualisiert werden, indem durch Punkte getrennte Feldpfadzeichenfolgen oder FieldPath Objekte bereitgestellt werden.
Unterschrift:
update<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): WriteBatch;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| documentRef | Dokumentverweis <AppModelType, DbModelType> | Ein Verweis auf das zu aktualisierende Dokument. |
| Feld | Zeichenfolge | FieldPath | Das erste zu aktualisierende Feld. |
| Wert | Unbekannt | Der erste Wert. |
| moreFieldsAndValues | Unbekannt[] | Zusätzliche Schlüssel-Wert-Paare. |
Kehrt zurück:
Diese WriteBatch Instanz. Wird zum Verketten von Methodenaufrufen verwendet.
Ausnahmen
Fehler – Wenn die bereitgestellte Eingabe keine gültigen Firestore-Daten ist.