הדוגמאות הבאות מדגימות כיצד למחוק מסמכים, שדות ואוספים.
מחק מסמכים
כדי למחוק מסמך, השתמש בשיטת delete()
:
Web version 9
import { doc, deleteDoc } from "firebase/firestore"; await deleteDoc(doc(db, "cities", "DC"));
Web version 8
db.collection("cities").doc("DC").delete().then(() => { console.log("Document successfully deleted!"); }).catch((error) => { console.error("Error removing document: ", error); });
מָהִיר
db.collection("cities").document("DC").delete() { err in if let err = err { print("Error removing document: \(err)") } else { print("Document successfully removed!") } }
Objective-C
[[[self.db collectionWithPath:@"cities"] documentWithPath:@"DC"] deleteDocumentWithCompletion:^(NSError * _Nullable error) { if (error != nil) { NSLog(@"Error removing document: %@", error); } else { NSLog(@"Document successfully removed!"); } }];
Java
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); } });
Kotlin+KTX
db.collection("cities").document("DC") .delete() .addOnSuccessListener { Log.d(TAG, "DocumentSnapshot successfully deleted!") } .addOnFailureListener { e -> Log.w(TAG, "Error deleting document", e) }
Dart
db.collection("cities").doc("DC").delete().then( (doc) => print("Document deleted"), onError: (e) => print("Error updating document $e"), );
Java
פִּיתוֹן
Python
C++
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
ללכת
PHP
$db->collection('samples/php/cities')->document('DC')->delete();
אַחְדוּת
DocumentReference cityRef = db.Collection("cities").Document("DC"); cityRef.DeleteAsync();
C#
DocumentReference cityRef = db.Collection("cities").Document("DC"); await cityRef.DeleteAsync();
אוֹדֶם
כאשר אתה מוחק מסמך, Cloud Firestore לא מוחק אוטומטית את המסמכים בתוך אוספי המשנה שלו. אתה עדיין יכול לגשת למסמכי איסוף המשנה על ידי הפניה. לדוגמה, אתה יכול לגשת למסמך ב-path /mycoll/mydoc/mysubcoll/mysubdoc
גם אם תמחק את מסמך האב ב- /mycoll/mydoc
.
מסמכים קדומים שאינם קיימים מופיעים במסוף , אך הם אינם מופיעים בתוצאות שאילתות ובתצלומי מצב.
אם ברצונך למחוק מסמך ואת כל המסמכים שבתת-האוספים שלו, עליך לעשות זאת באופן ידני. למידע נוסף, ראה מחק אוספים .
מחק שדות
כדי למחוק שדות ספציפיים ממסמך, השתמש בשיטת FieldValue.delete()
בעת עדכון מסמך:
Web version 9
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() });
Web version 8
var cityRef = db.collection('cities').doc('BJ'); // Remove the 'capital' field from the document var removeCapital = cityRef.update({ capital: firebase.firestore.FieldValue.delete() });
מָהִיר
db.collection("cities").document("BJ").updateData([ "capital": FieldValue.delete(), ]) { err in if let err = err { print("Error updating document: \(err)") } else { print("Document successfully updated") } }
Objective-C
[[[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"); } }];
Java
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>() { // ... // ...
Kotlin+KTX
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 { }
Dart
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
פִּיתוֹן
Python
C++
DocumentReference doc_ref = db->Collection("cities").Document("BJ"); doc_ref.Update({{"capital", FieldValue::Delete()}}) .OnCompletion([](const Future<void>& future) { /*...*/ });
Node.js
ללכת
PHP
$cityRef = $db->collection('samples/php/cities')->document('BJ'); $cityRef->update([ ['path' => 'capital', 'value' => FieldValue::deleteField()] ]);
אַחְדוּת
DocumentReference cityRef = db.Collection("cities").Document("BJ"); Dictionary<string, object> updates = new Dictionary<string, object> { { "Capital", FieldValue.Delete } };
C#
DocumentReference cityRef = db.Collection("cities").Document("BJ"); Dictionary<string, object> updates = new Dictionary<string, object> { { "Capital", FieldValue.Delete } }; await cityRef.UpdateAsync(updates);
אוֹדֶם
מחק אוספים
כדי למחוק אוסף שלם או תת-אוסף ב-Cloud Firestore, אחזר את כל המסמכים בתוך האוסף או המשנה ומחק אותם. אם יש לך אוספים גדולים יותר, ייתכן שתרצה למחוק את המסמכים בקבוצות קטנות יותר כדי למנוע שגיאות חסרות הזיכרון. חזור על התהליך עד שתמחק את כל האוסף או המשנה.
מחיקת אוסף מחייבת תיאום של מספר בלתי מוגבל של בקשות מחיקה בודדות. אם אתה צריך למחוק אוספים שלמים, עשה זאת רק מסביבת שרת מהימנה. אמנם ניתן למחוק אוסף מלקוח סלולרי/אינטרנט, אך יש לכך השלכות שליליות על אבטחה וביצועים.
הקטעים שלהלן מעט מפושטים ואינם עוסקים בטיפול בשגיאות, אבטחה, מחיקת אוספי משנה או מקסום ביצועים. למידע נוסף על גישה מומלצת אחת למחיקת אוספים בהפקה, ראה מחיקת אוספים ותתי אוספים .
אינטרנט
// Deleting collections from a Web client is not recommended.
מָהִיר
// Deleting collections from an Apple client is not recommended.
Objective-C
// Deleting collections from an Apple client is not recommended.
Java
// Deleting collections from an Android client is not recommended.
Kotlin+KTX
// Deleting collections from an Android client is not recommended.
Dart
לא מומלץ למחוק אוספים מהלקוח.
Java
פִּיתוֹן
Python
C++
// This is not supported. Delete data using CLI as discussed below.
Node.js
ללכת
PHP
function data_delete_collection(string $projectId, string $collectionName, int $batchSize) { // Create the Cloud Firestore client $db = new FirestoreClient([ 'projectId' => $projectId, ]); $collectionReference = $db->collection($collectionName); $documents = $collectionReference->limit($batchSize)->documents(); while (!$documents->isEmpty()) { foreach ($documents as $document) { printf('Deleting document %s' . PHP_EOL, $document->id()); $document->reference()->delete(); } $documents = $collectionReference->limit($batchSize)->documents(); } }
אַחְדוּת
// This is not supported. Delete data using CLI as discussed below.
C#
private static async Task DeleteCollection(CollectionReference collectionReference, int batchSize) { QuerySnapshot snapshot = await collectionReference.Limit(batchSize).GetSnapshotAsync(); IReadOnlyList<DocumentSnapshot> documents = snapshot.Documents; while (documents.Count > 0) { foreach (DocumentSnapshot document in documents) { Console.WriteLine("Deleting document {0}", document.Id); await document.Reference.DeleteAsync(); } snapshot = await collectionReference.Limit(batchSize).GetSnapshotAsync(); documents = snapshot.Documents; } Console.WriteLine("Finished deleting all documents from the collection."); }
אוֹדֶם
מחק נתונים עם Firebase CLI
אתה יכול גם להשתמש ב- Firebase CLI כדי למחוק מסמכים ואוספים. השתמש בפקודה הבאה כדי למחוק נתונים:
firebase firestore:delete [options] <<path>>
מחק נתונים באמצעות המסוף
אתה יכול למחוק מסמכים ואוספים מדף Cloud Firestore במסוף . מחיקת מסמך מהמסוף מוחקת את כל הנתונים המקוננים באותו מסמך, כולל כל תת-אוספים.