WriteBatch class

Пакет записи, используемый для выполнения нескольких операций записи как одной атомарной единицы.

Объект WriteBatch можно получить, вызвав writeBatch(). . Он предоставляет методы для добавления операций записи в пакет записи. Ни одна запись не будет зафиксирована (и не будет видна локально) до тех пор, пока не будет вызван WriteBatch.commit() .

Подпись:

export declare class WriteBatch 

Методы

Метод	Модификаторы	Описание
совершить()		Фиксирует все операции записи в этом пакете записи как одну атомарную единицу. Результат этих записей будет отражен только при чтении документа, которое происходит после разрешения возвращенного обещания. Если клиент находится в автономном режиме, запись не выполняется. Если вы хотите видеть локальные изменения или записи в буфер, пока клиент не будет подключен к сети, используйте полную версию Firestore SDK.
удалить (ссылка на документ)		Удаляет документ, на который ссылается предоставленная DocumentReference. .
установить (ссылка на документ, данные)		Записывает документ, на который ссылается предоставленная DocumentReference. . Если документ еще не существует, он будет создан.
set(documentRef, данные, параметры)		Записывает документ, на который ссылается предоставленная DocumentReference. . Если документ еще не существует, он будет создан. Если вы предоставляете merge или mergeFields , предоставленные данные можно объединить с существующим документом.
обновление (ссылка на документ, данные)		Обновляет поля в документе, на который ссылается предоставленная DocumentReference. . Обновление завершится неудачно, если оно будет применено к несуществующему документу.
обновление (documentRef, поле, значение, moreFieldsAndValues)		Обновляет поля в документе, на который ссылается этот DocumentReference. . Обновление завершится неудачно, если оно будет применено к несуществующему документу. Вложенные поля можно обновлять, предоставляя строки путей к полям, разделенные точками, или предоставляя объекты FieldPath .

WriteBatch.commit()

Фиксирует все операции записи в этом пакете записи как одну атомарную единицу.

Результат этих записей будет отражен только при чтении документа, которое происходит после разрешения возвращенного обещания. Если клиент находится в автономном режиме, запись не выполняется. Если вы хотите видеть локальные изменения или записи в буфер, пока клиент не будет подключен к сети, используйте полную версию Firestore SDK.

Подпись:

commit(): Promise<void>;

Возврат:

Обещание<void>

Promise разрешается, как только все записи в пакете были успешно записаны на серверную часть как атомарная единица (обратите внимание, что оно не будет разрешено, пока вы находитесь в автономном режиме).

WriteBatch.delete()

Удаляет документ, на который ссылается предоставленная DocumentReference. .

Подпись:

delete<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): WriteBatch;

Параметры

Параметр	Тип	Описание
документСсылка	Ссылка на документ <AppModelType, DbModelType>	Ссылка на документ, который необходимо удалить.

Возврат:

Запись пакета

Этот экземпляр WriteBatch . Используется для объединения вызовов методов.

WriteBatch.set()

Записывает документ, на который ссылается предоставленная DocumentReference. . Если документ еще не существует, он будет создан.

Подпись:

set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): WriteBatch;

Параметры

Параметр	Тип	Описание
документСсылка	Ссылка на документ <AppModelType, DbModelType>	Ссылка на документ, который необходимо установить.
данные	Сфилдвалуе <типмодели приложения>	Объект полей и значений документа.

Возврат:

Запись пакета

Этот экземпляр WriteBatch . Используется для объединения вызовов методов.

WriteBatch.set()

Записывает документ, на который ссылается предоставленная DocumentReference. . Если документ еще не существует, он будет создан. Если вы предоставляете merge или mergeFields предоставленные данные можно объединить с существующим документом.

Подпись:

set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: PartialWithFieldValue<AppModelType>, options: SetOptions): WriteBatch;

Параметры

Параметр	Тип	Описание
документСсылка	Ссылка на документ <AppModelType, DbModelType>	Ссылка на документ, который необходимо установить.
данные	Частичносфилдвалуе <типмодели приложения>	Объект полей и значений документа.
параметры	Установить параметры	Объект для настройки заданного поведения.

Возврат:

Запись пакета

Этот экземпляр WriteBatch . Используется для объединения вызовов методов.

Исключения

Ошибка — если предоставленные данные не являются действительным документом Firestore.

WriteBatch.update()

Обновляет поля в документе, на который ссылается предоставленная DocumentReference. . Обновление завершится неудачно, если оно будет применено к несуществующему документу.

Подпись:

update<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: UpdateData<DbModelType>): WriteBatch;

Параметры

Параметр	Тип	Описание
документСсылка	Ссылка на документ <AppModelType, DbModelType>	Ссылка на документ, который необходимо обновить.
данные	Обновление данных <ТипМоделиДб>	Объект, содержащий поля и значения, с помощью которых необходимо обновить документ. Поля могут содержать точки для ссылки на вложенные поля в документе.

Возврат:

Запись пакета

Этот экземпляр WriteBatch . Используется для объединения вызовов методов.

Исключения

Ошибка. Если предоставленные входные данные недействительны, данные Firestore.

WriteBatch.update()

Обновляет поля в документе, на который ссылается этот DocumentReference. . Обновление завершится неудачно, если оно будет применено к несуществующему документу.

Вложенные поля можно обновлять, предоставляя строки путей к полям, разделенные точками, или предоставляя объекты FieldPath .

Подпись:

update<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): WriteBatch;

Параметры

Параметр	Тип	Описание
документСсылка	Ссылка на документ <AppModelType, DbModelType>	Ссылка на документ, который необходимо обновить.
поле	строка | ФилдПат	Первое поле для обновления.
ценить	неизвестный	Первое значение.
ПодробнееFieldsAndValues	неизвестный[]	Дополнительные пары ключ-значение.

Возврат:

Запись пакета

Этот экземпляр WriteBatch . Используется для объединения вызовов методов.

Исключения

Ошибка. Если предоставленные входные данные недействительны, данные Firestore.