Elimine documentos e campos

Os exemplos seguintes demonstram como eliminar documentos, campos e coleções.

Elimine documentos

Para eliminar um documento, use os seguintes delete() métodos específicos do idioma:

Versão Web 9

Use o método deleteDoc():

import { doc, deleteDoc } from "firebase/firestore";

await deleteDoc(doc(db, "cities", "DC"));
delete_document.js

Versão Web 8

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);
});
test.firestore.js
Swift

Use o método delete():

Nota: este produto não está disponível em alvos do watchOS e de App Clips. 
do {
  try await db.collection("cities").document("DC").delete()
  print("Document successfully removed!")
} catch {
  print("Error removing document: \(error)")
}
ViewController.swift
Objective-C

Use o método deleteDocumentWithCompletion::

Nota: este produto não está disponível em alvos do watchOS e de App Clips. 
[[[self.db collectionWithPath:@"cities"] documentWithPath:@"DC"]
    deleteDocumentWithCompletion:^(NSError * _Nullable error) {
      if (error != nil) {
        NSLog(@"Error removing document: %@", error);
      } else {
        NSLog(@"Document successfully removed!");
      }
}];
ViewController.m
Kotlin
Android

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) }
DocSnippets.kt
Java
Android

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);
            }
        });
DocSnippets.java

Dart

Use o método delete():

db.collection("cities").doc("DC").delete().then(
      (doc) => print("Document deleted"),
      onError: (e) => print("Error updating document $e"),
    );
firestore.dart
Java

Use o método delete():

// asynchronously delete a document
ApiFuture<WriteResult> writeResult = db.collection("cities").document("DC").delete();
// ...
System.out.println("Update time : " + writeResult.get().getUpdateTime());
ManageDataSnippets.java
Python

Use o método delete():

db.collection("cities").document("DC").delete()
snippets.py
Python
(assíncrono)

Use o método delete():

await db.collection("cities").document("DC").delete()
snippets.py
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;
      }
    });
snippets.cpp
Node.js

Use o método delete():

const res = await db.collection('cities').doc('DC').delete();
index.js
Ir

Use o método Delete():


import (
	"context"
	"log"

	"cloud.google.com/go/firestore"
)

func deleteDoc(ctx context.Context, client *firestore.Client) error {
	_, 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)
	}

	return err
}

save_data_delete_doc.go
PHP

Use o método delete():

$db->collection('samples/php/cities')->document('DC')->delete();
data_delete_doc.php
Unity

Use o método DeleteAsync():

DocumentReference cityRef = db.Collection("cities").Document("DC");
cityRef.DeleteAsync();
C#

Use o método DeleteAsync():

DocumentReference cityRef = db.Collection("cities").Document("DC");
await cityRef.DeleteAsync();
Program.cs
Ruby

Use o método delete():

city_ref = firestore.doc "#{collection_path}/DC"
city_ref.delete
delete_data.rb

Quando elimina um documento, o Firestore não elimina automaticamente os documentos nas respetivas subcoleções. Continua a poder aceder aos documentos da subcoleção por referência. Por exemplo, pode aceder ao documento no caminho /mycoll/mydoc/mysubcoll/mysubdoc mesmo que elimine o documento principal em /mycoll/mydoc.

Os documentos antecessores inexistentes aparecem na consola, mas não aparecem nos resultados das consultas nem nas capturas instantâneas.

Se quiser eliminar um documento e todos os documentos nas respetivas subcoleções, tem de o fazer manualmente. Para mais informações, consulte o artigo Elimine coleções.

Elimine campos

Para eliminar campos específicos de um documento, use os seguintes métodos FieldValue.delete() específicos do idioma quando atualiza um documento:

Versão Web 9

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()
});
update_delete_field.js

Versão Web 8

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()
});
test.firestore.js
Swift

Use o método FieldValue.delete():

