以下範例說明如何刪除文件、欄位和集合。
刪除文件
如要刪除文件,請使用下列特定語言的 delete()
方法:
Web
使用 deleteDoc()
方法:
import { doc, deleteDoc } from "firebase/firestore"; await deleteDoc(doc(db, "cities", "DC"));
Web
使用 delete()
方法:
db.collection("cities").doc("DC").delete().then(() => { console.log("Document successfully deleted!"); }).catch((error) => { console.error("Error removing document: ", error); });
Swift
使用 delete()
方法:
do { try await db.collection("cities").document("DC").delete() print("Document successfully removed!") } catch { print("Error removing document: \(error)") }
Objective-C
使用 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
使用 delete()
方法:
db.collection("cities").document("DC") .delete() .addOnSuccessListener { Log.d(TAG, "DocumentSnapshot successfully deleted!") } .addOnFailureListener { e -> Log.w(TAG, "Error deleting document", e) }
Java
使用 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
使用 delete()
方法:
db.collection("cities").doc("DC").delete().then( (doc) => print("Document deleted"), onError: (e) => print("Error updating document $e"), );
Java
使用 delete()
方法:
Python
使用 delete()
方法:
Python
使用 delete()
方法:
C++
使用 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
使用 delete()
方法:
Go
使用 Delete()
方法:
PHP
使用 delete()
方法:
Unity
使用 DeleteAsync()
方法:
DocumentReference cityRef = db.Collection("cities").Document("DC"); cityRef.DeleteAsync();
C#
使用 DeleteAsync()
方法:
Ruby
使用 delete()
方法:
刪除文件時,Cloud Firestore 不會自動刪除其子集合中的文件。您仍可透過參照存取子集合文件。舉例來說,即使您刪除 /mycoll/mydoc
中的祖系文件,還是可以存取 /mycoll/mydoc/mysubcoll/mysubdoc
路徑中的文件。
不存在的祖系文件會顯示在控制台,但不會顯示在查詢結果和快照中。
如果您想刪除文件及其子集合中的所有文件,必須手動執行這項操作。詳情請參閱「刪除集合」。
刪除欄位
如要從文件中刪除特定欄位,請在更新文件時使用下列特定語言的 FieldValue.delete()
方法:
Web
使用 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() });
Web
使用 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
使用 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
使用 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
使用 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
使用 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
使用 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
使用 FieldValue.delete()
方法:
Python
使用 firestore.DELETE_FIELD
方法:
Python
使用 firestore.DELETE_FIELD
方法:
C++
使用 FieldValue::Delete()
方法:
DocumentReference doc_ref = db->Collection("cities").Document("BJ"); doc_ref.Update({{"capital", FieldValue::Delete()}}) .OnCompletion([](const Future<void>& future) { /*...*/ });
Node.js
使用 FieldValue.delete()
方法:
Go
使用 firestore.Delete
方法:
PHP
使用 FieldValue::deleteField()
方法:
Unity
使用 FieldValue.Delete
方法:
DocumentReference cityRef = db.Collection("cities").Document("BJ"); Dictionary<string, object> updates = new Dictionary<string, object> { { "Capital", FieldValue.Delete } };
C#
使用 FieldValue.Delete
方法:
Ruby
使用 firestore.field_delete
方法:
刪除集合
如要刪除 Cloud Firestore 中的整個珍藏內容或子集合,請擷取 (讀取) 珍藏內容或子集合中的所有文件,然後刪除這些文件。這項程序會產生讀取和刪除費用。如果您擁有較大的集合,建議您刪除較小的批次文件,以免發生記憶體不足錯誤。重複執行這個程序,直到刪除整個集合或子集合為止。
刪除集合時,需要協調無限數量的個別刪除要求。如果您需要刪除整個產品素材資源集合,請務必在可信任的伺服器環境中執行。雖然可以從行動/網頁用戶端刪除集合,但這會對安全性和效能造成負面影響。
以下程式碼片段經過簡化,不會處理錯誤處理、安全性、刪除子集合或盡可能提高效能。如要進一步瞭解在正式環境中刪除集合的建議做法,請參閱「刪除集合和子集合」。
網頁
// 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
// Deleting collections from an Android client is not recommended.
Java
// Deleting collections from an Android client is not recommended.
Dart
我們不建議從用戶端刪除集合。
Java
Python
Python
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
使用 Firebase CLI 刪除資料
您也可以使用 Firebase CLI 刪除文件和集合。使用下列指令刪除資料:
firebase firestore:delete [options] <<path>>
使用控制台刪除資料
您可以在控制台的 Cloud Firestore 頁面中刪除文件和珍藏內容。從控制台中刪除文件會刪除該文件中的所有巢狀資料,包括任何子集合。
使用存留時間政策刪除資料
存留時間政策會將特定欄位指定為特定集合群組中文件的到期時間。TTL 刪除作業會計入文件刪除費用。
如要瞭解如何設定 TTL,請參閱「透過 TTL 政策管理資料保留時間」。
如要進一步瞭解錯誤代碼,以及如何解決刪除資料時的延遲問題,請參閱疑難排解頁面。
使用 Dataflow 刪除資料
Dataflow 是處理 Firestore 資料庫大量作業的絕佳工具。部落格文章介紹了 Dataflow 的 Firestore 連接器,其中有刪除集合群組中所有文件的範例。
使用受管理的大量刪除功能
Cloud Firestore 支援一或多個集合群組的大量刪除作業。詳情請參閱「大量刪除資料」。