Ein Verweis auf eine Transaktion.
Das an die updateFunction einer Transaktion übergebene Transaction Objekt stellt die Methoden zum Lesen und Schreiben von Daten im Transaktionskontext bereit. Siehe runTransaction() .
Unterschrift:
export declare class Transaction
Methoden
| Methode | Modifikatoren | Beschreibung |
|---|---|---|
| delete(documentRef) | Löscht das Dokument, auf das durch die bereitgestellte DocumentReference verwiesen wird . | |
| get(documentRef) | Liest 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 durch die bereitgestellte DocumentReference verwiesen wird . Die Aktualisierung schlägt fehl, wenn sie auf ein nicht vorhandenes Dokument angewendet wird. Verschachtelte Felder können durch die Bereitstellung von durch Punkte getrennten Feldpfadzeichenfolgen oder durch die Bereitstellung FieldPath Objekten aktualisiert werden. |
Transaktion.delete()
Löscht das Dokument, auf das durch die bereitgestellte DocumentReference verwiesen wird .
Unterschrift:
delete<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): this;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| documentRef | Dokumentverweis <AppModelType, DbModelType> | Ein Verweis auf das zu löschende Dokument. |
Kehrt zurück:
Das
Diese Transaction . Wird zum Verketten von Methodenaufrufen verwendet.
Transaktion.get()
Liest das Dokument, auf das durch die bereitgestellte DocumentReference verwiesen wird .
Unterschrift:
get<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| documentRef | Dokumentverweis <AppModelType, DbModelType> | Ein Verweis auf das zu lesende Dokument. |
Kehrt zurück:
Versprechen< DocumentSnapshot <AppModelType, DbModelType>>
Ein DocumentSnapshot mit den gelesenen Daten.
Transaktion.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>): this;
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:
Das
Diese Transaction . Wird zum Verketten von Methodenaufrufen verwendet.
Ausnahmen
Fehler – Wenn die bereitgestellte Eingabe kein gültiges Firestore-Dokument ist.
Transaktion.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): this;
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:
Das
Diese Transaction . Wird zum Verketten von Methodenaufrufen verwendet.
Ausnahmen
Fehler – Wenn die bereitgestellte Eingabe kein gültiges Firestore-Dokument ist.
Transaktion.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>): this;
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:
Das
Diese Transaction . Wird zum Verketten von Methodenaufrufen verwendet.
Ausnahmen
Fehler – Wenn die bereitgestellte Eingabe keine gültigen Firestore-Daten ist.
Transaktion.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.
Verschachtelte Felder können durch die Bereitstellung von durch Punkte getrennten Feldpfadzeichenfolgen oder durch die Bereitstellung FieldPath Objekten aktualisiert werden.
Unterschrift:
update<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): this;
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:
Das
Diese Transaction . Wird zum Verketten von Methodenaufrufen verwendet.
Ausnahmen
Fehler – Wenn die bereitgestellte Eingabe keine gültigen Firestore-Daten ist.