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

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

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

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

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

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

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

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

دالة Cloud Function

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

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

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

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

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

لاستدعاء الدالة، احصل على مرجع للدالة من Firebase SDK ومرِّر المَعلمات المطلوبة:

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

    // Snippet not yet written
    

    // Snippet not yet written
    

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

/**
 * 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) للعميل من أجل دوال Cloud Functions القابلة للاستدعاء، يتم تمرير حالة مصادقة المستخدم والمَعلمة path بسلاسة إلى الدالة البعيدة. عند اكتمال الدالة، سيتلقّى العميل دالة ردّ اتصال تتضمّن النتيجة أو استثناءً. للتعرّف على كيفية استدعاء دالة Cloud Function من Android أو Apple أو أي منصة أخرى، اطّلِع على المستندات.

القيود

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

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