Supprimer des documents et des champs
Les exemples suivants montrent comment supprimer des documents, des champs et des collections.
Supprimer des documents
Pour supprimer un document, utilisez les méthodes delete()
spécifiques à la langue suivantes :
Version Web 9
Utilisez la méthode deleteDoc()
.
import { doc, deleteDoc } from "firebase/firestore"; await deleteDoc(doc(db, "cities", "DC"));
Version Web 8
Utilisez la méthode delete()
.
db.collection("cities").doc("DC").delete().then(() => { console.log("Document successfully deleted!"); }).catch((error) => { console.error("Error removing document: ", error); });
Swift
Utilisez la méthode delete()
.
do { try await db.collection("cities").document("DC").delete() print("Document successfully removed!") } catch { print("Error removing document: \(error)") }
Objective-C
Utilisez la méthode deleteDocumentWithCompletion:
.
[[[self.db collectionWithPath:@"cities"] documentWithPath:@"DC"] deleteDocumentWithCompletion:^(NSError * _Nullable error) { if (error != nil) { NSLog(@"Error removing document: %@", error); } else { NSLog(@"Document successfully removed!"); } }];
Kotlin + KTX
Android
Utilisez la méthode delete()
.
db.collection("cities").document("DC") .delete() .addOnSuccessListener { Log.d(TAG, "DocumentSnapshot successfully deleted!") } .addOnFailureListener { e -> Log.w(TAG, "Error deleting document", e) }
Java
Android
Utilisez la méthode delete()
.
db.collection("cities").document("DC") .delete() .addOnSuccessListener(new OnSuccessListener<Void>() { @Override public void onSuccess(Void aVoid) { Log.d(TAG, "DocumentSnapshot successfully deleted!"); } }) .addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception e) { Log.w(TAG, "Error deleting document", e); } });
Dart
Utilisez la méthode delete()
.
db.collection("cities").doc("DC").delete().then( (doc) => print("Document deleted"), onError: (e) => print("Error updating document $e"), );
Java
Utilisez la méthode delete()
.
Python
Utilisez la méthode delete()
.
Python
(asynchrone)
Utilisez la méthode delete()
.
C++
Utilisez la méthode Delete()
.
db->Collection("cities").Document("DC").Delete().OnCompletion( [](const Future<void>& future) { if (future.error() == Error::kErrorOk) { std::cout << "DocumentSnapshot successfully deleted!" << std::endl; } else { std::cout << "Error deleting document: " << future.error_message() << std::endl; } });
Node.js
Utilisez la méthode delete()
.
Go
Utilisez la méthode Delete()
.
PHP
Utilisez la méthode delete()
.
Unity
Utilisez la méthode DeleteAsync()
.
DocumentReference cityRef = db.Collection("cities").Document("DC"); cityRef.DeleteAsync();
C#
Utilisez la méthode DeleteAsync()
.
Ruby
Utilisez la méthode delete()
.
Lorsque vous supprimez un document, Firestore ne supprime pas automatiquement les documents de ses sous-collections. Vous pouvez toujours accéder aux documents des sous-collections par référence.
Par exemple, vous pouvez accéder au document en suivant le chemin d'accès /mycoll/mydoc/mysubcoll/mysubdoc
même si vous supprimez le document ancêtre à l'emplacement /mycoll/mydoc
.
Des documents ancêtres inexistants apparaissent dans la console, mais ils n'apparaissent pas dans les résultats de requête ni dans les instantanés.
Si vous souhaitez supprimer un document et tous les documents de ses sous-collections, vous devez le faire manuellement. Pour plus d'informations, consultez la section Supprimer des collections.
Supprimer des champs
Pour supprimer des champs spécifiques d'un document, utilisez les méthodes FieldValue.delete()
spécifiques à la langue suivantes lorsque vous mettez à jour un document :
Version Web 9
Utilisez la méthode deleteField()
.
import { doc, updateDoc, deleteField } from "firebase/firestore"; const cityRef = doc(db, 'cities', 'BJ'); // Remove the 'capital' field from the document await updateDoc(cityRef, { capital: deleteField() });
Version Web 8
Utilisez la méthode FieldValue.delete()
.
var cityRef = db.collection('cities').doc('BJ'); // Remove the 'capital' field from the document var removeCapital = cityRef.update({ capital: firebase.firestore.FieldValue.delete() });
Swift
Utilisez la méthode FieldValue.delete()
.
do { try await db.collection("cities").document("BJ").updateData([ "capital": FieldValue.delete(), ]) print("Document successfully updated") } catch { print("Error updating document: \(error)") }
Objective-C
Utilisez la méthode fieldValueForDelete:
.
[[[self.db collectionWithPath:@"cities"] documentWithPath:@"BJ"] updateData:@{ @"capital": [FIRFieldValue fieldValueForDelete] } completion:^(NSError * _Nullable error) { if (error != nil) { NSLog(@"Error updating document: %@", error); } else { NSLog(@"Document successfully updated"); } }];
Kotlin + KTX
Android
Utilisez la méthode FieldValue.delete()
.
val docRef = db.collection("cities").document("BJ") // Remove the 'capital' field from the document val updates = hashMapOf<String, Any>( "capital" to FieldValue.delete(), ) docRef.update(updates).addOnCompleteListener { }
Java
Android
Utilisez la méthode FieldValue.delete()
.
DocumentReference docRef = db.collection("cities").document("BJ"); // Remove the 'capital' field from the document Map<String,Object> updates = new HashMap<>(); updates.put("capital", FieldValue.delete()); docRef.update(updates).addOnCompleteListener(new OnCompleteListener<Void>() { // ... // ...
Dart
Utilisez la méthode FieldValue.delete()
.
final docRef = db.collection("cities").doc("BJ"); // Remove the 'capital' field from the document final updates = <String, dynamic>{ "capital": FieldValue.delete(), }; docRef.update(updates);
Java
Utilisez la méthode FieldValue.delete()
.
Python
Utilisez la méthode firestore.DELETE_FIELD
.
Python
(asynchrone)
Utilisez la méthode firestore.DELETE_FIELD
.
C++
Utilisez la méthode FieldValue::Delete()
.
DocumentReference doc_ref = db->Collection("cities").Document("BJ"); doc_ref.Update({{"capital", FieldValue::Delete()}}) .OnCompletion([](const Future<void>& future) { /*...*/ });
Node.js
Utilisez la méthode FieldValue.delete()
.
Go
Utilisez la méthode firestore.Delete
.
PHP
Utilisez la méthode FieldValue::deleteField()
.
Unity
Utilisez la méthode FieldValue.Delete
.
DocumentReference cityRef = db.Collection("cities").Document("BJ"); Dictionary<string, object> updates = new Dictionary<string, object> { { "Capital", FieldValue.Delete } };
C#
Utilisez la méthode FieldValue.Delete
.
Ruby
Utilisez la méthode firestore.field_delete
.
Supprimer des collections
Pour supprimer une collection ou une sous-collection entière dans Firestore, procédez comme suit : récupérer (lire) tous les documents de la collection ou de la sous-collection et les supprimer de l'IA générative. Ce processus entraîne des coûts de lecture et de suppression. Si vous avez des vous pouvez supprimer les documents par petits lots pour éviter de mémoire insuffisante. Procédez de la même manière jusqu'à ce que vous ayez supprimé l'intégralité ou une sous-collection.
La suppression d'une collection nécessite la coordination d'un nombre illimité de requêtes de suppression individuelles. Si vous devez supprimer des collections entières, faites-le uniquement depuis un environnement de serveur de confiance. Bien qu'il soit possible de supprimer une collection d'un client mobile ou Web, cela a des implications négatives en termes de sécurité et de performance.
Les extraits ci-dessous sont simplifiés et ne traitent pas de la gestion des erreurs, de la sécurité, de la suppression des sous-collections, ni de l'optimisation des performances. Pour en savoir plus sur une méthode recommandée pour supprimer des collections en production, consultez la section Supprimer des collections et sous-collections.
Web
// Deleting collections from a Web client is not recommended.
Swift
// Deleting collections from an Apple client is not recommended.
Objective-C
// Deleting collections from an Apple client is not recommended.
Kotlin + KTX
Android
// Deleting collections from an Android client is not recommended.
Java
Android
// Deleting collections from an Android client is not recommended.
Dart
Il n'est pas recommandé de supprimer des collections du client.
Java
Python
Python
(asynchrone)
C++
// This is not supported. Delete data using CLI as discussed below.
Node.js
Go
PHP
Unity
// This is not supported. Delete data using CLI as discussed below.
C#
Ruby
Supprimer des données avec la CLI Firebase
Vous pouvez également utiliser la CLI Firebase pour supprimer des documents et des collections. Utilisez la commande suivante pour supprimer des données :
firebase firestore:delete [options] <<path>>
Supprimer des données avec la console
Vous pouvez supprimer des documents et des collections depuis la page Firestore de la console. La suppression d'un document depuis la console entraîne la suppression de toutes les données imbriquées dans ce document, y compris les sous-collections.
Supprimer des données à l'aide de règles TTL
Une règle TTL désigne un champ donné comme délai d'expiration des documents dans un un groupe de collections donné. Les opérations de suppression TTL sont comptabilisées dans la suppression de votre document. les coûts.
Pour en savoir plus sur la configuration de la valeur TTL, consultez Gérer la conservation des données à l'aide de règles TTL.
Pour en savoir plus sur les codes d'erreur et sur la résolution des problèmes de latence lors de la suppression de données, consultez la page de dépannage.
Supprimer des données avec Dataflow
Dataflow est un excellent outil pour les opérations groupées sur votre base de données Firestore. La Cet article de blog de la présentation du connecteur Firestore pour Dataflow contient un exemple de suppression de tous les documents dans un groupe de collections.