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

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

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

لحذف مستند، استخدِم طريقة 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+KTX

استخدام الطريقة 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"),
    );
جافا

استخدام الطريقة 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+KTX

استخدام الطريقة 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);
جافا

استخدام الطريقة 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+KTX

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

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)
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);
  });
}
انتقال

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

حذف البيانات باستخدام واجهة سطر الأوامر في Firebase

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

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

حذف البيانات باستخدام وحدة التحكّم

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

حذف البيانات باستخدام سياسات مدة البقاء (TTL)

تعين سياسة TTL حقلاً معينًا على أنه وقت انتهاء صلاحية المستندات في مجموعة مجموعات محددة. يتم احتساب عمليات حذف مدة البقاء (TTL) ضمن حذف المستند. للتصنيف الخاطئ.

للحصول على معلومات عن إعداد مدة البقاء، يمكنك الاطّلاع على إدارة الاحتفاظ بالبيانات باستخدام سياسات مدة البقاء.

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

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

Dataflow هي أداة رائعة للعمليات المجمّعة على قاعدة بيانات Firestore. تشير رسالة الأشكال البيانية يحتوي موصل Firestore لمقدمة Dataflow مشاركة المدونة على مثال لحذف جميع المستندات في مجموعة مجموعات.