Um lote de gravação, usado para realizar 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
| Método | Modificadores | Descrição |
|---|---|---|
| comprometer-se() | 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 promessa retornada ser resolvida. 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 SDK completo do Firestore. | |
| excluir(documentRef) | Exclui o documento referido pelo DocumentReference fornecido . | |
| definir(documentRef, dados) | Grava no documento referido pelo DocumentReference fornecido . Caso o documento ainda não exista, ele será criado. | |
| set(documentRef, dados, opções) | Grava no documento referido pelo DocumentReference fornecido . Caso o documento ainda não exista, ele será criado. Se você fornecer merge ou mergeFields , os dados fornecidos poderão ser mesclados em um documento existente. | |
| atualizar(documentRef, dados) | Atualiza campos no documento referido pelo DocumentReference fornecido . A atualização falhará se for aplicada a um documento que não existe. | |
| update(documentRef,campo,valor,maisFieldsAndValues) | Atualiza campos no documento referido por este DocumentReference . A atualização falhará se for aplicada a um documento que não existe. Os campos aninhados podem ser atualizados fornecendo strings de caminho de campo separados por pontos 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 nas leituras de documentos que ocorrerem após a promessa retornada ser resolvida. 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 SDK completo do Firestore.
Assinatura:
commit(): Promise<void>;
Retorna:
Promessa<void>
Uma Promise foi resolvida depois que todas as gravações do lote foram gravadas com êxito no back-end como uma unidade atômica (observe que 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
| Parâmetro | Tipo | Descrição |
|---|---|---|
| documentoRef | Referência de Documento <AppModelType, DbModelType> | Uma referência ao documento a ser excluído. |
Retorna:
Esta instância WriteBatch . Usado para encadear chamadas de método.
WriteBatch.set()
Grava no documento referido pelo DocumentReference fornecido . Caso o documento ainda não exista, ele será criado.
Assinatura:
set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): WriteBatch;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| documentoRef | Referência de Documento <AppModelType, DbModelType> | Uma referência ao documento a ser definido. |
| dados | ComFieldValue <AppModelType> | Um objeto dos campos e valores do documento. |
Retorna:
Esta instância WriteBatch . Usado para encadear chamadas de método.
WriteBatch.set()
Grava no documento referido pelo DocumentReference fornecido . Caso o documento ainda não exista, 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
| Parâmetro | Tipo | Descrição |
|---|---|---|
| documentoRef | Referência de Documento <AppModelType, DbModelType> | Uma referência ao documento a ser definido. |
| dados | PartialWithFieldValue <AppModelType> | Um objeto dos campos e valores do documento. |
| opções | Definir opções | Um objeto para configurar o comportamento definido. |
Retorna:
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 pelo DocumentReference fornecido . A atualização falhará se for 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 |
|---|---|---|
| documentoRef | Referência de Documento <AppModelType, DbModelType> | Uma referência ao documento a ser atualizado. |
| dados | Atualizar dados <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:
Esta instância WriteBatch . Usado para encadear chamadas de método.
Exceções
Erro - se a entrada fornecida não for de dados válidos do Firestore.
WriteBatch.update()
Atualiza campos no documento referido por este DocumentReference . A atualização falhará se for aplicada a um documento que não existe.
Os campos aninhados podem ser atualizados fornecendo strings de caminho de campo separados 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
| Parâmetro | Tipo | Descrição |
|---|---|---|
| documentoRef | Referência de Documento <AppModelType, DbModelType> | Uma referência ao documento a ser atualizado. |
| campo | corda | CampoCaminho | O primeiro campo a ser atualizado. |
| valor | desconhecido | O primeiro valor. |
| maisFieldsAndValues | desconhecido[] | Pares de valores-chave adicionais. |
Retorna:
Esta instância WriteBatch . Usado para encadear chamadas de método.
Exceções
Erro - se a entrada fornecida não for de dados válidos do Firestore.