اطلاعات را از Cloud Firestore حذف کنید

مثال‌های زیر نحوه حذف اسناد، فیلدها و مجموعه‌ها را نشان می‌دهند.

حذف اسناد

برای حذف یک سند، از متدهای delete() مخصوص زبان زیر استفاده کنید:

Web

از متد deleteDoc() استفاده کنید:

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

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

Web

از متد delete() استفاده کنید:

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

از متد delete() استفاده کنید:

توجه: این محصول در watchOS و App Clip موجود نیست. 
do {
  try await db.collection("cities").document("DC").delete()
  print("Document successfully removed!")
} catch {
  print("Error removing document: \(error)")
}
ViewController.swift
هدف-سی

از متد deleteDocumentWithCompletion: استفاده کنید:

توجه: این محصول در watchOS و 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

از متد 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

از متد 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

از متد delete() استفاده کنید:

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

از متد delete() استفاده کنید: 

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

از متد delete() استفاده کنید: 

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

Python

از متد delete() استفاده کنید: 

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

از متد 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
نود جی اس

از متد delete() استفاده کنید: 

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

از متد 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
پی اچ پی

از متد delete() استفاده کنید: 

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

از متد DeleteAsync() استفاده کنید: 

DocumentReference cityRef = db.Collection("cities").Document("DC");
cityRef.DeleteAsync();
سی شارپ

از متد DeleteAsync() استفاده کنید: 

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

از متد delete() استفاده کنید: 

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

وقتی یک سند را حذف می‌کنید، Cloud Firestore به طور خودکار اسناد درون زیرمجموعه‌های آن را حذف نمی‌کند. شما همچنان می‌توانید از طریق ارجاع به اسناد زیرمجموعه دسترسی داشته باشید. به عنوان مثال، حتی اگر سند جد را در /mycoll/mydoc حذف کنید، می‌توانید به سند در مسیر /mycoll/mydoc/mysubcoll/mysubdoc دسترسی داشته باشید.

اسناد اجدادی که وجود ندارند در کنسول ظاهر می‌شوند ، اما در نتایج پرس‌وجو و اسنپ‌شات‌ها نمایش داده نمی‌شوند.

اگر می‌خواهید یک سند و تمام اسناد درون زیرمجموعه‌های آن را حذف کنید، باید این کار را به صورت دستی انجام دهید. برای اطلاعات بیشتر، به بخش «حذف مجموعه‌ها» مراجعه کنید.

حذف فیلدها

برای حذف فیلدهای خاص از یک سند، هنگام به‌روزرسانی سند، از متدهای FieldValue.delete() مختص زبان زیر استفاده کنید:

Web

از متد 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

از متد 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
سویفت

از متد FieldValue.delete() استفاده کنید:

توجه: این محصول در watchOS و 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
هدف-سی

از متد fieldValueForDelete: استفاده کنید:

توجه: این محصول در watchOS و 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

از متد 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

از متد 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

از متد 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
جاوا

از متد 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
پایتون

از متد firestore.DELETE_FIELD استفاده کنید: 

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

Python

از متد firestore.DELETE_FIELD استفاده کنید: 

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

از متد FieldValue::Delete() استفاده کنید: 

DocumentReference doc_ref = db->Collection("cities").Document("BJ");
doc_ref.Update({{"capital", FieldValue::Delete()}})
    .OnCompletion([](const Future<void>& future) { /*...*/ });
snippets.cpp
نود جی اس

از متد 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
برو

از متد 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
پی اچ پی

از متد FieldValue::deleteField() استفاده کنید: 

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

از متد FieldValue.Delete استفاده کنید: 

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

از متد 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
روبی

از متد firestore.field_delete استفاده کنید: 

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

حذف مجموعه‌ها

برای حذف کل یک مجموعه یا زیرمجموع در Cloud Firestore ، تمام اسناد موجود در مجموعه یا زیرمجموع را بازیابی (بخوانید) و آنها را حذف کنید. این فرآیند شامل هزینه‌های خواندن و حذف می‌شود. اگر مجموعه‌های بزرگتری دارید، ممکن است بخواهید اسناد را در دسته‌های کوچکتر حذف کنید تا از خطاهای کمبود حافظه جلوگیری شود. این فرآیند را تا زمانی که کل مجموعه یا زیرمجموع را حذف کنید، تکرار کنید.

