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 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 hàm trực tiếp từ ứng dụng di động hoặc trang web để xoá tài liệu và tập hợp theo cách đệ quy. 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 quyền xoá toàn bộ tập hợp.

Để biết các cách khác để xoá tập hợp, hãy xem phần Xoá dữ liệu.

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

Việc xoá toàn bộ tập hợ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 tập hợp theo cách tự động.
• Khi bạn xoá một tài liệu, các tài liệu trong tập hợp con của tài liệu đó sẽ không bị xoá.
• Nếu tài liệu của bạn có các tập hợp con động, thì bạn có thể khó biết được dữ liệu nào cần xoá cho một đường dẫn nhất định.
• Để xoá một tập hợp gồm hơn 500 tài liệu, bạn cần thực hiện nhiều thao tác ghi theo lô hoặc hàng trăm thao tác xoá đơn lẻ.
• Trong nhiều ứng dụng, việc cấp cho người dùng cuối quyền xoá toàn bộ tập hợ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 quả cho toàn bộ tập hợp hoặc cây tập hợp. Cloud Function dưới đây triển khai một hàm có thể gọi, nghĩa là hàm này có thể được gọi trực tiếp từ ứng dụng di động hoặc trang web của bạn như một hàm cục bộ.

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

Cloud Function

Hàm Cloud Function dưới đây xoá một tập hợp và tất cả các thành phần con của tập hợ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 Giao diện dòng lệnh (CLI) của Firebase vào ứng dụng Node.js bằng gói firebase-tools.

Giao diện dòng lệnh (CLI) của Firebase sử dụng API REST Cloud Firestore để tìm tất cả tài liệu trong đường dẫn đã chỉ định và xoá từng tài liệu. Cách triển khai này không yêu cầu kiến thức về hệ 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 tài liệu mẹ.

/**
 * 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 tệp đối chiếu đến hàm từ SDK Firebase và truyền các tham số bắt buộc:

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

    // Snippet not yet written
    

    // Snippet not yet written
    

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

/**
 * 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 Functions 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 lệnh gọi lại kèm theo kết quả hoặc một ngoại lệ. Để tìm hiểu cách gọi một hàm đám mây từ Android, Apple hoặc một nền tảng khác, hãy đọc tài liệu.

Hạn chế

Giải pháp nêu trên minh hoạ cách xoá tập hợ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 xoá từng tài liệu một. Nếu bạn truy vấn trong khi có một thao tác xoá đang diễn ra, thì kết quả có thể phản ánh trạng thái hoàn tất 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 đồ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 trong tối đa 540 giây trước khi hết thời gian chờ. Mã xoá có thể xoá 4.000 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 này trên máy chủ của riêng mình để không bị hết thời gian chờ. Để xem ví dụ về cách xoá một tập hợp khỏi máy chủ của riêng bạn, hãy xem phần Xoá tập hợp.
• Việc xoá một số lượng lớn tài liệu có thể khiến chế độ xem dữ liệu trong Google Cloud Console tải chậm hoặc trả về lỗi hết thời gian chờ.