कॉल करने लायक क्लाउड फ़ंक्शन से डेटा मिटाना

इस पेज पर, डेटा मिटाने के लिए, कॉल करने लायक Cloud Function इस्तेमाल करने का तरीका बताया गया है. इस फ़ंक्शन को डिप्लॉय करने के बाद, दस्तावेज़ों और कलेक्शन को बार-बार मिटाने के लिए, इसे सीधे अपने मोबाइल ऐप्लिकेशन या वेबसाइट से कॉल किया जा सकता है. उदाहरण के लिए, इस समाधान का इस्तेमाल करके, चुनिंदा उपयोगकर्ताओं को पूरे कलेक्शन मिटाने की अनुमति दी जा सकती है.

कलेक्शन मिटाने के अन्य तरीकों के बारे में जानने के लिए, डेटा मिटाना लेख पढ़ें.

समाधान: कॉल किए जा सकने वाले Cloud फ़ंक्शन की मदद से डेटा मिटाना

सीमित संसाधन वाले मोबाइल ऐप्लिकेशन से पूरे कलेक्शन मिटाने की सुविधा को लागू करना मुश्किल हो सकता है. इसकी ये वजहें हो सकती हैं:

• कोई भी ऐसा तरीका नहीं है जिससे किसी कलेक्शन को एक साथ मिटाया जा सके.
• किसी दस्तावेज़ को मिटाने पर, उसके सब-कलेक्शन में मौजूद दस्तावेज़ नहीं मिटते.
• अगर आपके दस्तावेज़ों में डाइनैमिक सबकलेक्शन हैं, तो यह पता लगाना मुश्किल हो सकता है कि किसी पाथ के लिए कौनसा डेटा मिटाया जाए.
• 500 से ज़्यादा दस्तावेज़ों के कलेक्शन को मिटाने के लिए, एक साथ कई दस्तावेज़ मिटाने की ज़रूरत होती है या एक-एक करके सैकड़ों दस्तावेज़ मिटाने पड़ते हैं.
• कई ऐप्लिकेशन में, असली उपयोगकर्ताओं को पूरे कलेक्शन मिटाने की अनुमति देना सही नहीं होता.

हालांकि, पूरे कलेक्शन या कलेक्शन ट्री को सुरक्षित तरीके से और तेज़ी से मिटाने के लिए, कॉल किया जा सकने वाला क्लाउड फ़ंक्शन लिखा जा सकता है. यहां दिया गया क्लाउड फ़ंक्शन, कॉल किया जा सकने वाला फ़ंक्शन लागू करता है. इसका मतलब है कि इसे सीधे अपने मोबाइल ऐप्लिकेशन या वेबसाइट से कॉल किया जा सकता है, ठीक वैसे ही जैसे किसी लोकल फ़ंक्शन को कॉल किया जाता है.

फ़ंक्शन को डिप्लॉय करने और डेमो आज़माने के लिए, सैंपल कोड देखें.

Cloud फ़ंक्शन

यहां दिया गया Cloud फ़ंक्शन, किसी कलेक्शन और उससे जुड़े सभी आइटम को मिटा देता है.

अपने Cloud फ़ंक्शन के लिए, डेटा को बार-बार मिटाने का अपना लॉजिक लागू करने के बजाय, Firebase कमांड-लाइन इंटरफ़ेस (सीएलआई) में firestore:delete कमांड का फ़ायदा लिया जा सकता है. firebase-tools पैकेज का इस्तेमाल करके, अपने Node.js ऐप्लिकेशन में Firebase CLI का कोई भी फ़ंक्शन इंपोर्ट किया जा सकता है.

Firebase CLI, दिए गए पाथ में मौजूद सभी दस्तावेज़ों को ढूंढने और उन्हें अलग-अलग मिटाने के लिए, 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

कॉल किए जा सकने वाले Cloud फ़ंक्शन के लिए क्लाइंट SDK टूल का इस्तेमाल करके, उपयोगकर्ताओं की पुष्टि की स्थिति और path पैरामीटर को रिमोट फ़ंक्शन में आसानी से पास किया जाता है. फ़ंक्शन पूरा होने पर, क्लाइंट को नतीजे या अपवाद के साथ कॉलबैक मिलेगा. Android, Apple या किसी अन्य प्लैटफ़ॉर्म से क्लाउड फ़ंक्शन को कॉल करने का तरीका जानने के लिए, दस्तावेज़ पढ़ें.

सीमाएं

ऊपर दिखाए गए समाधान में, कॉल करने लायक फ़ंक्शन से कलेक्शन मिटाने का तरीका बताया गया है, लेकिन आपको इन सीमाओं का ध्यान रखना चाहिए:

• एक जैसा होना - ऊपर दिया गया कोड, दस्तावेज़ों को एक-एक करके मिटाता है. अगर मिटाने की प्रोसेस जारी है, तो क्वेरी करने पर आपको कुछ नतीजे दिख सकते हैं. इनमें, टारगेट किए गए कुछ दस्तावेज़ ही मिटाए गए होंगे. इस बात की भी कोई गारंटी नहीं है कि मिटाने की प्रोसेस एक जैसी होगी या पूरी तरह से काम करेगी. इसलिए, कुछ डेटा मिटने के मामलों को मैनेज करने के लिए तैयार रहें.
• टाइम आउट - ऊपर दिया गया फ़ंक्शन, टाइम आउट होने से पहले ज़्यादा से ज़्यादा 540 सेकंड तक चलने के लिए कॉन्फ़िगर किया गया है. मिटाने का कोड, सबसे बेहतर स्थिति में हर सेकंड 4,000 दस्तावेज़ मिटा सकता है. अगर आपको 20,00,000 से ज़्यादा दस्तावेज़ मिटाने हैं, तो आपको यह कार्रवाई अपने सर्वर पर करनी चाहिए, ताकि समय खत्म न हो. अपने सर्वर से किसी कलेक्शन को मिटाने का उदाहरण देखने के लिए, कलेक्शन मिटाना लेख पढ़ें.
• एक साथ कई दस्तावेज़ मिटाने पर, हो सकता है कि Google Cloud Console में डेटा व्यूअर धीरे लोड हो या टाइम आउट की गड़बड़ी दिखे.