Usuwanie danych za pomocą funkcji w Cloud Functions z możliwością wywoływania

Na tej stronie opisujemy, jak używać wywoływanej funkcji w Cloud Functions do usuwania danych. Po wdrożeniu tej funkcji możesz wywoływać ją bezpośrednio z aplikacji mobilnej lub strony internetowej, aby rekursywnie usuwać dokumenty i kolekcje. Możesz na przykład użyć tego rozwiązania, aby przyznać wybranym użytkownikom możliwość usuwania całych kolekcji.

Inne sposoby usuwania kolekcji znajdziesz w sekcji Usuwanie danych.

Rozwiązanie: usuwanie danych za pomocą funkcji w Cloud Functions, którą można wywołać

Usunięcie całych kolekcji z aplikacji mobilnej o ograniczonych zasobach może być trudne z tych powodów:

• Nie ma operacji, która usuwa kolekcję w sposób niepodzielny.
• Usunięcie dokumentu nie powoduje usunięcia dokumentów w jego podzbiorach.
• Jeśli dokumenty mają dynamiczne podzbiory, trudno jest określić, które dane należy usunąć w przypadku danej ścieżki.
• Usunięcie kolekcji zawierającej ponad 500 dokumentów wymaga wielu operacji zapisu wsadowego lub setek pojedynczych operacji usuwania.
• W wielu aplikacjach nie jest wskazane przyznawanie użytkownikom uprawnień do usuwania całych kolekcji.

Na szczęście możesz napisać funkcję Cloud Function, którą można wywołać, aby bezpiecznie i wydajnie usuwać całe kolekcje lub drzewa kolekcji. Funkcja Cloud Function poniżej implementuje funkcję wywoływaną, co oznacza, że można ją wywoływać bezpośrednio z aplikacji mobilnej lub witryny tak samo jak funkcję lokalną.

Aby wdrożyć funkcję i wypróbować wersję demonstracyjną, zapoznaj się z przykładowym kodem.

Funkcja w Cloud Functions

Funkcja w Cloud Functions poniżej usuwa kolekcję i wszystkie jej elementy podrzędne.

Zamiast implementować własną logikę rekurencyjnego usuwania funkcji Cloud, możesz skorzystać z polecenia firestore:delete w interfejsie wiersza poleceń Firebase. Do aplikacji Node.js możesz zaimportować dowolną funkcję wiersza poleceń Firebase za pomocą pakietu firebase-tools.

Uwaga: usuwanie danych za pomocą interfejsu Firebase CLI wiąże się z kosztami odczytu i usuwania. Więcej informacji znajdziesz w sekcji Ceny.

Wiersz poleceń Firebase używa Cloud Firestoreinterfejsu REST API, aby znaleźć wszystkie dokumenty w określonej ścieżce i usunąć je pojedynczo. Ta implementacja nie wymaga znajomości konkretnej hierarchii danych aplikacji, a nawet znajduje i usuwa „osierocone” dokumenty, które nie mają już elementu nadrzędnego.

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

Wywołanie klienta

Aby wywołać funkcję, pobierz odwołanie do niej z pakietu Firebase SDK i przekaż wymagane parametry:

Sieć

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

Uwaga: ten produkt nie jest dostępny na platformach watchOS i w przypadku klipów aplikacji.

    // Snippet not yet written
    

Objective-C

Uwaga: ten produkt nie jest dostępny na platformach watchOS i w przypadku klipów aplikacji.

    // Snippet not yet written
    

Kotlin

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

Dzięki użyciu pakietu SDK klienta do wywoływanych funkcji chmury stan uwierzytelniania użytkownika i parametr path są płynnie przekazywane do funkcji zdalnej. Po zakończeniu działania funkcji klient otrzyma wywołanie zwrotne z wynikiem lub wyjątkiem. Aby dowiedzieć się, jak wywołać funkcję w Cloud Functions z poziomu Androida, Apple lub innej platformy, przeczytaj dokumentację.

Ostrzeżenie: funkcje wywoływane nie są domyślnie bezpieczne. Upewnij się, że funkcje wywoływane sprawdzają autoryzację użytkownika przed wykonaniem jakichkolwiek działań wymagających szczególnej ostrożności, takich jak zapisywanie lub usuwanie dokumentów.

Ograniczenia

Rozwiązanie pokazane powyżej demonstruje usuwanie kolekcji z funkcji wywoływanej, ale musisz pamiętać o tych ograniczeniach:

• Spójność – powyższy kod usuwa dokumenty pojedynczo. Jeśli wyślesz zapytanie w trakcie trwającej operacji usuwania, wyniki mogą odzwierciedlać częściowo ukończony stan, w którym usunięte są tylko niektóre dokumenty docelowe. Nie ma też gwarancji, że operacje usuwania zakończą się powodzeniem lub niepowodzeniem w jednakowy sposób, więc przygotuj się na przypadki częściowego usunięcia.
• Limity czasu – powyższa funkcja jest skonfigurowana tak, aby działać maksymalnie 540 sekund przed przekroczeniem limitu czasu. W najlepszym przypadku kod usuwania może usunąć 4000 dokumentów na sekundę. Jeśli chcesz usunąć więcej niż 2 000 000 dokumentów, rozważ przeprowadzenie tej operacji na własnym serwerze, aby nie przekroczyć limitu czasu. Przykład usuwania kolekcji z własnego serwera znajdziesz w sekcji Usuwanie kolekcji.
• Usunięcie dużej liczby dokumentów może spowodować powolne wczytywanie przeglądarki danych w konsoli Google Cloud lub zwrócenie błędu przekroczenia limitu czasu.