En los siguientes ejemplos, se demuestra cómo borrar documentos, campos y colecciones.
Borra documentos
Si quieres borrar un documento, usa los siguientes métodos delete()
específicos para cada lenguaje:
Web
Usa el método deleteDoc()
:
import { doc, deleteDoc } from "firebase/firestore"; await deleteDoc(doc(db, "cities", "DC"));
Web
Usa el método delete()
:
db.collection("cities").doc("DC").delete().then(() => { console.log("Document successfully deleted!"); }).catch((error) => { console.error("Error removing document: ", error); });
Swift
Usa el método delete()
:
do { try await db.collection("cities").document("DC").delete() print("Document successfully removed!") } catch { print("Error removing document: \(error)") }
Objective-C
Usa el 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
Usa el 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
Usa el 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
Usa el método delete()
:
db.collection("cities").doc("DC").delete().then( (doc) => print("Document deleted"), onError: (e) => print("Error updating document $e"), );
Java
Usa el método delete()
:
Python
Usa el método delete()
:
Python
Usa el método delete()
:
C++
Usa el 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
Usa el método delete()
:
Go
Usa el método Delete()
:
PHP
Usa el método delete()
:
Unity
Usa el método DeleteAsync()
:
DocumentReference cityRef = db.Collection("cities").Document("DC"); cityRef.DeleteAsync();
C#
Usa el método DeleteAsync()
:
Ruby
Usa el método delete()
:
Cuando borras un documento, Cloud Firestore no borra de forma automática los documentos dentro de sus subcolecciones. Aún puedes acceder a los documentos de la subcolección por referencia.
Por ejemplo, puedes acceder al documento en la ruta /mycoll/mydoc/mysubcoll/mysubdoc
incluso si borras el documento principal en /mycoll/mydoc
.
Los documentos principales no existentes aparecen en la consola, pero no se muestran en los resultados de las consultas ni en las instantáneas.
Si quieres borrar un documento y todos los documentos dentro de sus subcolecciones, debes hacerlo de forma manual. Para obtener más información, consulta Borra colecciones.
Borra campos
Si quieres borrar campos específicos de un documento, usa los siguientes métodos FieldValue.delete()
específicos para cada lenguaje
cuando actualices un documento:
Web
Usa el 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() });
Web
Usa el 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
Usa el 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
Usa el 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
Usa el 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
Usa el 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
Usa el 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
Usa el método FieldValue.delete()
:
Python
Usa el método firestore.DELETE_FIELD
:
Python
Usa el método firestore.DELETE_FIELD
:
C++
Usa el 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
Usa el método FieldValue.delete()
:
Go
Usa el método firestore.Delete
:
PHP
Usa el método FieldValue::deleteField()
:
Unity
Usa el método FieldValue.Delete
:
DocumentReference cityRef = db.Collection("cities").Document("BJ"); Dictionary<string, object> updates = new Dictionary<string, object> { { "Capital", FieldValue.Delete } };
C#
Usa el método FieldValue.Delete
:
Ruby
Usa el método firestore.field_delete
:
Borra colecciones
Para borrar por completo una colección o subcolección en Cloud Firestore, recupera (lee) todos los documentos de la colección o subcolección y bórralos. Este proceso genera costos de lectura y eliminación. Si tienes colecciones más grandes, te recomendamos borrar los documentos en lotes pequeños para evitar errores de memoria insuficiente. Repite el proceso hasta que borres toda la colección o subcolección.
Para borrar una colección, se debe coordinar una cantidad ilimitada de solicitudes de eliminación individuales. Si necesitas borrar colecciones completas, hazlo únicamente desde un entorno de servidor de confianza. Si bien es posible borrar una colección desde un cliente web o para dispositivos móviles, hacerlo tiene efectos negativos en el rendimiento y en la seguridad.
Los siguientes fragmentos se simplificaron para mayor claridad y no incluyen el manejo de errores, la seguridad, la eliminación de subcolecciones ni las optimizaciones de rendimiento. Para obtener más información sobre nuestro enfoque recomendado a fin de borrar colecciones en la producción, consulta Borra colecciones y subcolecciones.
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
// Deleting collections from an Android client is not recommended.
Java
// Deleting collections from an Android client is not recommended.
Dart
No se recomienda borrar colecciones desde el 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
Borra datos con políticas de TTL
Una política de TTL designa un campo determinado como la hora de vencimiento de los documentos en un grupo de colecciones determinado. Las operaciones de eliminación de TTL se tienen en cuenta para los costos de eliminación de documentos.
Si quieres obtener más información para configurar el TTL, consulta Administra la retención de datos con políticas de TTL.
Trabajos de eliminación masiva
Cloud Firestore admite varias herramientas para la eliminación masiva. Debes seleccionar una herramienta según la cantidad de documentos que necesitas borrar y el nivel de configurabilidad que necesitas.
Para trabajos más pequeños de miles de documentos, usa la consola o Firebase CLI. Para trabajos más grandes, es posible que estas herramientas comiencen a agotar el tiempo de espera y requieran que las ejecutes varias veces.
Console
Puedes borrar documentos y colecciones de la página de Cloud Firestore en la consola. Si borras un documento de la consola, se borrarán todos los datos anidados de ese documento, incluidas las subcolecciones.
Firebase CLI
También puedes usar Firebase CLI para borrar documentos y colecciones. Usa el siguiente comando para borrar datos:
firebase firestore:delete --database=DATABASE_ID PATH
Reemplaza DATABASE_ID por el ID de tu base de datos y PATH por la ruta de acceso a un documento o una colección.
Para los trabajos de eliminación grandes (millones de documentos), usa una de las siguientes opciones:
Eliminación masiva administrada
Cloud Firestore admite la eliminación masiva de uno o más grupos de colecciones. Para obtener más información, consulta Cómo borrar datos de forma masiva.
Conector de Dataflow
Puedes usar Dataflow para realizar operaciones masivas en tu base de datos. Esta opción es la más configurable, pero también requiere más ajustes que otras opciones de eliminación masiva. Consulta la entrada de blog de la introducción al conector de Cloud Firestore para Dataflow, que incluye un ejemplo de cómo borrar todos los documentos de un grupo de colecciones.