Uma referência a uma transação.
O objeto Transaction transmitido para o updateFunction de uma transação fornece os métodos para ler e gravar dados no contexto da transação. Consulte runTransaction().
Assinatura:
export declare class Transaction
Métodos
| Método | Modificadores | Descrição |
|---|---|---|
| delete(documentRef) (link em inglês) | Exclui o documento referido pelo DocumentReference fornecido. | |
| get(documentRef) (em inglês) | Lê o documento referenciado pela DocumentReference fornecida. | |
| 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 pela DocumentReference fornecida. 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. |
Transaction.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 |
|---|---|---|
| documentRef. | DocumentReference<AppModelType, DBMModelType> | Uma referência ao documento a ser excluído. |
Retorna:
este
Esta instância Transaction. Usado para encadear chamadas de método.
Transaction.get() (em inglês)
Lê o documento referenciado pela DocumentReference fornecida.
Assinatura:
get<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| documentRef. | DocumentReference<AppModelType, DBMModelType> | Uma referência ao documento a ser lido. |
Retorna:
Promessa<DocumentSnapshot<AppModelType, DBMModelType>>
Uma DocumentSnapshot com os dados de leitura.
Transaction.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>): this;
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:
este
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.
Transaction.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): this;
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:
este
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.
Transaction.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>): this;
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:
este
Esta instância Transaction. Usado para encadear chamadas de método.
Exceções
Erro: se a entrada fornecida não for um dado válido do Firestore.
Transaction.update().
Atualiza campos no documento referido pela DocumentReference fornecida. 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[]): this;
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[] | Pares de chave-valor adicionais. |
Retorna:
este
Esta instância Transaction. Usado para encadear chamadas de método.
Exceções
Erro: se a entrada fornecida não for um dado válido do Firestore.