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

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

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

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

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

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

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

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

Cloud फ़ंक्शन

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

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

Firebase सीएलआई, तय पाथ के अंदर सभी दस्तावेज़ों को ढूंढने और उन्हें अलग-अलग मिटाने के लिए Cloud Firestore REST API का इस्तेमाल करता है. इसे लागू करने के लिए, आपके ऐप्लिकेशन के डेटा की खास हैरारकी की जानकारी होना ज़रूरी नहीं है. साथ ही, यह ऐसे "ऑर्फ़ किए गए" दस्तावेज़ों को ढूंढ कर मिटा भी देगा जिन्हें अब पैरंट नहीं माना जा सकता.

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

क्लाइंट को न्योता देना

फ़ंक्शन को कॉल करने के लिए, 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
Swift
ध्यान दें: यह प्रॉडक्ट WatchOS और App Clip टारगेट पर उपलब्ध नहीं है. 
    // Snippet not yet written
Objective-C
ध्यान दें: यह प्रॉडक्ट WatchOS और App Clip टारगेट पर उपलब्ध नहीं है. 
    // Snippet not yet written

Kotlin+KTX

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

Java

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

सीमाएं

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

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