Nota: este produto não está disponível em alvos do watchOS e de App Clips. 
do {

  try await db.collection("cities").document("BJ").updateData([
    "capital": FieldValue.delete(),
  ])
  print("Document successfully updated")
} catch {
  print("Error updating document: \(error)")
}
ViewController.swift
Objective-C

Use o método fieldValueForDelete::

Nota: este produto não está disponível em alvos do watchOS e de App Clips. 
[[[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");
  }
}];
ViewController.m
Kotlin
Android

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 { }
DocSnippets.kt
Java
Android

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>() {
    // ...
    // ...
DocSnippets.java

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);
firestore.dart
Java

Use o método FieldValue.delete():

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());
ManageDataSnippets.java
Python

Use o método firestore.DELETE_FIELD:

city_ref = db.collection("cities").document("BJ")
city_ref.update({"capital": firestore.DELETE_FIELD})
snippets.py
Python
(assíncrono)

Use o método firestore.DELETE_FIELD:

city_ref = db.collection("cities").document("BJ")
await city_ref.update({"capital": firestore.DELETE_FIELD})
snippets.py
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) { /*...*/ });
snippets.cpp
Node.js

Use o método FieldValue.delete():

// 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()
});
index.js
Ir

Use o método firestore.Delete:


import (
	"context"
	"log"

	"cloud.google.com/go/firestore"
)

func deleteField(ctx context.Context, client *firestore.Client) error {
	_, 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)
	}

	// ...
	return err
}

save_data_delete_field.go
PHP

Use o método FieldValue::deleteField():

$cityRef = $db->collection('samples/php/cities')->document('BJ');
$cityRef->update([
    ['path' => 'capital', 'value' => FieldValue::deleteField()]
]);
data_delete_field.php
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:

DocumentReference cityRef = db.Collection("cities").Document("BJ");
Dictionary<string, object> updates = new Dictionary<string, object>
{
    { "Capital", FieldValue.Delete }
};
await cityRef.UpdateAsync(updates);
Program.cs
Ruby

Use o método firestore.field_delete:

city_ref = firestore.doc "#{collection_path}/BJ"
city_ref.update({ capital: firestore.field_delete })
delete_data.rb

Elimine coleções

Para eliminar uma coleção ou uma subcoleção inteira no Firestore, obtenha (leia) todos os documentos na coleção ou subcoleção e elimine-os. Este processo incorre em custos de leitura e eliminação. Se tiver coleções maiores, recomendamos que elimine os documentos em lotes mais pequenos para evitar erros de falta de memória. Repita o processo até eliminar toda a coleção ou subcoleção.

A eliminação de uma coleção requer a coordenação de um número ilimitado de pedidos de eliminação individuais. Se precisar de eliminar coleções inteiras, faça-o apenas a partir de um ambiente de servidor fidedigno. Embora seja possível eliminar uma recolha de um cliente Web/para dispositivos móveis, esta ação tem implicações negativas para a segurança e o desempenho.

Os seguintes fragmentos são simplificados para maior clareza e não incluem o processamento de erros, a segurança, a eliminação de subcoleções nem as otimizações de desempenho. Para saber mais acerca de uma abordagem recomendada para eliminar coleções em produção, consulte Eliminar coleções e subcoleções.

Web 
// Deleting collections from a Web client is not recommended.
Swift
Nota: este produto não está disponível em alvos do watchOS e de App Clips. 
// Deleting collections from an Apple client is not recommended.
Objective-C
Nota: este produto não está disponível em alvos do watchOS e de App Clips. 
// Deleting collections from an Apple client is not recommended.
Kotlin
Android
// Deleting collections from an Android client is not recommended.
Java
Android
// Deleting collections from an Android client is not recommended.

Dart

Não é recomendado eliminar coleções do cliente.

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());
  }
}

ManageDataSnippets.java
Python
def delete_collection(coll_ref, batch_size):
    if batch_size == 0:
        return

    docs = coll_ref.list_documents(page_size=batch_size)
    deleted = 0

    for doc in docs:
        print(f"Deleting doc {doc.id} => {doc.get().to_dict()}")
        doc.delete()
        deleted = deleted + 1

    if deleted >= batch_size:
        return delete_collection(coll_ref, batch_size)

