Transaction class

Ссылка на транзакцию.

Объект Transaction , передаваемый в updateFunction транзакции, предоставляет методы для чтения и записи данных в контексте транзакции. См. runTransaction(). .

Подпись:

export declare class Transaction 

Методы

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

Транзакция.удалить()

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

Подпись:

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

Параметры

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

Возврат:

этот

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

Транзакция.get()

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

Подпись:

get<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

Параметры

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

Возврат:

Обещание< DocumentSnapshot <AppModelType, DbModelType>>

DocumentSnapshot с прочитанными данными.

Транзакция.set()

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

Подпись:

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

Параметры

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

Возврат:

этот

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

Исключения

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

Транзакция.set()

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

Подпись:

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

Параметры

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

Возврат:

этот

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

Исключения

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

Транзакция.обновление()

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

Подпись:

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

Параметры

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

Возврат:

этот

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

Исключения

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

Транзакция.обновление()

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

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

Подпись:

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

Параметры

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

Возврат:

этот

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

Исключения

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