Partia zapisu używana do wykonywania wielu zapisów jako pojedynczej jednostki atomowej.
Obiekt WriteBatch
można uzyskać, wywołując funkcję writeBatch() . Zapewnia metody dodawania zapisów do partii zapisu. Żaden z zapisów nie zostanie zatwierdzony (ani widoczny lokalnie) do czasu wywołania funkcji WriteBatch.commit() .
Podpis:
export declare class WriteBatch
Metody
metoda | Modyfikatory | Opis |
---|---|---|
popełniać() | Zatwierdza wszystkie zapisy w tej partii zapisu jako pojedynczą jednostkę atomową. Wynik tych zapisów zostanie odzwierciedlony tylko w odczytach dokumentów, które nastąpią po rozpatrzeniu zwróconej obietnicy. Jeśli klient jest w trybie offline, zapis nie powiedzie się. Jeśli chcesz zobaczyć lokalne modyfikacje lub zapisy w buforze, dopóki klient nie będzie online, użyj pełnego pakietu SDK Firestore. | |
usuń(odniesienie dokumentu) | Usuwa 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 odnosi się niniejszy 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 . |
WriteBatch.commit()
Zatwierdza wszystkie zapisy w tej partii zapisu jako pojedynczą jednostkę atomową.
Wynik tych zapisów zostanie odzwierciedlony tylko w odczytach dokumentów, które nastąpią po rozpatrzeniu zwróconej obietnicy. Jeśli klient jest w trybie offline, zapis nie powiedzie się. Jeśli chcesz zobaczyć lokalne modyfikacje lub zapisy w buforze, dopóki klient nie będzie online, użyj pełnego pakietu SDK Firestore.
Podpis:
commit(): Promise<void>;
Zwroty:
Obietnica<pusta>
Promise
rozwiązana, gdy wszystkie zapisy w partii zostaną pomyślnie zapisane w backendie jako jednostka atomowa (pamiętaj, że nie zostanie to rozwiązane, gdy będziesz offline).
WriteBatch.delete()
Usuwa dokument, do którego odwołuje się podany dokument DocumentReference .
Podpis:
delete<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): WriteBatch;
Parametry
Parametr | Typ | Opis |
---|---|---|
dokumentRef | Odnośnik do dokumentu <AppModelType, DbModelType> | Odniesienie do dokumentu, który ma zostać usunięty. |
Zwroty:
Ta instancja WriteBatch
. Używany do łączenia wywołań metod.
WriteBatch.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>): WriteBatch;
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:
Ta instancja WriteBatch
. Używany do łączenia wywołań metod.
WriteBatch.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): WriteBatch;
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:
Ta instancja WriteBatch
. Używany do łączenia wywołań metod.
Wyjątki
Błąd — jeśli podane dane wejściowe nie są prawidłowym dokumentem Firestore.
WriteBatch.update()
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>): WriteBatch;
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:
Ta instancja WriteBatch
. Używany do łączenia wywołań metod.
Wyjątki
Błąd — jeśli podane dane wejściowe nie są prawidłowymi danymi Firestore.
WriteBatch.update()
Aktualizuje pola w dokumencie, do którego odnosi się niniejszy 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[]): WriteBatch;
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:
Ta instancja WriteBatch
. Używany do łączenia wywołań metod.
Wyjątki
Błąd — jeśli podane dane wejściowe nie są prawidłowymi danymi Firestore.