Xoá dữ liệu khỏi Cloud Firestore

Các ví dụ sau đây minh hoạ cách xoá tài liệu, trường và tập hợp.

Xoá tài liệu

Để xoá một tài liệu, hãy sử dụng các phương thức delete() dành riêng cho ngôn ngữ sau:

Web

Sử dụng phương thức deleteDoc():

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

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

Web

Sử dụng phương thức 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

Sử dụng phương thức delete():

Lưu ý: Sản phẩm này không dùng được trên các mục tiêu watchOS và App Clip.

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

Objective-C

Sử dụng phương thức deleteDocumentWithCompletion::

Lưu ý: Sản phẩm này không dùng được trên các mục tiêu watchOS và 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

Sử dụng phương thức 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

Sử dụng phương thức 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

Sử dụng phương thức delete():

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

Java

Sử dụng phương thức 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

Sử dụng phương thức delete():

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

Python

Sử dụng phương thức delete():

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

C++

Sử dụng phương thức 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

Sử dụng phương thức delete():

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

Go

Sử dụng phương thức 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

Sử dụng phương thức delete():

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

Unity

Sử dụng phương thức DeleteAsync():

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

C#

Sử dụng phương thức DeleteAsync():

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

Ruby

Sử dụng phương thức delete():

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

Cảnh báo: Việc xoá một tài liệu sẽ không xoá các bộ sưu tập con của tài liệu đó!

Khi bạn xoá một tài liệu, Cloud Firestore sẽ không tự động xoá các tài liệu trong bộ sưu tập phụ. Bạn vẫn có thể truy cập vào tài liệu của bộ sưu tập phụ theo tham chiếu. Ví dụ: bạn có thể truy cập vào tài liệu tại đường dẫn /mycoll/mydoc/mysubcoll/mysubdoc ngay cả khi xoá tài liệu cấp trên tại /mycoll/mydoc.

Các tài liệu gốc không tồn tại sẽ xuất hiện trong bảng điều khiển, nhưng không xuất hiện trong kết quả truy vấn và ảnh chụp nhanh.

Nếu muốn xoá một tài liệu và tất cả tài liệu trong bộ sưu tập phụ của tài liệu đó, bạn phải xoá theo cách thủ công. Để biết thêm thông tin, hãy xem bài viết Xoá bộ sưu tập.

Xoá trường

Để xoá các trường cụ thể khỏi tài liệu, hãy sử dụng các phương thức FieldValue.delete() dành riêng cho ngôn ngữ sau đây khi bạn cập nhật tài liệu:

Web

Sử dụng phương thức 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

Sử dụng phương thức 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

Sử dụng phương thức FieldValue.delete():

Lưu ý: Sản phẩm này không dùng được trên các mục tiêu watchOS và App Clip.

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

Sử dụng phương thức fieldValueForDelete::

Lưu ý: Sản phẩm này không dùng được trên các mục tiêu watchOS và 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

Sử dụng phương thức 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

Sử dụng phương thức 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

Sử dụng phương thức 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

Sử dụng phương thức 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

Sử dụng phương thức firestore.DELETE_FIELD:

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

Python

Sử dụng phương thức firestore.DELETE_FIELD:

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

C++

Sử dụng phương thức 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

Sử dụng phương thức 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

Sử dụng phương thức 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

Sử dụng phương thức FieldValue::deleteField():

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

Unity

Sử dụng phương thức FieldValue.Delete:

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

C#

Sử dụng phương thức 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

Sử dụng phương thức firestore.field_delete:

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

Xoá bộ sưu tập

Để xoá toàn bộ một bộ sưu tập hoặc bộ sưu tập con trong Cloud Firestore, hãy truy xuất (đọc) tất cả tài liệu trong bộ sưu tập hoặc bộ sưu tập con đó rồi xoá các tài liệu đó. Quá trình này phát sinh cả chi phí đọc và xoá. Nếu có bộ sưu tập lớn hơn, bạn nên xoá tài liệu theo lô nhỏ hơn để tránh lỗi hết bộ nhớ. Lặp lại quy trình này cho đến khi bạn xoá toàn bộ tuyển tập hoặc tuyển tập phụ.

Việc xoá một bộ sưu tập đòi hỏi phải điều phối một số lượng không giới hạn các yêu cầu xoá riêng lẻ. Nếu bạn cần xoá toàn bộ bộ sưu tập, hãy chỉ làm như vậy trong môi trường máy chủ đáng tin cậy. Mặc dù có thể xoá một bộ sưu tập khỏi ứng dụng di động/ứng dụng web, nhưng việc này sẽ ảnh hưởng tiêu cực đến hiệu suất và khả năng bảo mật.

Các đoạn mã dưới đây được đơn giản hoá và không xử lý việc xử lý lỗi, bảo mật, xoá bộ sưu tập con hoặc tối đa hoá hiệu suất. Để tìm hiểu thêm về một phương pháp đề xuất để xoá các bộ sưu tập trong phiên bản chính thức, hãy xem phần Xoá bộ sưu tập và bộ sưu tập con.

Web

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

Swift

Lưu ý: Sản phẩm này không dùng được trên các mục tiêu watchOS và App Clip.

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

Objective-C

Lưu ý: Sản phẩm này không dùng được trên các mục tiêu watchOS và 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

Bạn không nên xoá bộ sưu tập khỏi ứng dụng khách.

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

Xoá dữ liệu bằng Firebase CLI

Bạn cũng có thể sử dụng Giao diện dòng lệnh Firebase để xoá tài liệu và tập hợp. Sử dụng lệnh sau để xoá dữ liệu:

Lưu ý: Việc xoá dữ liệu bằng Firebase CLI sẽ phát sinh chi phí đọc và xoá. Để biết thêm thông tin, hãy xem phần Giá.

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

Xoá dữ liệu bằng bảng điều khiển

Bạn có thể xoá tài liệu và bộ sưu tập khỏi trang Cloud Firestore trong bảng điều khiển. Việc xoá một tài liệu khỏi bảng điều khiển sẽ xoá tất cả dữ liệu lồng nhau trong tài liệu đó, bao gồm cả mọi bộ sưu tập con.

Lưu ý: Việc xoá dữ liệu bằng Firebase CLI sẽ phát sinh chi phí đọc và xoá. Để biết thêm thông tin, hãy xem phần Giá.

Xoá dữ liệu bằng chính sách TTL

Chính sách TTL chỉ định một trường nhất định làm thời gian hết hạn cho các tài liệu trong một nhóm bộ sưu tập nhất định. Các thao tác xoá TTL được tính vào chi phí xoá tài liệu.

Để biết thông tin về cách đặt TTL, hãy xem bài viết Quản lý thời gian lưu giữ dữ liệu bằng chính sách TTL.

Để biết thêm thông tin về mã lỗi và cách khắc phục vấn đề về độ trễ khi xoá dữ liệu, hãy xem trang khắc phục sự cố.

Xoá dữ liệu bằng Dataflow

Dataflow là một công cụ tuyệt vời để thực hiện các thao tác hàng loạt trên cơ sở dữ liệu Firestore. Bài đăng trên blog về trình kết nối Firestore để giới thiệu về Dataflow có ví dụ về cách xoá tất cả tài liệu trong một nhóm bộ sưu tập.

Sử dụng tính năng xoá hàng loạt được quản lý

Cloud Firestore hỗ trợ xoá hàng loạt một hoặc nhiều nhóm bộ sưu tập. Để biết thêm thông tin, hãy xem bài viết Xoá hàng loạt dữ liệu.