Odniesienie do transakcji.
Obiekt Transaction przekazany do updateFunction transakcji udostępnia metody odczytu i zapisu danych w kontekście transakcji. Zobacz runTransaction() .
Podpis:
export declare class Transaction
Metody
| metoda | Modyfikatory | Opis |
|---|---|---|
| usuń(odniesienie dokumentu) | Usuwa dokument, do którego odwołuje się podany dokument DocumentReference . | |
| pobierz (odniesienie dokumentu) | Odczytuje dokument, do którego odwołuje się podany dokument DocumentReference . | |
| set(documentRef, dane) | Zapisuje w dokumencie, do którego odwołuje się podany dokument DocumentReference . Jeśli dokument jeszcze nie istnieje, zostanie utworzony. | |
| set(documentRef, dane, opcje) | Zapisuje w dokumencie, do którego odwołuje się podany dokument DocumentReference . Jeśli dokument jeszcze nie istnieje, zostanie utworzony. Jeśli podasz merge lub mergeFields , podane dane mogą zostać scalone z istniejącym dokumentem. | |
| aktualizacja(documentRef, dane) | Aktualizuje pola w dokumencie, do którego odwołuje się podany dokument DocumentReference . Aktualizacja nie powiedzie się, jeśli zostanie zastosowana do dokumentu, który nie istnieje. | |
| update(documentRef, pole, wartość, moreFieldsAndValues) | Aktualizuje pola w dokumencie, do którego odwołuje się podany dokument DocumentReference . Aktualizacja nie powiedzie się, jeśli zostanie zastosowana do dokumentu, który nie istnieje. Pola zagnieżdżone można aktualizować, podając rozdzielone kropkami ciągi ścieżek pól lub udostępniając obiekty FieldPath . |
Transakcja.usuń()
Usuwa dokument, do którego odwołuje się podany dokument DocumentReference .
Podpis:
delete<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): this;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| dokumentRef | Odnośnik do dokumentu <AppModelType, DbModelType> | Odniesienie do dokumentu, który ma zostać usunięty. |
Zwroty:
Ten
Ta instancja Transaction . Używany do łączenia wywołań metod.
Transakcja.get()
Odczytuje dokument, do którego odwołuje się podany dokument DocumentReference .
Podpis:
get<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| dokumentRef | Odnośnik do dokumentu <AppModelType, DbModelType> | Odniesienie do dokumentu, który należy przeczytać. |
Zwroty:
Obietnica< DocumentSnapshot <AppModelType, DbModelType>>
DocumentSnapshot z odczytanymi danymi.
Transakcja.set()
Zapisuje w dokumencie, do którego odwołuje się podany dokument DocumentReference . Jeśli dokument jeszcze nie istnieje, zostanie utworzony.
Podpis:
set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): this;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| dokumentRef | Odnośnik do dokumentu <AppModelType, DbModelType> | Odniesienie do dokumentu, który ma zostać ustawiony. |
| dane | Z wartością pola <TypModeluAplikacji> | Obiekt pól i wartości dokumentu. |
Zwroty:
Ten
Ta instancja Transaction . Używany do łączenia wywołań metod.
Wyjątki
Błąd — jeśli podane dane wejściowe nie są prawidłowym dokumentem Firestore.
Transakcja.set()
Zapisuje w dokumencie, do którego odwołuje się podany dokument DocumentReference . Jeśli dokument jeszcze nie istnieje, zostanie utworzony. Jeśli podasz merge lub mergeFields , podane dane można połączyć z istniejącym dokumentem.
Podpis:
set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: PartialWithFieldValue<AppModelType>, options: SetOptions): this;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| dokumentRef | Odnośnik do dokumentu <AppModelType, DbModelType> | Odniesienie do dokumentu, który ma zostać ustawiony. |
| dane | Częściowe z wartością pola <TypModeluAplikacji> | Obiekt pól i wartości dokumentu. |
| opcje | UstawOpcje | Obiekt służący do konfigurowania ustawionego zachowania. |
Zwroty:
Ten
Ta instancja Transaction . Używany do łączenia wywołań metod.
Wyjątki
Błąd — jeśli podane dane wejściowe nie są prawidłowym dokumentem Firestore.
Aktualizacja.transakcji()
Aktualizuje pola w dokumencie, do którego odwołuje się podany dokument DocumentReference . Aktualizacja nie powiedzie się, jeśli zostanie zastosowana do dokumentu, który nie istnieje.
Podpis:
update<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: UpdateData<DbModelType>): this;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| dokumentRef | Odnośnik do dokumentu <AppModelType, DbModelType> | Odniesienie do dokumentu, który ma zostać zaktualizowany. |
| dane | Aktualizować dane <TypDbModelu> | Obiekt zawierający pola i wartości, za pomocą których można zaktualizować dokument. Pola mogą zawierać kropki wskazujące odniesienia do pól zagnieżdżonych w dokumencie. |
Zwroty:
Ten
Ta instancja Transaction . Używany do łączenia wywołań metod.
Wyjątki
Błąd — jeśli podane dane wejściowe nie są prawidłowymi danymi Firestore.
Aktualizacja.transakcji()
Aktualizuje pola w dokumencie, do którego odwołuje się podany dokument DocumentReference . Aktualizacja nie powiedzie się, jeśli zostanie zastosowana do dokumentu, który nie istnieje.
Pola zagnieżdżone można aktualizować, podając rozdzielone kropkami ciągi ścieżek pól lub udostępniając obiekty FieldPath .
Podpis:
update<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): this;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| dokumentRef | Odnośnik do dokumentu <AppModelType, DbModelType> | Odniesienie do dokumentu, który ma zostać zaktualizowany. |
| pole | ciąg | Ścieżka pola | Pierwsze pole do aktualizacji. |
| wartość | nieznany | Pierwsza wartość. |
| więcejFieldsAndValues | nieznany[] | Dodatkowe pary klucz/wartość. |
Zwroty:
Ten
Ta instancja Transaction . Używany do łączenia wywołań metod.
Wyjątki
Błąd — jeśli podane dane wejściowe nie są prawidłowymi danymi Firestore.