Nos exemplos a seguir, você vê como excluir documentos, campos e coleções.
Excluir documentos
Para excluir um documento, use o método delete()
:
Web
db.collection("cities").doc("DC").delete().then(function() { console.log("Document successfully deleted!"); }).catch(function(error) { console.error("Error removing document: ", error); });
Swift
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
Android
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
Android
db.collection("cities").document("DC") .delete() .addOnSuccessListener { Log.d(TAG, "DocumentSnapshot successfully deleted!") } .addOnFailureListener { e -> Log.w(TAG, "Error deleting document", e) }
Java
// asynchronously delete a document ApiFuture<WriteResult> writeResult = db.collection("cities").document("DC").delete(); // ... System.out.println("Update time : " + writeResult.get().getUpdateTime());
Python
db.collection(u'cities').document(u'DC').delete()
C++
db->Collection("cities").Document("DC").Delete().OnCompletion( [](const Future<void>& future) { if (future.error() == Error::kErrorOk) { std::cout << "DocumentSnapshot successfully deleted!\n"; } else { std::cout << "Error deleting document: " << future.error_message() << '\n'; } });
Node.js
const res = await db.collection('cities').doc('DC').delete();
Go
_, err := client.Collection("cities").Doc("DC").Delete(ctx) if err != nil { // Handle any errors in an appropriate way, such as returning them. log.Printf("An error has occurred: %s", err) }
PHP
$db->collection('cities')->document('DC')->delete();
Unity
DocumentReference cityRef = db.Collection("cities").Document("DC"); cityRef.DeleteAsync();
C#
DocumentReference cityRef = db.Collection("cities").Document("DC"); await cityRef.DeleteAsync();
Ruby
city_ref = firestore.doc "#{collection_path}/DC" city_ref.delete
Quando você exclui um documento, o Firestore não remove
automaticamente os documentos nas
subcoleções dele. Ainda é possível acessar os documentos da subcoleção para fins de consulta.
Por exemplo, é possível acessar o documento no caminho
/mycoll/mydoc/mysubcoll/mysubdoc
, mesmo se
você excluir o documento ancestral em /mycoll/mydoc
.
Os documentos ancestrais inexistentes são exibidos no console, mas não aparecem nos resultados de consulta e snapshots.
Se quiser excluir um documento e todos os que estão contidos nas subcoleções dele, você precisará fazer isso manualmente. Para mais informações, consulte Excluir coleções.
Excluir campos
Para excluir campos específicos de um documento, use o método FieldValue.delete()
ao atualizá-lo:
Web
var cityRef = db.collection('cities').doc('BJ'); // Remove the 'capital' field from the document var removeCapital = cityRef.update({ capital: firebase.firestore.FieldValue.delete() });
Swift
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
Android
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
Android
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
DocumentReference docRef = db.collection("cities").document("BJ"); Map<String, Object> updates = new HashMap<>(); updates.put("capital", FieldValue.delete()); // Update and delete the "capital" field in the document ApiFuture<WriteResult> writeResult = docRef.update(updates); System.out.println("Update time : " + writeResult.get());
Python
city_ref = db.collection(u'cities').document(u'BJ') city_ref.update({ u'capital': firestore.DELETE_FIELD })
C++
DocumentReference doc_ref = db->Collection("cities").Document("BJ"); doc_ref.Update({{"capital", FieldValue::Delete()}}) .OnCompletion([](const Future<void>& future) { /*...*/ });
Node.js
// Get the `FieldValue` object const FieldValue = admin.firestore.FieldValue; // Create a document reference const cityRef = db.collection('cities').doc('BJ'); // Remove the 'capital' field from the document const res = await cityRef.update({ capital: FieldValue.delete() });
Go
_, err := client.Collection("cities").Doc("BJ").Update(ctx, []firestore.Update{ { Path: "capital", Value: firestore.Delete, }, }) if err != nil { // Handle any errors in an appropriate way, such as returning them. log.Printf("An error has occurred: %s", err) }
PHP
$cityRef = $db->collection('cities')->document('BJ'); $cityRef->update([ ['path' => 'capital', 'value' => FieldValue::deleteField()] ]);
Unity
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);
Ruby
city_ref = firestore.doc "#{collection_path}/BJ" city_ref.update capital: firestore.field_delete
Excluir coleções
Para excluir uma coleção ou subcoleção completa no Firestore, recupere todos os documentos dentro da coleção ou subcoleção e os exclua. Se você tem coleções maiores, exclua os documentos em lotes menores para evitar erros de falta de memória. Repita o processo até excluir toda a coleção ou subcoleção.
A exclusão de uma coleção exige a coordenação de um número ilimitado de solicitações de exclusão individuais. Se você precisar excluir coleções inteiras, faça isso somente a partir de um ambiente de servidor confiável. É possível excluir uma coleção de um cliente da Web/dispositivos móveis, mas isso tem implicações negativas para a segurança e o desempenho.
Os snippets abaixo estão simplificados e não incluem processamento de erros, segurança, exclusão de subcoleções ou aumento de desempenho. Para saber mais sobre uma abordagem recomendada para excluir coleções em produção, consulte Como excluir coleções e subcoleções.
Web
// Deleting collections from a Web client is not recommended.
Swift
// Deleting collections from an iOS client is not recommended.
Objective-C
// Deleting collections from an iOS client is not recommended.
Java
Android
// Deleting collections from an Android client is not recommended.
Kotlin+KTX
Android
// Deleting collections from an Android client is not recommended.
Java
/** Delete a collection in batches to avoid out-of-memory errors. * Batch size may be tuned based on document size (atmost 1MB) and application requirements. */ void deleteCollection(CollectionReference collection, int batchSize) { try { // retrieve a small batch of documents to avoid out-of-memory errors ApiFuture<QuerySnapshot> future = collection.limit(batchSize).get(); int deleted = 0; // future.get() blocks on document retrieval List<QueryDocumentSnapshot> documents = future.get().getDocuments(); for (QueryDocumentSnapshot document : documents) { document.getReference().delete(); ++deleted; } if (deleted >= batchSize) { // retrieve and delete another batch deleteCollection(collection, batchSize); } } catch (Exception e) { System.err.println("Error deleting collection : " + e.getMessage()); } }
Python
def delete_collection(coll_ref, batch_size): docs = coll_ref.limit(batch_size).stream() deleted = 0 for doc in docs: print(f'Deleting doc {doc.id} => {doc.to_dict()}') doc.reference.delete() deleted = deleted + 1 if deleted >= batch_size: return delete_collection(coll_ref, batch_size)
C++
// This is not supported. Delete data using CLI as discussed below.
Node.js
async function deleteCollection(db, collectionPath, batchSize) { const collectionRef = db.collection(collectionPath); const query = collectionRef.orderBy('__name__').limit(batchSize); return new Promise((resolve, reject) => { deleteQueryBatch(db, query, resolve).catch(reject); }); } async function deleteQueryBatch(db, query, resolve) { const snapshot = await query.get(); const batchSize = snapshot.size; if (batchSize === 0) { // When there are no documents left, we are done resolve(); return; } // Delete documents in a batch const batch = db.batch(); snapshot.docs.forEach((doc) => { batch.delete(doc.ref); }); await batch.commit(); // Recurse on the next process tick, to avoid // exploding the stack. process.nextTick(() => { deleteQueryBatch(db, query, resolve); }); }
Go
func deleteCollection(ctx context.Context, client *firestore.Client, ref *firestore.CollectionRef, batchSize int) error { for { // Get a batch of documents iter := ref.Limit(batchSize).Documents(ctx) numDeleted := 0 // Iterate through the documents, adding // a delete operation for each one to a // WriteBatch. batch := client.Batch() for { doc, err := iter.Next() if err == iterator.Done { break } if err != nil { return err } batch.Delete(doc.Ref) numDeleted++ } // If there are no documents to delete, // the process is over. if numDeleted == 0 { return nil } _, err := batch.Commit(ctx) if err != nil { return err } } }
PHP
function delete_collection($collectionReference, $batchSize) { $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(); } }
Unity
// 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."); }
Ruby
cities_ref = firestore.col collection_path query = cities_ref query.get do |document_snapshot| puts "Deleting document #{document_snapshot.document_id}." document_ref = document_snapshot.ref document_ref.delete end
Excluir dados com a Firebase CLI
Você também pode usar a Firebase CLI para excluir documentos e coleções. Use o comando a seguir para excluir dados:
firebase firestore:delete [options] <<path>>
Excluir dados com o console
É possível excluir documentos e coleções da página do Firestore no console. A exclusão de um documento do console exclui todos os dados aninhados desse documento, incluindo quaisquer subcoleções.