Un lot d'écriture, utilisé pour effectuer plusieurs écritures en tant qu'unité atomique unique.
Un objet WriteBatch peut être acquis en appelant writeBatch() . Il fournit des méthodes pour ajouter des écritures au lot d'écriture. Aucune des écritures ne sera validée (ou visible localement) jusqu'à ce que WriteBatch.commit() soit appelé.
Signature:
export declare class WriteBatch
Méthodes
| Méthode | Modificateurs | Description |
|---|---|---|
| commettre() | Valide toutes les écritures de ce lot d’écriture en tant qu’unité atomique unique. Le résultat de ces écritures ne sera reflété que dans les lectures de documents effectuées après la résolution de la promesse renvoyée. Si le client est hors ligne, l'écriture échoue. Si vous souhaitez voir les modifications locales ou les écritures dans le tampon jusqu'à ce que le client soit en ligne, utilisez le SDK Firestore complet. | |
| supprimer (réf.document) | Supprime 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 cette DocumentReference . 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 . |
WriteBatch.commit()
Valide toutes les écritures de ce lot d’écriture en tant qu’unité atomique unique.
Le résultat de ces écritures ne sera reflété que dans les lectures de documents effectuées après la résolution de la promesse renvoyée. Si le client est hors ligne, l'écriture échoue. Si vous souhaitez voir les modifications locales ou les écritures dans le tampon jusqu'à ce que le client soit en ligne, utilisez le SDK Firestore complet.
Signature:
commit(): Promise<void>;
Retour:
Promesse<vide>
Une Promise résolue une fois que toutes les écritures du lot ont été écrites avec succès dans le backend en tant qu'unité atomique (notez qu'elle ne sera pas résolue lorsque vous êtes hors ligne).
WriteBatch.delete()
Supprime le document référencé par le DocumentReference fourni .
Signature:
delete<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): WriteBatch;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| documentRéf | Référence de document <AppModelType, DbModelType> | Une référence au document à supprimer. |
Retour:
Cette instance WriteBatch . Utilisé pour enchaîner les appels de méthode.
WriteBatch.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>): WriteBatch;
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:
Cette instance WriteBatch . Utilisé pour enchaîner les appels de méthode.
WriteBatch.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): WriteBatch;
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:
Cette instance WriteBatch . Utilisé pour enchaîner les appels de méthode.
Des exceptions
Erreur - Si l'entrée fournie n'est pas un document Firestore valide.
WriteBatch.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>): WriteBatch;
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:
Cette instance WriteBatch . 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.
WriteBatch.update()
Met à jour les champs du document référencé par cette DocumentReference . 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[]): WriteBatch;
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:
Cette instance WriteBatch . 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.