حذف البيانات من Cloud Firestore

توضّح الأمثلة التالية كيفية حذف المستندات والحقول والمجموعات.

للحصول على مساعدة من الذكاء الاصطناعي، انسخ الطلب أدناه إلى وكيل الترميز بالذكاء الاصطناعي (مثل Gemini في "استوديو Android" وAntigravity وClaude Code وCodex وCursor). يمكنك تخصيص الطلب وتكراره مع الوكيل. انتقِل إلى مهارات وكلاء Firebase للحصول على معلومات مفصّلة عن التثبيت.

Help me use Firebase in my app.
1. Make sure that **Firebase agent skills** are installed and updated. For Claude Code, Codex, or Cursor agents, help me install the Firebase plugin. For other agents, run `npx skills add firebase/agent-skills`. Always try to use **Firebase agent skills** for Firebase-related tasks.
2. Help me delete documents, fields, and collections from Cloud Firestore in my app.

حذف المستندات

لحذف مستند، استخدِم طرق delete() التالية الخاصة باللغة:

Web

استخدِم طريقة deleteDoc():

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

await deleteDoc(doc(db, "cities", "DC"));

Web

استخدِم طريقة delete():

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

استخدِم طريقة delete():

ملاحظة: لا يتوفّر هذا المنتج على watchOS وأهداف App Clip.
do {
  try await db.collection("cities").document("DC").delete()
  print("Document successfully removed!")
} catch {
  print("Error removing document: \(error)")
}
Objective-C

استخدِم طريقة 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!");
      }
}];

Kotlin

استخدِم طريقة delete():

db.collection("cities").document("DC")
    .delete()
    .addOnSuccessListener { Log.d(TAG, "DocumentSnapshot successfully deleted!") }
    .addOnFailureListener { e -> Log.w(TAG, "Error deleting document", e) }

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);
            }
        });

Dart

استخدِم طريقة delete():

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

استخدِم طريقة delete():

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

استخدِم طريقة delete():

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

Python

استخدِم طريقة delete():

await db.collection("cities").document("DC").delete()
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;
      }
    });
Node.js

استخدِم طريقة delete():

const res = await db.collection('cities').doc('DC').delete();
متابعة

استخدِم طريقة 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
}
PHP

استخدِم طريقة delete():

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

استخدِم طريقة DeleteAsync():

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

استخدِم طريقة DeleteAsync():

DocumentReference cityRef = db.Collection("cities").Document("DC");
await cityRef.DeleteAsync();
لغة Ruby

استخدِم طريقة delete():

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

عند حذف مستند، لا يحذف Cloud Firestore تلقائيًا المستندات ضمن مجموعاته الفرعية. سيظل بإمكانك الوصول إلى مستندات المجموعة الفرعية حسب المرجع. على سبيل المثال، يمكنك الوصول إلى المستند في المسار /mycoll/mydoc/mysubcoll/mysubdoc حتى إذا حذفت المستند الرئيسي في /mycoll/mydoc.

تظهر المستندات الرئيسية غير الموجودة في وحدة التحكّم، ولكنّها لا تظهر في نتائج طلبات البحث واللقطات.

إذا أردت حذف مستند وجميع المستندات ضمن مجموعاته الفرعية، عليك إجراء ذلك يدويًا. لمزيد من المعلومات، يُرجى الاطّلاع على مقالة حذف المجموعات.

حذف الحقول

لحذف حقول معيّنة من مستند، استخدِم طرق 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()
});

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()
});
Swift

استخدِم طريقة 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)")
}
Objective-C

استخدِم طريقة 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");
  }
}];

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 { }

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>() {
    // ...
    // ...

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);
Java

استخدِم طريقة 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());
Python

استخدِم طريقة firestore.DELETE_FIELD:

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

Python

استخدِم طريقة firestore.DELETE_FIELD:

city_ref = db.collection("cities").document("BJ")
await city_ref.update({"capital": firestore.DELETE_FIELD})
C++‎

استخدِم طريقة FieldValue::Delete():

DocumentReference doc_ref = db->Collection("cities").Document("BJ");
doc_ref.Update({{"capital", FieldValue::Delete()}})
    .OnCompletion([](const Future<void>& future) { /*...*/ });
Node.js

استخدِم طريقة 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()
});
متابعة

استخدِم طريقة 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
}
PHP

استخدِم طريقة FieldValue::deleteField():

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

استخدِم طريقة FieldValue.Delete:

DocumentReference cityRef = db.Collection("cities").Document("BJ");
Dictionary<string, object> updates = new Dictionary<string, object>
{
    { "Capital", FieldValue.Delete }
};
#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);
لغة Ruby

استخدِم طريقة firestore.field_delete:

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

حذف المجموعات

لحذف مجموعة أو مجموعة فرعية كاملة في Cloud Firestore، يجب استرداد (قراءة) جميع المستندات ضمن المجموعة أو المجموعة الفرعية وحذفها. تؤدي هذه العملية إلى تحمُّل تكاليف القراءة والحذف. إذا كانت لديك مجموعات أكبر، قد تحتاج إلى حذف المستندات في مجموعات أصغر لتجنُّب أخطاء نفاد الذاكرة. كرِّر العملية إلى أن تحذف المجموعة أو المجموعة الفرعية بالكامل.

