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

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

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

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

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

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

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

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

Cloud फ़ंक्शन

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

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

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

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

सीमाएं

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

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