حذف البيانات من 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

Swift

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

ملاحظة: لا يتوفّر هذا المنتج على watchOS واستهدافات "مقاطع التطبيقات".

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

Objective-C

استخدِم طريقة deleteDocumentWithCompletion::

ملاحظة: لا يتوفّر هذا المنتج على watchOS واستهدافات "مقاطع التطبيقات".

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

Java

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

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

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

Python

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

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

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

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

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

Go

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

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

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

Unity

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

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

#C

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

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

لغة Ruby

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

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

تحذير: لا يؤدي حذف مستند إلى حذف مجموعاته الفرعية.

عند حذف مستند، لا تحذف 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()
});
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

Swift

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

ملاحظة: لا يتوفّر هذا المنتج على watchOS واستهدافات "مقاطع التطبيقات".

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

استخدِم طريقة fieldValueForDelete::

ملاحظة: لا يتوفّر هذا المنتج على watchOS واستهدافات "مقاطع التطبيقات".

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

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());
ManageDataSnippets.java

Python

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

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

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

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

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

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

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);
Program.cs

لغة Ruby

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

Swift

ملاحظة: لا يتوفّر هذا المنتج على watchOS واستهدافات "مقاطع التطبيقات".

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

Objective-C

ملاحظة: لا يتوفّر هذا المنتج على watchOS واستهدافات "مقاطع التطبيقات".

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

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

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

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

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

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

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

ملاحظة: يمكن أن يؤدي حذف عدد كبير من المستندات إلى التأثير في وقت الاستجابة. إذا كان سبب التأخير هو عمليات حذف حديثة كثيرة، من المفترض أن يتم حل المشكلة تلقائيًا بعد مرور بعض الوقت. إذا لم يتم حلّ المشكلة، يُرجى التواصل مع فريق الدعم.

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

وحدة التحكم

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

Firebase CLI

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

ملاحظة: يؤدي حذف البيانات باستخدام واجهة سطر الأوامر (CLI) في Firebase إلى تكبُّد تكاليف القراءة والحذف. لمزيد من المعلومات، يُرجى الاطّلاع على الأسعار.

firebase firestore:delete  --database=DATABASE_ID PATH

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

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

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

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

أداة ربط Dataflow

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