Xoá dữ liệu bằng Hàm đám mây có thể gọi

Trang này mô tả cách sử dụng một Cloud Function có thể gọi để xoá dữ liệu. Sau khi triển khai hàm này, bạn có thể gọi trực tiếp hàm đó từ ứng dụng di động hoặc trang web để xoá đệ quy các tài liệu và bộ sưu tập. Ví dụ: bạn có thể sử dụng giải pháp này để cấp cho một số người dùng khả năng xoá toàn bộ bộ sưu tập.

Để biết các cách khác để xoá bộ sưu tập, hãy xem bài viết Xoá dữ liệu.

Giải pháp: Xoá dữ liệu bằng một Cloud Function có thể gọi

Việc xoá toàn bộ bộ sưu tập khỏi một ứng dụng di động có tài nguyên hạn chế có thể khó triển khai vì những lý do sau:

• Không có thao tác nào xoá một bộ sưu tập một cách nguyên tử.
• Việc xoá một tài liệu không xoá các tài liệu trong bộ sưu tập con của tài liệu đó.
• Nếu tài liệu của bạn có các bộ sưu tập con động, thì có thể khó biết dữ liệu nào cần xoá cho một đường dẫn nhất định.
• Việc xoá một bộ sưu tập có hơn 500 tài liệu đòi hỏi phải có nhiều thao tác ghi theo lô hoặc hàng trăm thao tác xoá riêng lẻ.
• Trong nhiều ứng dụng, việc cấp cho người dùng cuối quyền xoá toàn bộ bộ sưu tập là không phù hợp.

May mắn là bạn có thể viết một Cloud Function có thể gọi để chạy các thao tác xoá an toàn và hiệu suất cao đối với toàn bộ bộ sưu tập hoặc cây bộ sưu tập. Cloud Function bên dưới triển khai một hàm có thể gọi tức là bạn có thể gọi trực tiếp hàm đó từ ứng dụng di động hoặc trang web như đối với một hàm cục bộ.

Để triển khai hàm và dùng thử bản minh hoạ, hãy xem mã mẫu.

Cloud Function

Cloud Function bên dưới sẽ xoá một bộ sưu tập và tất cả các phần tử con của bộ sưu tập đó.

Thay vì triển khai logic xoá đệ quy của riêng bạn cho Cloud Function, bạn có thể tận dụng lệnh firestore:delete trong Giao diện dòng lệnh (CLI) của Firebase. Bạn có thể nhập bất kỳ hàm nào của CLI Firebase vào ứng dụng Node.js bằng gói firebase-tools.

Lưu ý: Việc xoá dữ liệu bằng Giao diện dòng lệnh (CLI) của Firebase sẽ phát sinh chi phí đọc và xoá. Để biết thêm thông tin, hãy xem Giá.

CLI Firebase sử dụng Cloud Firestore API REST để tìm tất cả tài liệu trong đường dẫn đã chỉ định và xoá từng tài liệu. Việc triển khai này không yêu cầu bạn phải biết về hệ thống phân cấp dữ liệu cụ thể của ứng dụng và thậm chí sẽ tìm và xoá các tài liệu "mồ côi" không còn có tài liệu mẹ.

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

Lệnh gọi ứng dụng

Để gọi hàm, hãy lấy một tham chiếu đến hàm từ SDK Firebase và truyền các tham số bắt buộc:

Web

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

Lưu ý: Sản phẩm này không hoạt động trên watchOS và mục tiêu App Clip.

    // Snippet not yet written
    

Objective-C

Lưu ý: Sản phẩm này không hoạt động trên watchOS và mục tiêu App Clip.

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

Bằng cách sử dụng SDK ứng dụng cho các Cloud Function có thể gọi, trạng thái xác thực của người dùng và tham số path sẽ được truyền liền mạch đến hàm từ xa. Khi hàm hoàn tất, ứng dụng sẽ nhận được một lệnh gọi lại có kết quả hoặc một ngoại lệ. Để tìm hiểu cách gọi một Cloud Function từ Android, Apple hoặc một nền tảng khác, hãy đọc tài liệu.

Cảnh báo: Các hàm có thể gọi không an toàn theo mặc định! Hãy đảm bảo rằng các hàm có thể gọi của bạn kiểm tra quyền của người dùng trước khi thực hiện bất kỳ hành động nhạy cảm nào như ghi hoặc xoá tài liệu.

Hạn chế

Giải pháp được trình bày ở trên minh hoạ cách xoá bộ sưu tập khỏi một hàm có thể gọi, nhưng bạn cần lưu ý những hạn chế sau:

• Tính nhất quán – mã ở trên sẽ xoá từng tài liệu một. Nếu bạn truy vấn trong khi đang có một thao tác xoá, thì kết quả có thể phản ánh trạng thái hoàn thành một phần, trong đó chỉ một số tài liệu được nhắm mục tiêu bị xoá. Ngoài ra, không có gì đảm bảo rằng các thao tác xoá sẽ thành công hoặc không thành công một cách đồng nhất, vì vậy, hãy chuẩn bị để xử lý các trường hợp xoá một phần.
• Thời gian chờ – hàm ở trên được định cấu hình để chạy tối đa 540 giây trước khi hết thời gian chờ. Mã xoá có thể xoá 4000 tài liệu mỗi giây trong trường hợp tốt nhất. Nếu cần xoá hơn 2.000.000 tài liệu, bạn nên cân nhắc chạy thao tác trên máy chủ của riêng mình để thao tác đó không hết thời gian chờ. Để biết ví dụ về cách xoá một bộ sưu tập khỏi máy chủ của riêng bạn, hãy xem bài viết Xoá bộ sưu tập.
• Việc xoá một số lượng lớn tài liệu có thể khiến trình xem dữ liệu trong bảng điều khiển Cloud của Google tải chậm hoặc trả về lỗi hết thời gian chờ.