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 (nem visível localmente) até que WriteBatch.commit() seja chamado.

Assinatura:

export declare class WriteBatch

Métodos

Método Modificadores Descrição
commit() (link em inglês) Confirma todas as gravações neste lote de gravação como uma única unidade atômica.O resultado dessas gravações só será refletido em leituras de documentos que ocorrerem depois que a promessa retornada for resolvida. Se o cliente estiver off-line, a gravação falhará. Se você quiser ver modificações locais ou gravações em buffer até que o cliente esteja on-line, use o SDK completo do Firestore.
delete(documentRef) (link em inglês) Exclui o documento referido pelo DocumentReference fornecido.
set(documentRef, data) Grava no documento referido pelo DocumentReference fornecido. Se o documento ainda não existir, ele será criado.
set(documentRef, data, options) 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 poderão ser mesclados em um documento existente.
update(documentRef, data) Atualiza campos no documento referido pela DocumentReference fornecida. A atualização falhará se aplicada a um documento que não existe.
update(documentRef, field, value, moreFieldsAndValues) Atualiza campos no documento referido por esta 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 ponto ou fornecendo objetos FieldPath.

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 em leituras de documentos que ocorrerem após a resolução da promessa retornada. Se o cliente estiver off-line, a gravação falhará. Se você quiser ver modificações locais ou gravações em buffer até que o cliente esteja on-line, use o SDK completo do Firestore.

Assinatura:

commit(): Promise<void>;

Retorna:

Promessa<void>

Uma Promise resolvida quando todas as gravações do lote forem gravadas no back-end como uma unidade atômica. Observe que isso não é resolvido enquanto você está off-line.

WriteBatch.delete()

Exclui o documento referido pelo DocumentReference fornecido.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
documentRef. DocumentReference<AppModelType, DBMModelType> Uma referência ao documento a ser excluído.

Retorna:

WriteBatch (em inglês)

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

Parâmetro Tipo Descrição
documentRef. DocumentReference<AppModelType, DBMModelType> Uma referência ao documento a ser definido.
dados WithFieldValue<AppModelType> Um objeto dos campos e valores do documento.

Retorna:

WriteBatch (em inglês)

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 poderão ser mesclados em um documento existente.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
documentRef. DocumentReference<AppModelType, DBMModelType> Uma referência ao documento a ser definido.
dados PartialWithFieldValue<AppModelType> Um objeto dos campos e valores do documento.
options SetOptions (em inglês) Um objeto para configurar o comportamento definido.

Retorna:

WriteBatch (em inglês)

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 referido pela DocumentReference fornecida. 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

Parâmetro Tipo Descrição
documentRef. DocumentReference<AppModelType, DBMModelType> Uma referência ao documento a ser atualizado.
dados UpdateData<DbModelType> Um objeto que contém os campos e valores com os quais atualizar o documento. Os campos podem conter pontos para fazer referência a campos aninhados no documento.

Retorna:

WriteBatch (em inglês)

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 esta 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 com objetos FieldPath.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
documentRef. DocumentReference<AppModelType, DBMModelType> Uma referência ao documento a ser atualizado.
campo string | FieldPath (link em inglês) O primeiro campo a ser atualizado.
valor desconhecido O primeiro valor.
maisCamposAndValores desconhecido[] Outros pares de chave-valor.

Retorna:

WriteBatch (em inglês)

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.