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

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

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

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

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

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

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

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

Cloud फ़ंक्शन

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

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

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

सीमाएं

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

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