कॉल करने योग्य क्लाउड फ़ंक्शन के साथ डेटा हटाएं

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

संग्रह हटाने के अन्य तरीकों के लिए, डेटा हटाएं देखें।

समाधान: कॉल करने योग्य क्लाउड फ़ंक्शन के साथ डेटा हटाएं

संसाधन-सीमित मोबाइल ऐप से संपूर्ण संग्रह को हटाना निम्नलिखित कारणों से लागू करना मुश्किल हो सकता है:

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

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

फ़ंक्शन को तैनात करने और डेमो आज़माने के लिए, नमूना कोड देखें।

क्लाउड फ़ंक्शन

नीचे दिया गया क्लाउड फ़ंक्शन एक संग्रह और उसके सभी वंशजों को हटा देता है।

अपने क्लाउड फ़ंक्शन के लिए अपने स्वयं के पुनरावर्ती डिलीट लॉजिक को लागू करने के बजाय, आप फायरबेस कमांड लाइन इंटरफेस (सीएलआई) में firestore:delete कमांड का लाभ उठा सकते हैं। आप firebase-tools पैकेज का उपयोग करके फायरबेस सीएलआई के किसी भी फ़ंक्शन को अपने 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

ग्राहक मंगलाचरण

फ़ंक्शन को कॉल करने के लिए, फ़ायरबेस एसडीके से फ़ंक्शन का संदर्भ प्राप्त करें और आवश्यक पैरामीटर पास करें:

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

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

सीमाएँ

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

• संगति - उपरोक्त कोड एक समय में एक दस्तावेज़ को हटाता है। यदि आप डिलीट ऑपरेशन के दौरान क्वेरी करते हैं, तो आपके परिणाम आंशिक रूप से पूर्ण स्थिति को दर्शा सकते हैं, जहां केवल कुछ लक्षित दस्तावेज़ हटाए गए हैं। इस बात की भी कोई गारंटी नहीं है कि डिलीट ऑपरेशन समान रूप से सफल या विफल होंगे, इसलिए आंशिक विलोपन के मामलों को संभालने के लिए तैयार रहें।
• टाइमआउट - उपरोक्त फ़ंक्शन को टाइमिंग आउट से पहले अधिकतम 540 सेकंड तक चलने के लिए कॉन्फ़िगर किया गया है। विलोपन कोड सर्वोत्तम स्थिति में प्रति सेकंड 4000 दस्तावेज़ हटा सकता है। यदि आपको 2,000,000 से अधिक दस्तावेज़ों को हटाने की आवश्यकता है, तो आपको ऑपरेशन को अपने सर्वर पर चलाने पर विचार करना चाहिए ताकि इसका समय समाप्त न हो। अपने स्वयं के सर्वर से किसी संग्रह को हटाने के तरीके के उदाहरण के लिए, संग्रह हटाएँ देखें।