Na stronie opisano, jak używać wywoływalnej funkcji chmury do usuwania danych. Po wdrożeniu tej funkcji możesz ją wywołać bezpośrednio z aplikacji mobilnej lub witryny internetowej, aby rekursywnie usuwać dokumenty i zbiory. Możesz na przykład użyć tego rozwiązania, aby zapewnić wybranym użytkownikom możliwość usuwania całych kolekcji.
Aby zapoznać się z innymi sposobami usuwania kolekcji, zobacz temat Usuwanie danych .
Rozwiązanie: Usuń dane za pomocą wywoływalnej funkcji chmury
Usuwanie całych kolekcji z aplikacji mobilnej o ograniczonych zasobach może być trudne do wdrożenia z następujących powodów:
- Nie ma operacji, która atomowo usuwa kolekcję.
- Usunięcie dokumentu nie powoduje usunięcia dokumentów znajdujących się w jego podkolekcjach.
- Jeśli Twoje dokumenty mają dynamiczne podzbiory, określenie, jakie dane należy usunąć dla danej ścieżki, może być trudne.
- Usunięcie kolekcji zawierającej ponad 500 dokumentów wymaga wielu operacji zapisu wsadowego lub setek pojedynczych usunięć.
- W wielu aplikacjach nie jest właściwe udzielanie użytkownikom końcowym uprawnień do usuwania całych kolekcji.
Na szczęście możesz napisać wywoływalną funkcję w chmurze, aby bezpiecznie i wydajnie usuwać całe kolekcje lub drzewa kolekcji. Poniższa funkcja chmury implementuje funkcję wywoływalną , co oznacza, że można ją wywołać bezpośrednio z aplikacji mobilnej lub strony internetowej, tak jak w przypadku funkcji lokalnej.
Aby wdrożyć funkcję i wypróbować wersję demonstracyjną, zobacz przykładowy kod .
Funkcja chmury
Poniższa funkcja chmury usuwa kolekcję i wszystkie jej elementy podrzędne.
Zamiast implementować własną logikę rekurencyjnego usuwania dla swojej funkcji w chmurze, możesz skorzystać z polecenia firestore:delete
w interfejsie wiersza poleceń Firebase (CLI). Możesz zaimportować dowolną funkcję Firebase CLI do swojej aplikacji Node.js za pomocą pakietu firebase-tools
.
Interfejs wiersza polecenia Firebase korzysta z interfejsu API REST Cloud Firestore, 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 pozwala znaleźć i usunąć „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 }; });
Wywołanie Klienta
Aby wywołać funkcję, pobierz odwołanie do funkcji z pakietu SDK Firebase 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); }); }
Szybki
// Snippet not yet written
Cel C
// 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 // ... } }
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 // ... } }); }
Używając pakietu SDK klienta do wywoływalnych funkcji w chmurze, stan uwierzytelnienia użytkowników i parametr path
są bezproblemowo przekazywane do funkcji zdalnej. Po zakończeniu funkcji klient otrzyma wywołanie zwrotne z wynikiem lub wyjątkiem. Aby dowiedzieć się, jak wywołać funkcję chmury z systemu Android, Apple lub innej platformy, przeczytaj dokumentację .
Ograniczenia
Rozwiązanie pokazane powyżej demonstruje usuwanie kolekcji z wywoływalnej funkcji, ale należy pamiętać o następujących ograniczeniach:
- Spójność - powyższy kod usuwa dokumenty pojedynczo. Jeśli zapytasz, gdy trwa operacja usuwania, wyniki mogą odzwierciedlać stan częściowo ukończony, w którym usunięte zostaną tylko niektóre docelowe dokumenty. Nie ma również gwarancji, że operacje usuwania zakończą się sukcesem lub niepowodzeniem w jednakowy sposób, dlatego należy przygotować się na obsługę przypadków częściowego usunięcia.
- Limity czasu — powyższa funkcja jest skonfigurowana tak, aby działała maksymalnie przez 540 sekund przed upływem 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, powinieneś rozważyć uruchomienie operacji na własnym serwerze, aby nie przekroczyć limitu czasu. Przykład usuwania kolekcji z własnego serwera można znaleźć w artykule Usuwanie kolekcji .