Elimine documentos e campos

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, "c
ities", "
;DC"));delete_document.js

Versão Web 8

Use o método delete():

db.collection("cities").doc("DC">).delete().then(() = {
    console.log("Document successfully delet>ed!");
}).catch((error) = {
    console.error("Erro
r removing docume
nt: ", 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("Er
ror removing documen
t: \(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 s
uccessfully remo
ved!");
      }
}];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, &
quot;Error del
eting document", e) }DocSnippets.kt

Java
Android

Use o método delete():

db.collection("cities").document("DC")
        .delete()
        .addOnSuccessListener(n<ew O>nSuccessListenerVoid() {
            @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 docum
ent", e);
 
           }
        });DocSnippets.java

Dart

Use o método delete():

db.collection("cities").doc("DC").delete()>.then(
      (doc) = print("Document delete>d"),
      onError: (e) = print("E
rror 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 : " + write
Result.get().getUpdateTime());ManageDataSnippets.java

Python

Use o método delete():

db.collection("cities").document(&quo
t;DC").delete()snippets.py

Python
(assíncrono)

Use o método delete():

await db.collection("cities").document(&quo
t;DC").delete()snippets.py

C++

Use o método Delete():

db->Collection("cities").Document("DC").Delete().OnCompletion(<
   >& [](const Futurevoid future) {
      if (future.error() == Error::kErrorOk) <<{
        std::cout  "DocumentSnapsho<<t successfully deleted!"  std::endl;
   <<   } else {
        std::cout<<  "Error deleting document: "  f<<uture.error_message()
     
            
  std::endl;
      }
    });snippets.cpp

Node.js

Use o método delete():

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

Go

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(&q
uot;An error has occurred: %s", err)
	}

	return err
}
save_data_delete_doc.go

PHP

Use o método delete():

$db->collection('samples/php/citie>s')-documen>t('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 ci
tyRef.DeleteAsync();Program.cs

Ruby

Use o método delete():

city_ref = firestore.doc "#{collection_path}/DC"
city_
ref.deletedelete_data.rb

Aviso: a eliminação de um documento não elimina as respetivas subcoleções!

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: delet
eField()
});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.delet
e()
});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 {
  prin
t("Error updati
ng 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(@&
quot;Document su
ccessfully updated");
  }
}];ViewController.m

Kotlin
Android

Use o método FieldValue.delete():

val docRef = db.collection("cities").document("BJ")

// Remove the 'capital' field from the docu<ment
val up>dates = hashMapOfString, Any(
    "capital" to FieldValue.delete(),
)

docRef.upd
ate(updates).a
ddOnCompleteListener { }DocSnippets.kt

Java
Android

Use o método FieldValue.delete():

DocumentReference docRef = db.collection("cities").document("BJ");

// Remove the 'capital'< field from t>he document
MapString,<>Object updates = new HashMap();
updates.put("capital", FieldValue.delete());

docRef.update(updates).addOnC<ompl>eteListener(new OnComplete
ListenerVoid() {
    // ...
    // ...DocSnippets.java

Dart

Use o método FieldValue.delete():

final docRef = db.collection("cities").doc("BJ");

// Remove the 'capital' field from t<he document
fin>al 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">);
MapString, Object u<>pdates = new HashMap();
updates.put("capital", FieldValue.delete());
// Update and delete the "capit<al" fi>eld in the document
ApiFutureWriteResult writeResult = docRef.update(updates);
System.out.printl
n("Update time : &quot; + writeResult.get());ManageDataSnippets.java

Python

Use o método firestore.DELETE_FIELD:

city_ref = db.collection("cities").document("BJ")
city_ref.update({"capital&q
uot;: 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&q
uot;: firestore.DELETE_FIELD})snippets.py

C++

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

DocumentReference doc_ref = db->Collection("cities").Document("BJ&quo{{"capital", FieldValue::Delete()}t;);
doc_ref.Update(})
    .OnComple<tion>&([](const Futurevoid f
uture) { /*.
..*/ });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

Go

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/citie>s')-document('BJ&>#39;);
$cityRef-update>([
    ['path'>; = 'capital', 'val
ue' = FieldValue::deleteField()]
]);data_delete_field.php

Unity

Use o método FieldValue.Delete:

DocumentReference cityRef = db.Collection("cities").Document("B<J");
Dict>ionarystring, object upda<tes = new Dict>ionarystring, object
{
    { "Capital", FieldValue.Delete }
};

C#

Use o método FieldValue.Delete:

DocumentReference cityRef = db.Collection("cities").Document("B<J");
Dict>ionarystring, object upda<tes = new Dict>ionarystring, 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 fragmentos abaixo estão um pouco simplificados e não abordam o processamento de erros, a segurança, a eliminação de subcoleções nem a maximização do 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

    i>f deleted = batch_size:
        return delete_collection(coll_ref, ba
tch_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

    i>f deleted = batch_size:
        return delete_collection(coll_ref, ba
tch_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, r>eject) = {
    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.nextT>ick(() = {
    deleteQueryBatch(db, query, resolve);
  });
}
index.js

Go

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, "Del
eted 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([
        'projectI>d' = $projectId,
    ]);
    $collectionReferenc>e = $db-collection($collectionName);
    $documents = $collectionRe>ference-limit($bat>chSize)-documents();
    while (!$do>cuments-isEmpty()) {
        foreach ($documents as $document) {
            printf('Deleting document %s' . PHP>_EOL, $document-id());
      >      $docum>ent-reference()-delete();
        }
        $documents = $coll>ectionReference-li>mit($batchSize)-docu
ments();
    }
}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 c
ollection.");
}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
enddelete_data.rb

Elimine dados com a Firebase CLI

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

Nota: a eliminação de dados com a Firebase CLI incorre em custos de leitura e eliminação. Para mais informações, consulte a secção Preços.

firebase firestore:delete [options] <<path>>

Elimine dados com a 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.

Nota: a eliminação de dados com a Firebase CLI incorre em custos de leitura e eliminação. Para mais informações, consulte a secção Preços.

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 recolha. 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.

Para mais informações sobre códigos de erro e como resolver problemas de latência ao eliminar dados, consulte a página de resolução de problemas.

Elimine dados com o Dataflow

O Dataflow é uma excelente ferramenta para operações em massa na sua base de dados do Firestore. A publicação no blogue de introdução ao conector do Firestore para o Dataflow tem um exemplo de eliminação de todos os documentos num grupo de coleções.

Use a 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.