حذف یک مجموعه نیاز به هماهنگی تعداد نامحدودی از درخواست‌های حذف جداگانه دارد. اگر نیاز به حذف کل مجموعه‌ها دارید، این کار را فقط از یک محیط سرور قابل اعتماد انجام دهید. اگرچه حذف یک مجموعه از طریق یک کلاینت موبایل/وب امکان‌پذیر است، اما انجام این کار پیامدهای امنیتی و عملکردی منفی دارد.

قطعه کدهای زیر برای وضوح بیشتر ساده‌سازی شده‌اند و شامل مدیریت خطا، امنیت، حذف زیرمجموعه‌ها یا بهینه‌سازی عملکرد نمی‌شوند. برای کسب اطلاعات بیشتر در مورد یک رویکرد پیشنهادی برای حذف مجموعه‌ها در محیط عملیاتی، به بخش «حذف مجموعه‌ها و زیرمجموعه‌ها» مراجعه کنید.

وب 
// Deleting collections from a Web client is not recommended.
سویفت
توجه: این محصول در watchOS و App Clip موجود نیست. 
// Deleting collections from an Apple client is not recommended.
هدف-سی
توجه: این محصول در watchOS و App Clip موجود نیست. 
// Deleting collections from an Apple client is not recommended.

Kotlin 

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

Java 

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

Dart

حذف مجموعه‌ها از کلاینت توصیه نمی‌شود.

جاوا 
/**
 * 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
پایتون 
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
سی++ 
// This is not supported. Delete data using CLI as discussed below.
نود جی اس 
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
برو 

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
پی اچ پی 
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
وحدت 
// This is not supported. Delete data using CLI as discussed below.
سی شارپ 
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
روبی 
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

حذف داده‌ها با سیاست‌های TTL

یک سیاست TTL، یک فیلد مشخص را به عنوان زمان انقضا برای اسناد در یک گروه جمع‌آوری مشخص تعیین می‌کند. عملیات حذف TTL در هزینه‌های حذف سند شما محاسبه می‌شود.

برای اطلاعات بیشتر در مورد تنظیم TTL، به مدیریت نگهداری داده‌ها با سیاست‌های TTL مراجعه کنید.

کارهای حذف دسته جمعی

Cloud Firestore از ابزارهای مختلفی برای حذف دسته‌ای پشتیبانی می‌کند. شما باید ابزاری را بر اساس تعداد اسنادی که باید حذف کنید و سطح قابلیت پیکربندی مورد نیاز خود انتخاب کنید.

برای کارهای کوچک‌تر شامل هزاران سند، از کنسول یا Firebase CLI استفاده کنید. برای کارهای بزرگ‌تر، این ابزارها ممکن است دچار وقفه زمانی شوند و لازم باشد ابزار را چندین بار اجرا کنید.

کنسول

شما می‌توانید اسناد و مجموعه‌ها را از صفحه Cloud Firestore در کنسول حذف کنید . حذف یک سند از کنسول، تمام داده‌های تو در تو در آن سند، از جمله هر زیرمجموعه‌ای را حذف می‌کند.

رابط خط فرمان فایربیس

همچنین می‌توانید از رابط خط فرمان فایربیس (Firebase CLI) برای حذف اسناد و مجموعه‌ها استفاده کنید. برای حذف داده‌ها از دستور زیر استفاده کنید:

firebase firestore:delete  --database=DATABASE_ID PATH

به جای DATABASE_ID شناسه پایگاه داده خود و به جای PATH ، مسیر سند یا مجموعه را وارد کنید.

برای کارهای حذف بزرگ (میلیون‌ها سند)، از یکی از موارد زیر استفاده کنید:

حذف انبوه مدیریت‌شده

Cloud Firestore از حذف دسته جمعی یک یا چند گروه جمع‌آوری پشتیبانی می‌کند. برای اطلاعات بیشتر، به حذف دسته جمعی داده‌ها مراجعه کنید.

کانکتور جریان داده

شما می‌توانید از Dataflow برای عملیات گروهی روی پایگاه داده خود استفاده کنید. این گزینه بیشترین قابلیت پیکربندی را دارد، اما نسبت به سایر گزینه‌های حذف گروهی به تنظیمات بیشتری نیاز دارد. به پست وبلاگ معرفی Dataflow در بخش کانکتور Cloud Firestore مراجعه کنید که مثالی از حذف همه اسناد در یک گروه مجموعه دارد.