Daten aus Cloud Firestore löschen

Die folgenden Beispiele veranschaulichen, wie Sie Dokumente, Felder und Sammlungen löschen.

Dokumente löschen

Wenn Sie ein Dokument löschen möchten, verwenden Sie eine der folgenden sprachspezifischen delete()-Methoden:

Web

Verwenden Sie die Methode deleteDoc():

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

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

Web

Verwenden Sie die Methode 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

Verwenden Sie die Methode delete():

Hinweis: Dieses Produkt nicht ist auf WatchOS- und App Clip-Zielen verfügbar.

do {
  try await db.collection("cities").document("DC").delete()
  print("Document successfully removed!")
} catch {
  print("Error removing document: \(error)")
}
ViewController.swift

Objective-C

Verwenden Sie die Methode deleteDocumentWithCompletion::

Hinweis: Dieses Produkt nicht ist auf WatchOS- und App Clip-Zielen verfügbar.

[[[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+KTX

Verwenden Sie die Methode 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

Verwenden Sie die Methode 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

Verwenden Sie die Methode delete():

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

Java

Verwenden Sie die Methode 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

Verwenden Sie die Methode delete():

db.collection("cities").document("DC").delete()
snippets.py

Python

Verwenden Sie die Methode delete():

await db.collection("cities").document("DC").delete()
snippets.py

C++

Verwenden Sie die Methode 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

Verwenden Sie die Methode delete():

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

Go

Verwenden Sie die Methode 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

Verwenden Sie die Methode delete():

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

Einheit

Verwenden Sie die Methode DeleteAsync():

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

C#

Verwenden Sie die Methode DeleteAsync():

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

Ruby

Verwenden Sie die Methode delete():

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

Warnung: Beim Löschen eines Dokuments werden nicht auch dessen untergeordnete Sammlungen gelöscht!

Wenn Sie ein Dokument löschen, löscht Cloud Firestore nicht automatisch die Dokumente in seinen untergeordneten Sammlungen. Sie können über einen Verweis weiterhin auf die untergeordnete Sammlung zugreifen. Beispielsweise können Sie auf das entsprechende Dokument auch dann noch unter dem Pfad /mycoll/mydoc/mysubcoll/mysubdoc zugreifen, wenn Sie dessen Ancestor-Dokument /mycoll/mydoc gelöscht haben.

Nicht vorhandene Ancestor-Dokumente werden in der Konsole angezeigt, erscheinen jedoch nicht in Abfrageergebnissen und Snapshots.

Wenn Sie ein Dokument und alle in dessen untergeordneten Sammlungen enthaltenen Dokumente löschen möchten, müssen Sie dies manuell tun. Weitere Informationen finden Sie unter Sammlungen löschen.

Felder löschen

Wenn Sie bestimmte Felder aus einem Dokument löschen möchten, verwenden Sie beim Aktualisieren eines Dokuments die folgenden sprachspezifischen FieldValue.delete()-Methoden:

Web

Verwenden Sie die Methode 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

Web

Verwenden Sie die Methode 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

Verwenden Sie die Methode FieldValue.delete():

Hinweis: Dieses Produkt nicht ist auf WatchOS- und App Clip-Zielen verfügbar.

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

Verwenden Sie die Methode fieldValueForDelete::

Hinweis: Dieses Produkt nicht ist auf WatchOS- und App Clip-Zielen verfügbar.

[[[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+KTX

Verwenden Sie die Methode 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

Verwenden Sie die Methode 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

Verwenden Sie die Methode 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

Verwenden Sie die Methode 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

Verwenden Sie die Methode firestore.DELETE_FIELD:

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

Python

Verwenden Sie die Methode firestore.DELETE_FIELD:

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

C++

Verwenden Sie die Methode 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

Verwenden Sie die Methode 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

Verwenden Sie die Methode 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

Verwenden Sie die Methode FieldValue::deleteField():

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

Einheit

Verwenden Sie die Methode FieldValue.Delete:

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

C#

Verwenden Sie die Methode 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

Verwenden Sie die Methode firestore.field_delete:

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

Sammlungen löschen

Wenn Sie die gesamte Sammlung oder eine untergeordnete Sammlung in Cloud Firestore löschen möchten, rufen Sie alle Dokumente in der Sammlung oder untergeordneten Sammlung ab und löschen Sie sie. Für diesen Vorgang fallen sowohl Kosten für Lese- als auch Löschvorgänge an. Bei größeren Sammlungen sollten Sie die Dokumente in kleineren Batches löschen, um Fehler aufgrund fehlenden Arbeitsspeichers zu vermeiden. Wiederholen Sie den Vorgang, bis Sie die gesamte Sammlung oder untergeordnete Sammlung gelöscht haben.

Zum Löschen einer Sammlung muss eine unbegrenzte Anzahl einzelner Löschanfragen koordiniert werden. Wenn Sie ganze Sammlungen löschen möchten, tun Sie dies nur von einer vertrauenswürdigen Serverumgebung aus. Es ist zwar möglich, eine Sammlung von einem Mobil-/Web-Client aus zu löschen, dies hat jedoch negative Auswirkungen auf Sicherheit und Leistung.

Die folgenden Snippets sind etwas vereinfacht und behandeln nicht die Themen Fehlerbehandlung, Sicherheit, das Löschen untergeordneter Sammlungen oder das Maximieren der Leistung. Weitere Informationen zu einem empfohlenen Ansatz zum Löschen von Sammlungen in der Produktion finden Sie unter Sammlungen und untergeordnete Sammlungen löschen.

Web

// Deleting collections from a Web client is not recommended.

Swift

Hinweis: Dieses Produkt nicht ist auf WatchOS- und App Clip-Zielen verfügbar.

// Deleting collections from an Apple client is not recommended.

Objective-C

Hinweis: Dieses Produkt nicht ist auf WatchOS- und App Clip-Zielen verfügbar.

// 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

Es wird nicht empfohlen, Sammlungen aus dem Client zu löschen.

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

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

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, "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

Daten mit dem Firebase CLI löschen

Sie können Dokumente und Sammlungen auch mithilfe des Firebase CLI löschen. Verwenden Sie den folgenden Befehl, um Daten zu löschen:

Hinweis: Das Löschen von Daten mit der Firebase CLI verursacht Lese- und Löschkosten. Weitere Informationen finden Sie unter Preise.

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

Daten mit der Konsole löschen

Sie können Dokumente und Sammlungen in der Konsole auf der Seite Cloud Firestore löschen. Wenn Sie ein Dokument aus der Konsole löschen, werden alle verschachtelten Daten in diesem Dokument gelöscht, einschließlich aller untergeordneten Sammlungen.

Hinweis: Das Löschen von Daten mit der Firebase CLI verursacht Lese- und Löschkosten. Weitere Informationen finden Sie unter Preise.

Daten mit TTL-Richtlinien löschen

In einer TTL-Richtlinie wird ein bestimmtes Feld als Ablaufzeit für Dokumente in einer bestimmten Sammlungsgruppe festgelegt. TTL-Löschvorgänge werden auf Ihre Kosten für das Löschen von Dokumenten angerechnet.

Informationen zum Festlegen der TTL finden Sie unter Datenerhaltung mit TTL-Richtlinien verwalten.

Weitere Informationen zu Fehlercodes und zum Beheben von Latenzproblemen beim Löschen von Daten finden Sie auf der Seite zur Fehlerbehebung.

Daten mit Dataflow löschen

Dataflow ist ein hervorragendes Tool für Bulk-Vorgänge in Ihrer Firestore-Datenbank. Der Blogpost zur Einführung des Firestore-Connectors für Dataflow enthält ein Beispiel für das Löschen aller Dokumente in einer Sammlungsgruppe.

Verwaltetes Löschen von mehreren Elementen verwenden

Cloud Firestore unterstützt das Löschen mehrerer Sammlungsgruppen gleichzeitig. Weitere Informationen finden Sie unter Mehrere Datensätze gleichzeitig löschen.