Transaction class

Une référence à une transaction.

L'objet Transaction transmis à updateFunction d'une transaction fournit les méthodes permettant de lire et d'écrire des données dans le contexte de la transaction. Voir runTransaction() .

Signature:

export declare class Transaction

Méthodes

Méthode Modificateurs Description
supprimer (réf.document) Supprime le document référencé par le DocumentReference fourni .
obtenir (réf.document) Lit le document référencé par le DocumentReference fourni .
ensemble (documentRef, données) Écrit dans le document auquel fait référence le DocumentReference fourni. . Si le document n'existe pas encore, il sera créé.
set (documentRef, données, options) Écrit dans le document auquel fait référence le DocumentReference fourni. . Si le document n'existe pas encore, il sera créé. Si vous fournissez merge ou mergeFields , les données fournies peuvent être fusionnées dans un document existant.
mise à jour (documentRef, données) Met à jour les champs du document référencé par la DocumentReference fournie. . La mise à jour échouera si elle est appliquée à un document qui n'existe pas.
mise à jour (documentRef, champ, valeur, moreFieldsAndValues) Met à jour les champs du document référencé par la DocumentReference fournie. . La mise à jour échouera si elle est appliquée à un document qui n'existe pas. Les champs imbriqués peuvent être mis à jour en fournissant des chaînes de chemin de champ séparées par des points ou en fournissant des objets FieldPath .

Transaction.delete()

Supprime le document référencé par le DocumentReference fourni .

Signature:

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

Paramètres

Paramètre Taper Description
documentRéf Référence de document <AppModelType, DbModelType> Une référence au document à supprimer.

Retour:

ce

Cette instance Transaction . Utilisé pour enchaîner les appels de méthode.

Transaction.get()

Lit le document référencé par le DocumentReference fourni .

Signature:

get<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

Paramètres

Paramètre Taper Description
documentRéf Référence de document <AppModelType, DbModelType> Une référence au document à lire.

Retour:

Promesse < DocumentSnapshot <AppModelType, DbModelType>>

Un DocumentSnapshot avec les données lues.

Transaction.set()

Écrit dans le document auquel fait référence le DocumentReference fourni. . Si le document n'existe pas encore, il sera créé.

Signature:

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

Paramètres

Paramètre Taper Description
documentRéf Référence de document <AppModelType, DbModelType> Une référence au document à définir.
données AvecFieldValue <AppModelType> Un objet des champs et des valeurs du document.

Retour:

ce

Cette instance Transaction . Utilisé pour enchaîner les appels de méthode.

Des exceptions

Erreur - Si l'entrée fournie n'est pas un document Firestore valide.

Transaction.set()

Écrit dans le document auquel fait référence le DocumentReference fourni. . Si le document n'existe pas encore, il sera créé. Si vous fournissez merge ou mergeFields , les données fournies peuvent être fusionnées dans un document existant.

Signature:

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

Paramètres

Paramètre Taper Description
documentRéf Référence de document <AppModelType, DbModelType> Une référence au document à définir.
données PartialWithFieldValue <AppModelType> Un objet des champs et des valeurs du document.
choix Définir les options Un objet pour configurer le comportement défini.

Retour:

ce

Cette instance Transaction . Utilisé pour enchaîner les appels de méthode.

Des exceptions

Erreur - Si l'entrée fournie n'est pas un document Firestore valide.

Transaction.update()

Met à jour les champs du document référencé par la DocumentReference fournie. . La mise à jour échouera si elle est appliquée à un document qui n'existe pas.

Signature:

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

Paramètres

Paramètre Taper Description
documentRéf Référence de document <AppModelType, DbModelType> Une référence au document à mettre à jour.
données Mettre à jour les données <Type de modèle de base de données> Un objet contenant les champs et les valeurs avec lesquels mettre à jour le document. Les champs peuvent contenir des points pour référencer des champs imbriqués dans le document.

Retour:

ce

Cette instance Transaction . Utilisé pour enchaîner les appels de méthode.

Des exceptions

Erreur - Si l'entrée fournie ne correspond pas à des données Firestore valides.

Transaction.update()

Met à jour les champs du document référencé par la DocumentReference fournie. . La mise à jour échouera si elle est appliquée à un document qui n'existe pas.

Les champs imbriqués peuvent être mis à jour en fournissant des chaînes de chemin de champ séparées par des points ou en fournissant des objets FieldPath .

Signature:

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

Paramètres

Paramètre Taper Description
documentRéf Référence de document <AppModelType, DbModelType> Une référence au document à mettre à jour.
champ chaîne | Chemin de champ Le premier champ à mettre à jour.
valeur inconnu La première valeur.
plusChampsEtValeurs inconnu[] Paires clé/valeur supplémentaires.

Retour:

ce

Cette instance Transaction . Utilisé pour enchaîner les appels de méthode.

Des exceptions

Erreur - Si l'entrée fournie ne correspond pas à des données Firestore valides.