WriteBatch class

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

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

Zwroty:

Napisz wsadowo

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

Zwroty:

Napisz wsadowo

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

Zwroty:

Napisz wsadowo

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

Zwroty:

Napisz wsadowo

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

Zwroty:

Napisz wsadowo

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.