次の例は、ドキュメント、フィールド、およびコレクションを削除する方法を示しています。
ドキュメントを削除する
ドキュメントを削除するには、次の言語固有の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!") } }
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"), );
ジャワ
delete()
メソッドを使用します。
パイソン
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()
メソッドを使用します。
行け
Delete()
メソッドを使用します。
PHP
delete()
メソッドを使用します。
団結
DeleteAsync()
メソッドを使用します。
DocumentReference cityRef = db.Collection("cities").Document("DC"); cityRef.DeleteAsync();
C#
DeleteAsync()
メソッドを使用します。
ルビー
delete()
メソッドを使用します。
ドキュメントを削除しても、Cloud Firestore はそのサブコレクション内のドキュメントを自動的に削除しません。サブコレクションのドキュメントには参照によって引き続きアクセスできます。たとえば、 /mycoll/mydoc にある祖先ドキュメントを削除しても、パス/mycoll/mydoc/mysubcoll/mysubdoc
/mycoll/mydoc
あるドキュメントにアクセスできます。
存在しない祖先ドキュメントはコンソールに表示されますが、クエリ結果とスナップショットには表示されません。
ドキュメントとそのサブコレクション内のすべてのドキュメントを削除する場合は、手動で行う必要があります。詳細については、コレクションの削除を参照してください。
フィールドを削除する
ドキュメントから特定のフィールドを削除するには、ドキュメントを更新するときに、次の言語固有の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") } }
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);
ジャワ
FieldValue.delete()
メソッドを使用します。
パイソン
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()
メソッドを使用します。
行け
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.
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
クライアントからコレクションを削除することはお勧めしません。
ジャワ
パイソン
Python
C++
// This is not supported. Delete data using CLI as discussed below.
Node.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 ページからドキュメントとコレクションを削除できます。コンソールからドキュメントを削除すると、サブコレクションを含む、そのドキュメント内のネストされたすべてのデータが削除されます。