Na tej stronie opisujemy, jak usuwać dane przy użyciu wywoływanej funkcji w Cloud Functions. Po wdrożeniu tej funkcji możesz ją wywoływać bezpośrednio w aplikacji mobilnej lub witrynie, aby cyklicznie usuwać dokumenty i kolekcje. Możesz na przykład użyć tego rozwiązania, aby umożliwić wybranym użytkownikom usuwanie całych kolekcji.
Inne sposoby usuwania kolekcji znajdziesz w artykule Usuwanie danych.
Rozwiązanie: usuwanie danych za pomocą możliwej do wywołania funkcji w Cloud Functions
Usuwanie całych kolekcji z aplikacji mobilnej o ograniczonych zasobach może być trudne z tych powodów:
- Żadna operacja nie usuwa kolekcji atomowej.
- Usunięcie dokumentu nie powoduje usunięcia dokumentów w kolekcjach podrzędnych.
- Jeśli dokumenty mają dynamiczne podkolekcje podrzędne, trudno jest określić, które dane usunąć na danej ścieżce.
- Usunięcie kolekcji zawierającej ponad 500 dokumentów wymaga wielu operacji zapisu zbiorczego lub setek pojedynczych usunięć.
- W wielu aplikacjach nie ma sensu przyznawać użytkownikom uprawnień do usuwania całej kolekcji.
Na szczęście możesz napisać wywołaną funkcję w Cloud Functions, która umożliwia bezpieczne i efektywne usuwanie całych kolekcji lub drzew kolekcji. Poniższa funkcja w Cloud Functions implementuje funkcję wywoływaną, co oznacza, że można ją wywołać bezpośrednio z aplikacji mobilnej lub witryny, tak jak w przypadku funkcji lokalnej.
Aby wdrożyć funkcję i wypróbować jej wersję demonstracyjną, zapoznaj się z przykładowym kodem.
Cloud Functions
Poniższa funkcja w Cloud Functions usuwa kolekcję i wszystkie jej elementy podrzędne.
Zamiast implementować w Cloud Functions własną logikę usuwania rekurencyjnego, możesz skorzystać z polecenia firestore:delete w interfejsie wiersza poleceń Firebase. Korzystając z pakietu firebase-tools, możesz zaimportować dowolną funkcję interfejsu wiersza poleceń Firebase do aplikacji Node.js.
Interfejs wiersza poleceń Firebase używa interfejsu Cloud Firestore API typu REST do wyszukiwania wszystkich dokumentów w podanej ścieżce i usuwania ich pojedynczo. Ta implementacja nie wymaga znajomości hierarchii danych aplikacji, a nawet wyszukuje i usuwa „osierocone” dokumenty, które nie mają już elementów nadrzędnych.
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ć tę funkcję, pobierz do niej odwołanie z pakietu SDK Firebase i przekaż wymagane parametry:
Internet
/**
* 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);
});
}
Swift
// Snippet not yet written
Objective-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
// ...
}
});
}
Dzięki użyciu pakietu SDK klienta do wywoływania funkcji w Cloud Functions stan uwierzytelniania użytkownika i parametr path są bezproblemowo przekazywane do funkcji zdalnej.
Gdy funkcja się zakończy, klient otrzyma wywołanie zwrotne z wynikiem lub wyjątkiem. Więcej informacji o wywoływaniu funkcji w Cloud Functions z Androida, Apple lub innej platformy znajdziesz w dokumentacji.
Ograniczenia
Powyższe rozwiązanie pokazuje usuwanie kolekcji za pomocą funkcji wywoływanej, ale pamiętaj 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ć stan częściowo ukończony, w którym usunięte są tylko niektóre dokumenty docelowe. Nie ma również gwarancji, że operacje usuwania zakończą się równomiernie lub niepowodzenie. Przygotuj się na obsługę przypadków częściowego usunięcia danych.
- Czasy oczekiwania – powyższa funkcja jest skonfigurowana tak, aby działać przez maksymalnie 540 sekund przed przekroczeniem limitu czasu. W najlepszym przypadku kod usuwania umożliwia usunięcie 4000 dokumentów na sekundę. Jeśli chcesz usunąć więcej niż 2 000 000 dokumentów, rozważ wykonanie tej operacji na własnym serwerze, aby nie przekroczyć limitu czasu. Przykład usuwania kolekcji z własnego serwera znajdziesz w artykule Usuwanie kolekcji.