Transaction class

Una referencia a una transacción.

El objeto Transaction pasado a updateFunction de una transacción proporciona los métodos para leer y escribir datos dentro del contexto de la transacción. Ver ejecutarTransacción() .

Firma:

export declare class Transaction 

Métodos

Método	modificadores	Descripción
eliminar (documentRef)		Elimina el documento al que hace referencia la DocumentReference proporcionada .
obtener (referencia del documento)		Lee el documento al que hace referencia la DocumentReference proporcionada .
conjunto (referencia del documento, datos)		Escribe en el documento al que hace referencia la DocumentReference proporcionada . Si el documento aún no existe, se creará.
set(documentRef, datos, opciones)		Escribe en el documento al que hace referencia la DocumentReference proporcionada . Si el documento aún no existe, se creará. Si proporciona merge o mergeFields , los datos proporcionados se pueden combinar en un documento existente.
actualizar (referencia del documento, datos)		Actualiza campos en el documento al que hace referencia la DocumentReference proporcionada . La actualización fallará si se aplica a un documento que no existe.
actualizar (referencia del documento, campo, valor, más campos y valores)		Actualiza campos en el documento al que hace referencia la DocumentReference proporcionada . La actualización fallará si se aplica a un documento que no existe. Los campos anidados se pueden actualizar proporcionando cadenas de ruta de campo separadas por puntos o proporcionando objetos FieldPath .

Transacción.eliminar()

Elimina el documento al que hace referencia la DocumentReference proporcionada .

Firma:

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

Parámetros

Parámetro	Tipo	Descripción
documentoRef	Referencia de documento <Tipo de modelo de aplicación, Tipo de modelo de base de datos>	Una referencia al documento que se va a eliminar.

Devoluciones:

este

Esta instancia Transaction . Se utiliza para encadenar llamadas a métodos.

Transacción.get()

Lee el documento al que hace referencia la DocumentReference proporcionada .

Firma:

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

Parámetros

Parámetro	Tipo	Descripción
documentoRef	Referencia de documento <Tipo de modelo de aplicación, Tipo de modelo de base de datos>	Una referencia al documento que se va a leer.

Devoluciones:

Promise< DocumentSnapshot <Tipo de modelo de aplicación, Tipo de modelo de base de datos>>

Un DocumentSnapshot con los datos leídos.

Transacción.set()

Escribe en el documento al que hace referencia la DocumentReference proporcionada . Si el documento aún no existe, se creará.

Firma:

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

Parámetros

Parámetro	Tipo	Descripción
documentoRef	Referencia de documento <Tipo de modelo de aplicación, Tipo de modelo de base de datos>	Una referencia al documento que se establecerá.
datos	ConValorDeCampo <Tipo de modelo de aplicación>	Un objeto de los campos y valores para el documento.

Devoluciones:

este

Esta instancia Transaction . Se utiliza para encadenar llamadas a métodos.

Excepciones

Error: si la entrada proporcionada no es un documento válido de Firestore.

Transacción.set()

Escribe en el documento al que hace referencia la DocumentReference proporcionada . Si el documento aún no existe, se creará. Si proporciona merge o mergeFields , los datos proporcionados se pueden fusionar en un documento existente.

Firma:

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

Parámetros

Parámetro	Tipo	Descripción
documentoRef	Referencia de documento <Tipo de modelo de aplicación, Tipo de modelo de base de datos>	Una referencia al documento que se establecerá.
datos	ParcialConValorDeCampo <Tipo de modelo de aplicación>	Un objeto de los campos y valores para el documento.
opciones	EstablecerOpciones	Un objeto para configurar el comportamiento del conjunto.

Devoluciones:

este

Esta instancia Transaction . Se utiliza para encadenar llamadas a métodos.

Excepciones

Error: si la entrada proporcionada no es un documento válido de Firestore.

Transacción.update()

Actualiza campos en el documento al que hace referencia la DocumentReference proporcionada . La actualización fallará si se aplica a un documento que no existe.

Firma:

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

Parámetros

Parámetro	Tipo	Descripción
documentoRef	Referencia de documento <Tipo de modelo de aplicación, Tipo de modelo de base de datos>	Una referencia al documento que se va a actualizar.
datos	Actualizar datos <TipoModeloBD>	Un objeto que contiene los campos y valores con los que actualizar el documento. Los campos pueden contener puntos para hacer referencia a campos anidados dentro del documento.

Devoluciones:

este

Esta instancia Transaction . Se utiliza para encadenar llamadas a métodos.

Excepciones

Error: si la entrada proporcionada no son datos válidos de Firestore.

Transacción.update()

Actualiza campos en el documento al que hace referencia la DocumentReference proporcionada . La actualización fallará si se aplica a un documento que no existe.

Los campos anidados se pueden actualizar proporcionando cadenas de ruta de campo separadas por puntos o proporcionando objetos FieldPath .

Firma:

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

Parámetros

Parámetro	Tipo	Descripción
documentoRef	Referencia de documento <Tipo de modelo de aplicación, Tipo de modelo de base de datos>	Una referencia al documento que se va a actualizar.
campo	cadena | ruta de campo	El primer campo a actualizar.
valor	desconocido	El primer valor.
más campos y valores	desconocido[]	Pares clave/valor adicionales.

Devoluciones:

este

Esta instancia Transaction . Se utiliza para encadenar llamadas a métodos.

Excepciones

Error: si la entrada proporcionada no son datos válidos de Firestore.