以下示例演示如何删除文档、字段和集合。
删除文档
要删除文档,请使用以下特定于语言的delete()
方法:
Web version 9
使用deleteDoc()
方法:
import { doc, deleteDoc } from "firebase/firestore"; await deleteDoc(doc(db, "cities", "DC"));
Web version 8
使用delete()
方法:
db.collection("cities").doc("DC").delete().then(() => { console.log("Document successfully deleted!"); }).catch((error) => { console.error("Error removing document: ", error); });
迅速
使用delete()
方法:
db.collection("cities").document("DC").delete() { err in if let err = err { print("Error removing document: \(err)") } else { print("Document successfully removed!") } }
目标-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"), );
爪哇
使用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; } });
节点.js
使用delete()
方法:
去
使用Delete()
方法:
PHP
使用delete()
方法:
统一
使用DeleteAsync()
方法:
DocumentReference cityRef = db.Collection("cities").Document("DC"); cityRef.DeleteAsync();
C#
使用DeleteAsync()
方法:
红宝石
使用delete()
方法:
当您删除文档时,Cloud Firestore 不会自动删除其子集合中的文档。您仍然可以通过引用访问子资源库文档。例如,即使删除位于/mycoll/mydoc
的祖先文档,您也可以访问路径/mycoll/mydoc/mysubcoll/mysubdoc
中的文档。
不存在的祖先文档出现在控制台中,但它们不会出现在查询结果和快照中。
如果要删除文档及其子集合中的所有文档,则必须手动执行。有关详细信息,请参阅删除集合。
删除字段
要从文档中删除特定字段,请在更新文档时使用以下特定于语言的FieldValue.delete()
方法:
Web version 9
使用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 version 8
使用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() });
迅速
使用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") } }
目标-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);
爪哇
使用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) { /*...*/ });
节点.js
使用FieldValue.delete()
方法:
去
使用firestore.Delete
方法:
PHP
使用FieldValue::deleteField()
方法:
统一
使用FieldValue.Delete
方法:
DocumentReference cityRef = db.Collection("cities").Document("BJ"); Dictionary<string, object> updates = new Dictionary<string, object> { { "Capital", FieldValue.Delete } };
C#
使用FieldValue.Delete
方法:
红宝石
使用firestore.field_delete
方法:
删除集合
要删除 Cloud Firestore 中的整个集合或子集合,请检索集合或子集合中的所有文档并将其删除。如果您有较大的集合,您可能希望以较小的批次删除文档以避免内存不足错误。重复该过程,直到您删除了整个集合或子集合。
删除集合需要协调无限数量的单个删除请求。如果您需要删除整个集合,请仅在受信任的服务器环境中执行此操作。虽然可以从移动/Web 客户端删除集合,但这样做会对安全和性能产生负面影响。
下面的代码片段有些简化,不涉及错误处理、安全、删除子集合或最大化性能。要了解有关在生产中删除集合的推荐方法的更多信息,请参阅删除集合和子集合。
网络
// Deleting collections from a Web client is not recommended.
迅速
// Deleting collections from an Apple client is not recommended.
目标-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
不建议从客户端删除集合。
爪哇
Python
Python
C++
// This is not supported. Delete data using CLI as discussed below.
节点.js
去
PHP
统一
// This is not supported. Delete data using CLI as discussed below.
C#
红宝石
使用 Firebase CLI 删除数据
您还可以使用Firebase CLI删除文档和集合。使用以下命令删除数据:
firebase firestore:delete [options] <<path>>
使用控制台删除数据
您可以从控制台的 Cloud Firestore 页面删除文档和集合。从控制台删除文档会删除该文档中的所有嵌套数据,包括任何子集合。