WriteBatch class

Um lote de gravação, usado para executar várias gravações como uma única unidade atômica.

Um objeto WriteBatch pode ser adquirido chamando writeBatch() . Ele fornece métodos para adicionar gravações ao lote de gravação. Nenhuma das gravações será confirmada (ou visível localmente) até que WriteBatch.commit() seja chamado.

Assinatura:

export declare class WriteBatch 

Métodos

WriteBatch.commit()

Confirma todas as gravações neste lote de gravação como uma única unidade atômica.

O resultado dessas gravações só será refletido nas leituras de documentos que ocorrerem após a resolução da promessa retornada. Se o cliente estiver offline, a gravação falhará. Se você quiser ver modificações locais ou gravações de buffer até que o cliente esteja on-line, use o Firestore SDK completo.

Assinatura:

commit(): Promise<void>;

Retorna:

Promessa<void>

Uma Promise resolvida quando todas as gravações no lote foram gravadas com êxito no back-end como uma unidade atômica (observe que ela não será resolvida enquanto você estiver offline).

WriteBatch.delete()

Exclui o documento referido pelo DocumentReference fornecido .

Assinatura:

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

Parâmetros

Retorna:

WriteBatch

Esta instância WriteBatch . Usado para encadear chamadas de método.

WriteBatch.set()

Grava no documento referido pelo DocumentReference fornecido . Se o documento ainda não existir, ele será criado.

Assinatura:

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

Parâmetros

Retorna:

WriteBatch

Esta instância WriteBatch . Usado para encadear chamadas de método.

WriteBatch.set()

Grava no documento referido pelo DocumentReference fornecido . Se o documento ainda não existir, ele será criado. Se você fornecer merge ou mergeFields , os dados fornecidos podem ser mesclados em um documento existente.

Assinatura:

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

Parâmetros

Retorna:

WriteBatch

Esta instância WriteBatch . Usado para encadear chamadas de método.

Exceções

Erro - se a entrada fornecida não for um documento válido do Firestore.

WriteBatch.update()

Atualiza campos no documento referenciado pelo DocumentReference fornecido . A atualização falhará se aplicada a um documento que não existe.

Assinatura:

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

Parâmetros

Retorna:

WriteBatch

Esta instância WriteBatch . Usado para encadear chamadas de método.

Exceções

Erro - se a entrada fornecida não for um dado válido do Firestore.

WriteBatch.update()

Atualiza campos no documento referido por este DocumentReference . A atualização falhará se aplicada a um documento que não existe.

Os campos aninhados podem ser atualizados fornecendo strings de caminho de campo separadas por pontos ou fornecendo objetos FieldPath .

Assinatura:

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

Parâmetros

Retorna:

WriteBatch

Esta instância WriteBatch . Usado para encadear chamadas de método.

Exceções

Erro - se a entrada fornecida não for um dado válido do Firestore.