Uma referência a uma transação.
O objeto Transaction passado para updateFunction de uma transação fornece os métodos para ler e gravar dados dentro do contexto da transação. Veja runTransaction() .
Assinatura:
export declare class Transaction
Métodos
| Método | Modificadores | Descrição |
|---|---|---|
| excluir(documentRef) | Exclui o documento referido pelo DocumentReference fornecido . | |
| obter(documentRef) | Lê o documento referenciado 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 pelo DocumentReference fornecido . A atualização falhará se for aplicada a um documento que não existe. Os campos aninhados podem ser atualizados fornecendo cadeias de caracteres de caminho de campo separadas por pontos ou fornecendo objetos FieldPath . |
Transação.delete()
Exclui o documento referido pelo DocumentReference fornecido .
Assinatura:
delete<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): this;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| documentoRef | Referência de Documento <AppModelType, DbModelType> | Uma referência ao documento a ser excluído. |
Retorna:
esse
Esta instância Transaction . Usado para encadear chamadas de método.
Transação.get()
Lê o documento referenciado pelo DocumentReference fornecido .
Assinatura:
get<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| documentoRef | Referência de Documento <AppModelType, DbModelType> | Uma referência ao documento a ser lido. |
Retorna:
Promessa< DocumentSnapshot <AppModelType, DbModelType>>
Um DocumentSnapshot com os dados lidos.
Transação.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>): this;
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:
esse
Esta instância Transaction . Usado para encadear chamadas de método.
Exceções
Erro – se a entrada fornecida não for um documento válido do Firestore.
Transação.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): this;
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:
esse
Esta instância Transaction . Usado para encadear chamadas de método.
Exceções
Erro – se a entrada fornecida não for um documento válido do Firestore.
Transação.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>): this;
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:
esse
Esta instância Transaction . Usado para encadear chamadas de método.
Exceções
Erro - se a entrada fornecida não for de dados válidos do Firestore.
Transação.update()
Atualiza campos no documento referido pelo DocumentReference fornecido . A atualização falhará se for aplicada a um documento que não existe.
Os campos aninhados podem ser atualizados fornecendo cadeias de caracteres 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[]): this;
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 adicionais de chave/valor. |
Retorna:
esse
Esta instância Transaction . Usado para encadear chamadas de método.
Exceções
Erro - se a entrada fornecida não for de dados válidos do Firestore.