Es una referencia a una transacción.
El objeto Transaction que se pasa al updateFunction de una transacción proporciona los métodos para leer y escribir datos dentro del contexto de la transacción. Consulta runTransaction().
Firma:
export declare class Transaction
Métodos
| Método | Teclas modificadoras | Descripción |
|---|---|---|
| delete(documentRef) | Borra el documento al que hace referencia la DocumentReference proporcionada. | |
| get(documentRef) | Lee el documento al que hace referencia la DocumentReference proporcionada. | |
| set(documentRef, 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 proporcionas merge o mergeFields, los datos proporcionados se pueden combinar en un documento existente. |
|
| update(documentRef, datos) | Actualiza los campos del documento al que hace referencia la DocumentReference proporcionada. La actualización fallará si se aplica a un documento que no existe. | |
| update(documentRef, field, value, moreFieldsAndValues) | Actualiza los campos del 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 con strings de rutas de campos separadas por puntos o con objetos FieldPath. |
Transaction.delete()
Borra 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 |
|---|---|---|
| DocumentRef | DocumentReference<AppModelType, DbModelType> | Una referencia al documento que se borrará. |
Muestra:
esto
Esta instancia de Transaction. Se usa para encadenar llamadas a métodos.
Transaction.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 |
|---|---|---|
| DocumentRef | DocumentReference<AppModelType, DbModelType> | Es una referencia al documento que se leerá. |
Muestra:
Promesa<DocumentSnapshot<AppModelType, DrModelType>>
Un DocumentSnapshot con los datos de lectura
Transaction.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 |
|---|---|---|
| DocumentRef | DocumentReference<AppModelType, DbModelType> | Una referencia al documento que se debe establecer. |
| datos | WithFieldValue<AppModelType> | Un objeto de los campos y valores del documento. |
Muestra:
esto
Esta instancia de Transaction. Se usa para encadenar llamadas a métodos.
Excepciones
Error: Si la entrada proporcionada no es un documento de Firestore válido.
Transaction.set()
Escribe en el documento al que hace referencia la DocumentReference proporcionada. Si el documento aún no existe, se creará. Si proporcionas merge o mergeFields, los datos proporcionados se pueden combinar 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 |
|---|---|---|
| DocumentRef | DocumentReference<AppModelType, DbModelType> | Una referencia al documento que se debe establecer. |
| datos | PartialWithFieldValue<AppModelType> | Un objeto de los campos y valores del documento. |
| opciones | SetOptions | Un objeto para configurar el comportamiento establecido. |
Muestra:
esto
Esta instancia de Transaction. Se usa para encadenar llamadas a métodos.
Excepciones
Error: Si la entrada proporcionada no es un documento de Firestore válido.
Transaction.update()
Actualiza los campos del 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 |
|---|---|---|
| DocumentRef | DocumentReference<AppModelType, DbModelType> | Una referencia al documento que se actualizará. |
| datos | UpdateData<DbModelType> | Un objeto que contiene los campos y valores con los que se actualiza el documento. Los campos pueden contener puntos que hagan referencia a campos anidados dentro del documento. |
Muestra:
esto
Esta instancia de Transaction. Se usa para encadenar llamadas a métodos.
Excepciones
Error: Si la entrada proporcionada no son datos de Firestore válidos.
Transaction.update()
Actualiza los campos del 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 strings de rutas de campos separadas por puntos o con 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 |
|---|---|---|
| DocumentRef | DocumentReference<AppModelType, DbModelType> | Una referencia al documento que se actualizará. |
| campo | cadena | Ruta de campo | El primer campo que se actualizará. |
| valor | desconocido | El primer valor. |
| MásCamposYValores | desconocido | Pares clave-valor adicionales. |
Muestra:
esto
Esta instancia de Transaction. Se usa para encadenar llamadas a métodos.
Excepciones
Error: Si la entrada proporcionada no son datos de Firestore válidos.