Ta strona została przetłumaczona przez Cloud Translation API.

Usuń dane z Cloud Firestore

Poniższe przykłady pokazują, jak usuwać dokumenty, pola i kolekcje.

Usuń dokumenty

Aby usunąć dokument, użyj następujących metod delete() specyficznych dla języka:

Web version 9

Użyj metody deleteDoc() :

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

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

Web version 8

Użyj metody delete() :

db.collection("cities").doc("DC").delete().then(() => {
    console.log("Document successfully deleted!");
}).catch((error) => {
    console.error("Error removing document: ", error);
});test.firestore.js

Szybki

Użyj metody delete() :

Uwaga: ten produkt nie jest dostępny w docelowych systemach watchOS i App Clip.

db.collection("cities").document("DC").delete() { err in
    if let err = err {
        print("Error removing document: \(err)")
    } else {
        print("Document successfully removed!")
    }
}ViewController.swift

Cel C

Użyj metody deleteDocumentWithCompletion: ::

Uwaga: ten produkt nie jest dostępny w docelowych systemach watchOS i App Clip.

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

Użyj metody 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

Użyj metody 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

Użyj metody delete() :

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

Jawa

Użyj metody delete() :

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

Pyton

Użyj metody delete() :

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

Python

Użyj metody delete() :

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

C++

Użyj metody 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

Użyj metody delete() :

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

Iść

Użyj metody 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

Użyj metody delete() :

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

Jedność

Użyj metody DeleteAsync() :

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

C#

Użyj metody DeleteAsync() :

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

Rubin

Użyj metody delete() :

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

Gdy usuniesz dokument, Cloud Firestore nie usuwa automatycznie dokumentów ze swoich podkolekcji. Nadal możesz uzyskać dostęp do dokumentów podzbioru przez odniesienie. Na przykład możesz uzyskać dostęp do dokumentu w ścieżce /mycoll/mydoc/mysubcoll/mysubdoc nawet jeśli usuniesz dokument nadrzędny w /mycoll/mydoc .

Nieistniejące dokumenty nadrzędne pojawiają się w konsoli , ale nie pojawiają się w wynikach zapytań i migawkach.

Jeśli chcesz usunąć dokument i wszystkie dokumenty w jego podzbiorach, musisz to zrobić ręcznie. Aby uzyskać więcej informacji, zobacz Usuwanie kolekcji .

Usuń pola

Aby usunąć określone pola z dokumentu, podczas aktualizowania dokumentu użyj następujących metod FieldValue.delete() specyficznych dla języka:

Web version 9

Użyj metody 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 version 8

Użyj metody 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

Szybki

Użyj metody FieldValue.delete() :

Uwaga: ten produkt nie jest dostępny w docelowych systemach watchOS i App Clip.

db.collection("cities").document("BJ").updateData([
    "capital": FieldValue.delete(),
]) { err in
    if let err = err {
        print("Error updating document: \(err)")
    } else {
        print("Document successfully updated")
    }
}ViewController.swift

Cel C

Użyj metody fieldValueForDelete: ::

Uwaga: ten produkt nie jest dostępny w docelowych systemach watchOS i App Clip.

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

Użyj metody 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

Użyj metody 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

Użyj metody 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

Jawa

Użyj metody 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

Pyton

Użyj metody firestore.DELETE_FIELD :

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

Python

Użyj metody firestore.DELETE_FIELD :

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

C++

Użyj metody 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

Użyj metody 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

Iść

Użyj metody 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

Użyj metody FieldValue::deleteField() :

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

Jedność

Użyj metody FieldValue.Delete :

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

C#

Użyj metody 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

Rubin

Użyj metody firestore.field_delete :

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

Usuń kolekcje

Aby usunąć całą kolekcję lub podkolekcję w Cloud Firestore, pobierz (przeczytaj) wszystkie dokumenty w kolekcji lub podkolekcji i usuń je. Ten proces wiąże się zarówno z kosztami odczytu, jak i usuwania. Jeśli masz większe kolekcje, możesz usuwać dokumenty w mniejszych partiach, aby uniknąć błędów braku pamięci. Powtarzaj ten proces, aż usuniesz całą kolekcję lub podkolekcję.

Usunięcie kolekcji wymaga skoordynowania nieograniczonej liczby indywidualnych żądań usunięcia. Jeśli chcesz usunąć całe kolekcje, zrób to tylko z zaufanego środowiska serwerowego. Chociaż możliwe jest usunięcie kolekcji z klienta mobilnego/internetowego, ma to negatywny wpływ na bezpieczeństwo i wydajność.

Poniższe fragmenty są nieco uproszczone i nie dotyczą obsługi błędów, bezpieczeństwa, usuwania podkolekcji ani maksymalizacji wydajności. Aby dowiedzieć się więcej o jednym zalecanym podejściu do usuwania kolekcji w środowisku produkcyjnym, zobacz Usuwanie kolekcji i kolekcji podrzędnych .

Sieć

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

Szybki

Uwaga: ten produkt nie jest dostępny w docelowych systemach watchOS i App Clip.

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

Cel C

Uwaga: ten produkt nie jest dostępny w docelowych systemach watchOS i App Clip.

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

Usuwanie kolekcji z klienta nie jest zalecane.

Jawa

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

Pyton

def delete_collection(coll_ref, batch_size):
    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

Iść


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

Jedność

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

Rubin

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

Usuń dane za pomocą Firebase CLI

Możesz także użyć Firebase CLI do usuwania dokumentów i kolekcji. Użyj następującego polecenia, aby usunąć dane:

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

Usuń dane za pomocą konsoli

Możesz usuwać dokumenty i kolekcje ze strony Cloud Firestore w konsoli . Usunięcie dokumentu z konsoli powoduje usunięcie wszystkich zagnieżdżonych danych w tym dokumencie, w tym wszelkich podkolekcji.

Usuń dane za pomocą zasad TTL

Polityka TTL wyznacza dane pole jako czas wygaśnięcia dokumentów w danej grupie kolekcji. Operacje usuwania TTL są wliczane do kosztów usuwania dokumentów.

Aby uzyskać informacje na temat ustawiania TTL, zobacz Zarządzanie przechowywaniem danych za pomocą zasad TTL .

Więcej informacji na temat kodów błędów i rozwiązywania problemów z opóźnieniami podczas usuwania danych można znaleźć na stronie rozwiązywania problemów .

Usuń dane za pomocą Dataflow

Dataflow to świetne narzędzie do masowych operacji na bazie danych Firestore. We wpisie wprowadzającym na blogu Firestore Connector for Dataflow znajduje się przykład usuwania wszystkich dokumentów w grupie kolekcji.