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

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

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

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

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

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

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

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

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

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

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

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

يستخدم واجهة سطر الأوامر في Firebase واجهة برمجة التطبيقات Cloud Firestore REST للعثور على جميع المستندات ضمن المسار المحدد وحذفها بشكل فردي. لا تتطلّب عملية التنفيذ هذه معرفة التسلسل الهرمي المحدّد للبيانات في تطبيقك. وستعثر على الحالة "معزولة" وتحذفها المستندات التي لم تعد تحتوي على أحد الوالدين.

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 
    };
  });
index.js

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

لاستدعاء الدالة، احصل على مرجع إلى الدالة من حزمة 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);
        });
}
index.js

Swift

ملاحظة: لا يتوفّر هذا المنتج ضمن نظامَي التشغيل WatchOS وApp Clip.

    // Snippet not yet written
    

Objective-C

ملاحظة: لا يتوفّر هذا المنتج ضمن نظامَي التشغيل WatchOS وApp Clip.

    // Snippet not yet written
    

Kotlin+KTX

/**
 * 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
            // ...
        }
}
SolutionDeletes.kt

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
                    // ...
                }
            });
}
SolutionDeletes.java

باستخدام حزمة SDK للعميل لوظائف السحابة الإلكترونية القابلة للاستدعاء، يمكن مصادقة المستخدمين والمعلمة path يتم تمريرها بسلاسة إلى الدالة البعيدة. عند اكتمال الدالة، سيتلقّى العميل رد اتصال مع تضمين نتيجة أو استثناء. لمعرفة كيفية استدعاء دالة سحابية من بالنسبة إلى نظام التشغيل Android أو Apple أو أي نظام أساسي آخر، اطّلِع على المستندات.

تحذير: الدوال القابلة للاستدعاء غير آمنة بشكل تلقائي. تأكد من أن مفتاحك القابل للاستدعاء تتحقق الوظائف من إذن المستخدم قبل تنفيذ أي إجراءات حساسة مثل كتابة المستندات أو حذفها.

القيود

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

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