WriteBatch class

Un lote de escritura, que se utiliza para realizar varias escrituras como una sola unidad atómica.

Se puede adquirir un objeto WriteBatch llamando a writeBatch() . Proporciona métodos para agregar escrituras al lote de escritura. Ninguna de las escrituras se confirmará (o será visible localmente) hasta que se llame a WriteBatch.commit() .

Firma:

export declare class WriteBatch

Métodos

Método modificadores Descripción
comprometerse() Confirma todas las escrituras en este lote de escritura como una sola unidad atómica. El resultado de estas escrituras solo se reflejará en las lecturas de documentos que se produzcan después de que se resuelva la promesa devuelta. Si el cliente está fuera de línea, la escritura falla. Si desea ver modificaciones locales o escrituras en el búfer hasta que el cliente esté en línea, use el SDK completo de Firestore.
eliminar (documentRef) Elimina 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 esta DocumentReference . 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 .

WriteBatch.commit()

Confirma todas las escrituras en este lote de escritura como una sola unidad atómica.

El resultado de estas escrituras solo se reflejará en las lecturas de documentos que se produzcan después de que se resuelva la promesa devuelta. Si el cliente está fuera de línea, la escritura falla. Si desea ver modificaciones locales o escrituras en el búfer hasta que el cliente esté en línea, use el SDK completo de Firestore.

Firma:

commit(): Promise<void>;

Devoluciones:

Promesa <vacío>

Una Promise resuelta una vez que todas las escrituras en el lote se hayan escrito correctamente en el backend como una unidad atómica (tenga en cuenta que no se resolverá mientras esté desconectado).

WriteBatch.delete()

Elimina el documento al que hace referencia la DocumentReference proporcionada .

Firma:

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

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:

Escribir por lotes

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

WriteBatch.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>): WriteBatch;

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:

Escribir por lotes

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

WriteBatch.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): WriteBatch;

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:

Escribir por lotes

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

Excepciones

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

WriteBatch.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>): WriteBatch;

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:

Escribir por lotes

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

Excepciones

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

WriteBatch.update()

Actualiza campos en el documento al que hace referencia esta DocumentReference . 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[]): WriteBatch;

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:

Escribir por lotes

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

Excepciones

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