Nos exemplos a seguir, você vê como excluir documentos, campos e coleções.
Excluir documentos
Para excluir um documento, use os métodos delete()
específicos de idioma a seguir:
API modular da Web
Use o método deleteDoc()
:
import { doc, deleteDoc } from "firebase/firestore"; await deleteDoc(doc(db, "cities", "DC"));
API com namespace da Web
Use o método delete()
:
db.collection("cities").doc("DC").delete().then(() => { console.log("Document successfully deleted!"); }).catch((error) => { console.error("Error removing document: ", error); });
Swift
Use o método delete()
.
do { try await db.collection("cities").document("DC").delete() print("Document successfully removed!") } catch { print("Error removing document: \(error)") }
Objective-C
Use o método 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
Use o método delete()
.
db.collection("cities").document("DC") .delete() .addOnSuccessListener { Log.d(TAG, "DocumentSnapshot successfully deleted!") } .addOnFailureListener { e -> Log.w(TAG, "Error deleting document", e) }
Java
Use o método 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
Use o método delete()
.
db.collection("cities").doc("DC").delete().then( (doc) => print("Document deleted"), onError: (e) => print("Error updating document $e"), );
Java
Use o método delete()
.
Python
Use o método delete()
.
Python
Use o método delete()
.
C++
Use o método 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
Use o método delete()
.
Go
Use o método Delete()
.
PHP
Use o método delete()
:
Unity
Use o método DeleteAsync()
.
DocumentReference cityRef = db.Collection("cities").Document("DC"); cityRef.DeleteAsync();
C#
Use o método DeleteAsync()
:
Ruby
Use o método delete()
:
Quando você exclui um documento, o Cloud 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 os métodos FieldValue.delete()
específicos de idioma a seguir
ao atualizar um documento:
API modular da Web
Use o método 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() });
API com namespace da Web
Use o método 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
Use o método 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
Use o método 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
Use o método 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
Use o método 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
Use o método 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
Use o método FieldValue.delete()
.
Python
Use o método firestore.DELETE_FIELD
.
Python
Use o método firestore.DELETE_FIELD
.
C++
Use o método FieldValue::Delete()
.
DocumentReference doc_ref = db->Collection("cities").Document("BJ"); doc_ref.Update({{"capital", FieldValue::Delete()}}) .OnCompletion([](const Future<void>& future) { /*...*/ });
Node.js
Use o método FieldValue.delete()
.
Go
Use o método firestore.Delete
.
PHP
Use o método FieldValue::deleteField()
:
Unity
Use o método FieldValue.Delete
.
DocumentReference cityRef = db.Collection("cities").Document("BJ"); Dictionary<string, object> updates = new Dictionary<string, object> { { "Capital", FieldValue.Delete } };
C#
Use o método FieldValue.Delete
:
Ruby
Use o método firestore.field_delete
:
Excluir coleções
Para excluir uma coleção ou subcoleção completa no Cloud Firestore, recupere (leia) todos os documentos dentro da coleção ou subcoleção e os exclua. Esse processo gera custos de leitura e exclusão. 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 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
Não é recomendável excluir coleções do cliente.
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
Excluir dados com a CLI do Firebase
Você também pode usar a CLI do FirebaseI 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 Cloud Firestore no console. A exclusão de um documento do console exclui todos os dados aninhados desse documento, incluindo quaisquer subcoleções.
Excluir dados com políticas de TTL
Uma política de TTL designa um determinado campo como o prazo de validade de documentos em um determinado grupo de coleções. As operações de exclusão de TTL são contabilizadas nos seus custos de exclusão de documentos.
Para mais informações sobre como configurar o TTL, consulte Gerenciar a retenção de dados com políticas de TTL.
Consulte a página de solução de problemas para mais informações sobre códigos de erro e como resolver problemas de latência ao excluir dados.
Excluir dados com o Dataflow
O Dataflow é uma ótima ferramenta para operações em massa no banco de dados do Firestore. A postagem do blog de introdução ao conector do Firestore para Dataflow tem um exemplo de exclusão de todos os documentos em um grupo de coleções.