يتطلب حذف مجموعة تنسيق عدد غير محدود من طلبات الحذف الفردية. إذا كنت بحاجة إلى حذف مجموعات كاملة، يمكنك إجراء ذلك فقط من بيئة خادم موثوق بها. على الرغم من إمكانية حذف مجموعة من عميل ويب أو عميل على الأجهزة الجوّالة، فإنّ ذلك يؤدي إلى آثار سلبية على الأمان والأداء.

تم تبسيط المقتطفات التالية للإيضاح، وهي لا تتضمّن معالجة الأخطاء أو الأمان أو حذف المجموعات الفرعية أو تحسينات الأداء. لمزيد من المعلومات حول إحدى الطرق المقترَحة لحذف المجموعات في مرحلة الإنتاج، يُرجى الاطّلاع على حذف المجموعات والمجموعات الفرعية.

الويب
// Deleting collections from a Web client is not recommended.
Swift
ملاحظة: لا يتوفّر هذا المنتج على watchOS وأهداف App Clip.
// Deleting collections from an Apple client is not recommended.
Objective-C
ملاحظة: لا يتوفّر هذا المنتج على 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

لا يُنصح بحذف المجموعات من العميل.

Java

import com.google.api.core.ApiFuture;
import com.google.cloud.firestore.CollectionReference;
import com.google.cloud.firestore.Firestore;
import com.google.cloud.firestore.FirestoreOptions;

public class DeleteCollection {

  /**
   * Delete a collection and all its subcollections.
   *
   * @param projectId The Google Cloud project ID
   * @param collectionName The name of the collection to delete
   */
  public static void deleteCollection(String projectId, String collectionName) throws Exception {
    FirestoreOptions firestoreOptions =
        FirestoreOptions.getDefaultInstance().toBuilder().setProjectId(projectId).build();
    try (Firestore db = firestoreOptions.getService()) {
      CollectionReference collection = db.collection(collectionName);

      ApiFuture<Void> future = db.recursiveDelete(collection);

      future.get();
      System.out.println("Collection and all its subcollections deleted successfully.");
    }
  }

  public static void main(String[] args) throws Exception {
    String projectId = "example-project-id";
    String collectionName = "example-collection-name";

    deleteCollection(projectId, collectionName);
  }
}
Python
def delete_collection(coll_ref):

    print(f"Recursively deleting collection: {coll_ref}")
    db.recursive_delete(coll_ref)

Python

async def delete_collection(coll_ref):

    await db.recursive_delete(coll_ref)
C++‎
// This is not supported. Delete data using CLI as discussed below.
  
Node.js
async function deleteCollection(db, collectionPath) {
  const collectionRef = db.collection(collectionPath);
  return await db.recursiveDelete(collectionRef);
}
متابعة

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
}
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();
    }
}
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.");
}
لغة 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

حذف البيانات باستخدام سياسات TTL

تحدّد سياسة TTL حقلاً معيّنًا كوقت انتهاء صلاحية المستندات في مجموعة معيّنة. يتم احتساب عمليات الحذف التي تتم من خلال TTL ضمن تكاليف حذف المستندات.

للحصول على معلومات حول ضبط TTL، يُرجى الاطّلاع على إدارة الاحتفاظ بالبيانات باستخدام سياسات TTL.

مهام الحذف المجمّع

يتيح Cloud Firestore استخدام عدة أدوات للحذف المجمّع. يجب اختيار أداة بناءً على عدد المستندات التي تريد حذفها ومستوى إمكانية الضبط الذي تحتاجه.

بالنسبة إلى المهام الأصغر حجمًا التي تتضمّن آلاف المستندات، يمكنك استخدام وحدة التحكّم أو واجهة سطر أوامر Firebase. بالنسبة إلى المهام الأكبر حجمًا، قد تبدأ هذه الأدوات في انتهاء المهلة وتتطلب منك تشغيل الأداة عدة مرات.

وحدة التحكم

يمكنك حذف المستندات والمجموعات من صفحة Cloud Firestore في وحدة التحكّم. يؤدي حذف مستند من وحدة التحكّم إلى حذف جميع البيانات المدمجة في هذا المستند، بما في ذلك أي مجموعات فرعية.

Firebase CLI

يمكنك أيضًا استخدام Firebase CLI لحذف المستندات والمجموعات. استخدِم الأمر التالي لحذف البيانات:

firebase firestore:delete  --database=DATABASE_ID PATH

استبدِل DATABASE_ID بمعرّف قاعدة البيانات وPATH بمسار إلى مستند أو مجموعة.

بالنسبة إلى مهام الحذف الكبيرة (ملايين المستندات)، استخدِم أحد الخيارات التالية:

الحذف المجمّع المُدار

يتيح Cloud Firestore حذف مجموعة واحدة أو أكثر من مجموعات المجموعات بشكل مجمّع. لمزيد من المعلومات، يُرجى الاطّلاع على حذف البيانات بشكل مجمّع.

موصل Dataflow

يمكنك استخدام Dataflow للعمليات المجمّعة على قاعدة بياناتك. هذا الخيار هو الأكثر قابلية للضبط، ولكنه يتطلب أيضًا إعدادًا أكثر من خيارات الحذف المجمّع الأخرى. يمكنك الاطّلاع على منشور المدوّنة حول مقدّمة عن موصّل Dataflow Cloud Firestore الذي يتضمّن مثالاً على حذف جميع المستندات في مجموعة.