حذف البيانات باستخدام دالة السحابة الإلكترونية القابلة للاستدعاء

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

للاطّلاع على طرق أخرى لحذف المجموعات، يُرجى الانتقال إلى حذف البيانات.

الحلّ: حذف البيانات باستخدام Cloud Function قابلة للاستدعاء

قد يكون من الصعب حذف مجموعات كاملة من تطبيق للأجهزة الجوّالة محدود الموارد للأسباب التالية:

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

لحسن الحظ، يمكنك كتابة دالة Cloud قابلة للاستدعاء لتنفيذ عمليات حذف آمنة وفعّالة لمجموعات أو أشجار مجموعات بأكملها. تنفّذ Cloud Function أدناه دالة قابلة للاستدعاء، ما يعني أنّه يمكن استدعاؤها مباشرةً من تطبيقك على الأجهزة الجوّالة أو موقعك الإلكتروني كما تفعل مع دالة محلية.

لنشر الدالة وتجربة عرض توضيحي، اطّلِع على الرمز النموذجي.

وظيفة السحابة الإلكترونية

تحذف Cloud Function أدناه مجموعة وكل العناصر التابعة لها.

بدلاً من تنفيذ منطق الحذف المتكرّر الخاص بك في Cloud Functions، يمكنك الاستفادة من الأمر firestore:delete في واجهة سطر الأوامر (CLI) الخاصة بـ Firebase. يمكنك استيراد أي دالة من Firebase CLI إلى تطبيق Node.js باستخدام حزمة firebase-tools.

تستخدم واجهة سطر الأوامر (CLI) في Firebase واجهة Cloud Firestore REST API للعثور على جميع المستندات ضمن المسار المحدّد وحذفها بشكل فردي. لا يتطلّب هذا التنفيذ معرفة التسلسل الهرمي المحدّد لبيانات تطبيقك، بل سيتمكّن من العثور على المستندات "غير المرتبطة" التي لم يعُد لها مستند رئيسي وحذفها.

Node.js

/**
 * Initiate a recursive delete of documents at a given path.
 * 
 * The calling user must be authenticated and have the custom "admin" attribute
 * set to true on the auth token.
 * 
 * This delete is NOT an atomic operation and it's possible
 * that it may fail after only deleting some documents.
 * 
 * @param {string} data.path the document or collection path to delete.
 */
exports.recursiveDelete = functions
  .runWith({
    timeoutSeconds: 540,
    memory: '2GB'
  })
  .https.onCall(async (data, context) => {
    // Only allow admin users to execute this function.
    if (!(context.auth && context.auth.token && context.auth.token.admin)) {
      throw new functions.https.HttpsError(
        'permission-denied',
        'Must be an administrative user to initiate delete.'
      );
    }

    const path = data.path;
    console.log(
      `User ${context.auth.uid} has requested to delete path ${path}`
    );

    // Run a recursive delete on the given document or collection path.
    // The 'token' must be set in the functions config, and can be generated
    // at the command line by running 'firebase login:ci'.
    await firebase_tools.firestore
      .delete(path, {
        project: process.env.GCLOUD_PROJECT,
        recursive: true,
        force: true,
        token: functions.config().fb.token
      });

    return {
      path: path 
    };
  });

استدعاء العميل

لاستدعاء الدالة، احصل على مرجع للدالة من حزمة تطوير البرامج (SDK) الخاصة بمنصة Firebase وامرر المَعلمات المطلوبة:

الويب
/**
 * Call the 'recursiveDelete' callable function with a path to initiate
 * a server-side delete.
 */
function deleteAtPath(path) {
    var deleteFn = firebase.functions().httpsCallable('recursiveDelete');
    deleteFn({ path: path })
        .then(function(result) {
            logMessage('Delete success: ' + JSON.stringify(result));
        })
        .catch(function(err) {
            logMessage('Delete failed, see console,');
            console.warn(err);
        });
}
Swift
ملاحظة: لا يتوفّر هذا المنتج على watchOS واستهدافات "مقاطع التطبيقات".
    // Snippet not yet written
    
Objective-C
ملاحظة: لا يتوفّر هذا المنتج على watchOS واستهدافات "مقاطع التطبيقات".
    // Snippet not yet written
    

Kotlin

/**
 * Call the 'recursiveDelete' callable function with a path to initiate
 * a server-side delete.
 */
fun deleteAtPath(path: String) {
    val deleteFn = Firebase.functions.getHttpsCallable("recursiveDelete")
    deleteFn.call(hashMapOf("path" to path))
        .addOnSuccessListener {
            // Delete Success
            // ...
        }
        .addOnFailureListener {
            // Delete Failed
            // ...
        }
}

Java

/**
 * Call the 'recursiveDelete' callable function with a path to initiate
 * a server-side delete.
 */
public void deleteAtPath(String path) {
    Map<String, Object> data = new HashMap<>();
    data.put("path", path);

    HttpsCallableReference deleteFn =
            FirebaseFunctions.getInstance().getHttpsCallable("recursiveDelete");
    deleteFn.call(data)
            .addOnSuccessListener(new OnSuccessListener<HttpsCallableResult>() {
                @Override
                public void onSuccess(HttpsCallableResult httpsCallableResult) {
                    // Delete Success
                    // ...
                }
            })
            .addOnFailureListener(new OnFailureListener() {
                @Override
                public void onFailure(@NonNull Exception e) {
                    // Delete failed
                    // ...
                }
            });
}

باستخدام حزمة تطوير البرامج (SDK) للعميل من أجل دوال السحابة الإلكترونية القابلة للاستدعاء، يتم تمرير حالة مصادقة المستخدم والمعلَمة path بسلاسة إلى الدالة البعيدة. عند اكتمال الدالة، سيتلقّى العميل رد اتصال يتضمّن النتيجة أو استثناءً. لمعرفة كيفية استدعاء دالة سحابية من Android أو Apple أو أي منصة أخرى، يمكنك الاطّلاع على المستندات.

القيود

يوضّح الحلّ الموضّح أعلاه كيفية حذف المجموعات من دالة قابلة للاستدعاء، ولكن يجب الانتباه إلى القيود التالية:

  • الاتساق: يحذف الرمز البرمجي أعلاه المستندات واحدًا تلو الآخر. إذا أجريت طلب بحث أثناء تنفيذ عملية حذف، قد تعكس النتائج حالة غير مكتملة حيث يتم حذف بعض المستندات المستهدَفة فقط. ولا يمكن أيضًا ضمان نجاح عمليات الحذف أو فشلها بشكل موحّد، لذا عليك الاستعداد للتعامل مع حالات الحذف الجزئي.
  • مهلات: تم ضبط الدالة أعلاه على أن تعمل لمدة 540 ثانية كحد أقصى قبل انتهاء المهلة. يمكن لرمز الحذف حذف 4,000 مستند في الثانية في أفضل الحالات. إذا كنت بحاجة إلى حذف أكثر من 2,000,000 مستند، ننصحك بتنفيذ العملية على الخادم الخاص بك حتى لا تنتهي مهلة العملية. للاطّلاع على مثال حول كيفية حذف مجموعة من الخادم الخاص بك، راجِع حذف المجموعات.
  • قد يؤدي حذف عدد كبير من المستندات إلى بطء تحميل عارض البيانات في Google Cloud Console أو عرض خطأ انتهاء المهلة.