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 (refdocumento) | Elimina el documento al que hace referencia la DocumentReference proporcionada. . | |
| obtener(refdocumento) | Lee el documento al que hace referencia el DocumentReference proporcionado . | |
| establecer (refdocumento, 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(documentRef, datos) | Actualiza los 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 (documentRef, campo, valor, más campos y valores) | Actualiza los 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 <AppModelType, DbModelType> | 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 el DocumentReference proporcionado .
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 <AppModelType, DbModelType> | Una referencia al documento a leer. |
Devoluciones:
Promesa< Instantánea del documento <AppModelType, DbModelType>>
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 <AppModelType, DbModelType> | Una referencia al documento que se va a establecer. |
| datos | Con valor de campo <Tipo de modelo de aplicación> | Un objeto de los campos y valores del 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 <AppModelType, DbModelType> | Una referencia al documento que se va a establecer. |
| datos | ParcialConValorDeCampo <Tipo de modelo de aplicación> | Un objeto de los campos y valores del documento. |
| opciones | Establecer opciones | Un objeto para configurar el comportamiento establecido. |
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.actualización()
Actualiza los 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 <AppModelType, DbModelType> | Una referencia al documento a actualizar. |
| datos | Actualizar datos <TipoDeModeloDb> | 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.actualización()
Actualiza los 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 <AppModelType, DbModelType> | Una referencia al documento a actualizar. |
| campo | cadena | Ruta de campo | El primer campo a actualizar. |
| valor | desconocido | El primer valor. |
| másCamposYValores | 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.