snippets.py
Python
(assíncrono)
async def delete_collection(coll_ref, batch_size):
    docs = coll_ref.limit(batch_size).stream()
    deleted = 0

    async for doc in docs:
        print(f"Deleting doc {doc.id} => {doc.to_dict()}")
        await doc.reference.delete()
        deleted = deleted + 1

    if deleted >= batch_size:
        return delete_collection(coll_ref, batch_size)

snippets.py
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);
  });
}

index.js
Ir

import (
	"context"
	"fmt"
	"io"

	"cloud.google.com/go/firestore"
	"google.golang.org/api/iterator"
)

func deleteCollection(w io.Writer, projectID, collectionName string,
	batchSize int) error {

	// Instantiate a client
	ctx := context.Background()
	client, err := firestore.NewClient(ctx, projectID)
	if err != nil {
		return err
	}

	col := client.Collection(collectionName)
	bulkwriter := client.BulkWriter(ctx)

	for {
		// Get a batch of documents
		iter := col.Limit(batchSize).Documents(ctx)
		numDeleted := 0

		// Iterate through the documents, adding
		// a delete operation for each one to the BulkWriter.
		for {
			doc, err := iter.Next()
			if err == iterator.Done {
				break
			}
			if err != nil {
				return err
			}

			bulkwriter.Delete(doc.Ref)
			numDeleted++
		}

		// If there are no documents to delete,
		// the process is over.
		if numDeleted == 0 {
			bulkwriter.End()
			break
		}

		bulkwriter.Flush()
	}
	fmt.Fprintf(w, "Deleted collection \"%s\"", collectionName)
	return nil
}

save_data_delete_collection.go
PHP
function data_delete_collection(string $projectId, string $collectionName, int $batchSize)
{
    // Create the Cloud Firestore client
    $db = new FirestoreClient([
        'projectId' => $projectId,
    ]);
    $collectionReference = $db->collection($collectionName);
    $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();
    }
}
data_delete_collection.php
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.");
}
Program.cs
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
delete_data.rb

Elimine dados com políticas de TTL

Uma política de TTL designa um determinado campo como o tempo de validade dos documentos num determinado grupo de coleções. As operações de eliminação de TTL contam para os custos de eliminação de documentos.

Para obter informações sobre a definição do TTL, consulte o artigo Faça a gestão da retenção de dados com políticas de TTL.

Tarefas de eliminação em massa

O Firestore suporta várias ferramentas para a eliminação em massa. Deve selecionar uma ferramenta com base no número de documentos que precisa de eliminar e no nível de configurabilidade de que precisa.

Para tarefas mais pequenas de milhares de documentos, use a consola ou a Firebase CLI. Para tarefas maiores, estas ferramentas podem começar a exceder o limite de tempo e exigir que as execute várias vezes.

Consola

Pode eliminar documentos e coleções da página do Firestore na consola. A eliminação de um documento da consola elimina todos os dados aninhados nesse documento, incluindo quaisquer subcoleções.

Firebase CLI

Também pode usar a Firebase CLI para eliminar documentos e coleções. Use o seguinte comando para eliminar dados:

firebase firestore:delete  --database=DATABASE_ID PATH

Substitua DATABASE_ID pelo ID da base de dados e PATH por um caminho para um documento ou uma coleção.

Para tarefas de eliminação grandes (milhões de documentos), use uma das seguintes opções:

Eliminação em massa gerida

O Firestore suporta a eliminação em massa de um ou mais grupos de coleções. Para mais informações, consulte o artigo Elimine dados em massa.

Conetor do Dataflow

Pode usar o Dataflow para operações em massa na sua base de dados. Esta opção é a mais configurável, mas também requer mais configuração do que outras opções de eliminação em massa. Consulte a publicação no blogue sobre a introdução ao Dataflow, que tem um exemplo de eliminação de todos os documentos num grupo de coleções.