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 Functions 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 này từ ứng dụng di động hoặc trang web của mình để 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 quyền xoá toàn bộ bộ sưu tập.

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

Giải pháp: Xoá dữ liệu bằng Cloud Functions 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ó giới hạn tài nguyên 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 theo cách thức nguyên tử.
• Khi bạn xoá một tài liệu, các tài liệu trong bộ sưu tậ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 khó có thể biết nên xoá dữ liệu nào 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á 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ộ các bộ sưu tập là không phù hợp.

Rất may 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ả toàn bộ các bộ sưu tập hoặc cây bộ sưu tập. Hàm Cloud 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 này từ ứng dụng di động hoặc trang web của mình 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

Hàm Cloud 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 Functions, 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 mọi hàm của Firebase CLI vào ứng dụng Node.js bằng cách sử dụng gói firebase-tools.

Lưu ý: Thao tác xoá dữ liệu bằng Firebase CLI sẽ phát sinh chi phí đọc và xoá. Để biết thêm thông tin, hãy xem bài viết Định giá.

Firebase CLI sử dụng REST API Cloud Firestore để tìm tất cả các tài liệu theo đườ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 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 "không có chủ" không còn có tài liệu mẹ nữa.

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ời gọi của ứng dụng

Để gọi hàm, hãy lấy một tham chiếu đến hàm từ Firebase SDK 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 có trên các mục tiêu watchOS và App Clip.

    // Snippet not yet written
    

Objective-C

Lưu ý: Sản phẩm này không có trên các mục tiêu watchOS và 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 hàm đám mây 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 hàm trên đám mây từ Android, Apple hoặc một nền tảng khác, hãy đọc tài liệu.

Cảnh báo: Theo mặc định, các hàm có thể gọi không an toàn! Đả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.

Các điểm hạn chế

Giải pháp nêu trên minh hoạ cách xoá các 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 – đoạ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á diễn ra, 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 thất bại một cách đồng nhất, vì vậy, hãy chuẩn bị sẵn sàng để 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ờ. Trong trường hợp tốt nhất, mã xoá có thể xoá 4.000 tài liệu mỗi giây. 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 để thao tác không bị hết thời gian chờ. Để xem 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 phần 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 Google Cloud tải chậm hoặc trả về lỗi hết thời gian chờ.