Lên lịch xuất dữ liệu

Trang này mô tả cách lên lịch xuất dữ liệu Cloud Firestore. Để chạy quy trình xuất theo lịch, bạn nên sử dụng Cloud FunctionsCloud Scheduler.

Trước khi bắt đầu

Trước khi lên lịch xuất dữ liệu được quản lý, bạn phải hoàn thành các việc sau:

  1. Bật tính năng thanh toán cho dự án Google Cloud. Chỉ những dự án Google Cloud đã bật tính năng thanh toán mới có thể sử dụng tính năng xuất và nhập.
  2. Thao tác xuất yêu cầu một bộ chứa Cloud Storage đích. Tạo một bộ chứa Cloud Storage ở vị trí gần vị trí cơ sở dữ liệu Cloud Firestore. Bạn không thể sử dụng bộ chứa Người yêu cầu thanh toán cho các thao tác xuất.

Tạo một Hàm trên đám mây và một công việc Cloud Scheduler

Hãy làm theo các bước dưới đây để tạo một Hàm trên đám mây Node.js khởi tạo một tác vụ xuất dữ liệu Cloud Firestore và một tác vụ Cloud Scheduler để gọi hàm đó:

Giao diện dòng lệnh (CLI) của Firebase
  1. Cài đặt Giao diện dòng lệnh (CLI) của Firebase. Trong một thư mục mới, hãy khởi chạy CLI cho Cloud Functions:

    firebase init functions --project PROJECT_ID
    1. Chọn JavaScript cho ngôn ngữ.
    2. Bạn có thể bật ESLint (không bắt buộc).
    3. Nhập y để cài đặt các phần phụ thuộc.
  2. Thay thế mã trong tệp functions/index.js bằng mã sau:

    const functions = require('firebase-functions');
    const firestore = require('@google-cloud/firestore');
    const client = new firestore.v1.FirestoreAdminClient();
    
    // Replace BUCKET_NAME
    const bucket = 'gs://BUCKET_NAME';
    
    exports.scheduledFirestoreExport = functions.pubsub
                                                .schedule('every 24 hours')
                                                .onRun((context) => {
    
      const projectId = process.env.GCP_PROJECT;
      const databaseName = 
        client.databasePath(projectId, '(default)');
    
      return client.exportDocuments({
        name: databaseName,
        outputUriPrefix: bucket,
        // Leave collectionIds empty to export all collections
        // or set to a list of collection IDs to export,
        // collectionIds: ['users', 'posts']
        collectionIds: []
        })
      .then(responses => {
        const response = responses[0];
        console.log(`Operation Name: ${response['name']}`);
      })
      .catch(err => {
        console.error(err);
        throw new Error('Export operation failed');
      });
    });
  3. Trong mã trên, hãy sửa đổi nội dung sau:
    • Thay thế BUCKET_NAME bằng tên của bộ chứa.
    • Sửa đổi every 24 hours để đặt lịch xuất. Sử dụng cú pháp cron.yaml của AppEngine hoặc định dạng unix-cron (* * * * *).
    • Sửa đổi collectionIds: [] để chỉ xuất các nhóm bộ sưu tập đã chỉ định. Để nguyên để xuất tất cả bộ sưu tập.

  4. Triển khai hàm theo lịch:

    firebase deploy --only functions
Bảng điều khiển Google Cloud
Tạo một Hàm trên đám mây
  1. Chuyển đến trang Cloud Functions (Hàm trên đám mây) trong Google Cloud Console:

    Chuyển đến Cloud Functions

  2. Nhấp vào Tạo hàm
  3. Nhập tên hàm, chẳng hạn như firestoreExport
  4. Trong mục Điều kiện kích hoạt, hãy chọn Cloud Pub/Sub
  5. Trong mục Chủ đề, hãy chọn Tạo chủ đề mới. Nhập tên cho chủ đề pub/sub, chẳng hạn như initiateFirestoreExport. Ghi lại tên chủ đề vì bạn sẽ cần tên này để tạo công việc Cloud Scheduler.
  6. Trong phần Mã nguồn, hãy chọn Trình chỉnh sửa cùng dòng. Nhập mã sau trong index.js:
    const firestore = require('@google-cloud/firestore');
    const client = new firestore.v1.FirestoreAdminClient();
    // Replace BUCKET_NAME
    const bucket = 'gs://BUCKET_NAME'
    
    exports.scheduledFirestoreExport = (event, context) => {
      const databaseName = client.databasePath(
        process.env.GCP_PROJECT,
        '(default)'
      );
    
      return client
        .exportDocuments({
          name: databaseName,
          outputUriPrefix: bucket,
          // Leave collectionIds empty to export all collections
          // or define a list of collection IDs:
          // collectionIds: ['users', 'posts']
          collectionIds: [],
        })
        .then(responses => {
          const response = responses[0];
          console.log(`Operation Name: ${response['name']}`);
          return response;
        })
        .catch(err => {
          console.error(err);
        });
    };
    Trong mã trên, hãy sửa đổi nội dung sau:
    • Thay thế BUCKET_NAME bằng tên của bộ chứa.
    • Sửa đổi collectionIds: [] để chỉ xuất các nhóm bộ sưu tập đã chỉ định. Để nguyên để xuất tất cả bộ sưu tập.

  7. Trong package.json, hãy thêm phần phụ thuộc sau:
    {
      "dependencies": {
        "@google-cloud/firestore": "^1.3.0"
      }
    }
  8. Trong phần Hàm cần thực thi, hãy nhập scheduledFirestoreExport, tên của hàm trong index.js.
  9. Nhấp vào Tạo để triển khai Hàm trên đám mây.
Tạo công việc Cloud Scheduler

Tiếp theo, hãy tạo một công việc Cloud Scheduler gọi Chức năng trên đám mây:

  1. Chuyển đến trang Cloud Scheduler trong Google Cloud Console:

    Chuyển đến Cloud Scheduler

  2. Nhấp vào Tạo công việc.
  3. Nhập Tên cho công việc, chẳng hạn như scheduledFirestoreExport.
  4. Nhập Tần suất, ví dụ: every 24 hours.
  5. Chọn Múi giờ.
  6. Trong mục Mục tiêu, hãy chọn Pub/Sub. Trong trường Topic (Chủ đề), hãy nhập tên của chủ đề pub/sub mà bạn đã xác định cùng với Hàm trên đám mây, initiateFirestoreExport trong ví dụ ở trên.
  7. Trong trường Payload (Gói dữ liệu), hãy nhập start export. Công việc này yêu cầu xác định tải trọng, nhưng Hàm trên đám mây ở trên thực sự không sử dụng giá trị này.
  8. Nhấp vào Tạo.
Tại thời điểm này, bạn đã triển khai Hàm trên đám mây và công việc Cloud Scheduler, nhưng Hàm trên đám mây vẫn cần quyền truy cập để thực thi các thao tác xuất.

Định cấu hình quyền truy cập

Tiếp theo, hãy cấp cho Hàm trên đám mây quyền bắt đầu các thao tác xuất và ghi vào bộ chứa GCS.

Hàm trên Google Cloud này sử dụng tài khoản dịch vụ mặc định của dự án để xác thực và uỷ quyền cho các hoạt động xuất. Khi bạn tạo một dự án, hệ thống sẽ tạo cho bạn một tài khoản dịch vụ mặc định có tên như sau:

PROJECT_ID@appspot.gserviceaccount.com

Tài khoản dịch vụ này cần có quyền bắt đầu thao tác xuất và ghi vào bộ chứa Cloud Storage. Để cấp các quyền này, hãy chỉ định các vai trò IAM sau đây cho tài khoản dịch vụ mặc định:

  • Cloud Datastore Import Export Admin
  • Vai trò Owner hoặc Storage Admin trên bộ chứa

Bạn có thể sử dụng các công cụ dòng lệnh gcloudgsutil để chỉ định các vai trò này.

Nếu chưa cài đặt, bạn có thể truy cập vào các công cụ này từ Cloud Shell trong Google Cloud Console:
Bắt đầu Cloud Shell

  1. Chỉ định vai trò Quản trị viên xuất nhập Cloud Datastore. Thay thế PROJECT_ID và chạy lệnh sau:

    gcloud projects add-iam-policy-binding PROJECT_ID \
        --member serviceAccount:PROJECT_ID@appspot.gserviceaccount.com \
        --role roles/datastore.importExportAdmin
  2. Chỉ định vai trò Quản trị viên bộ nhớ cho bộ chứa của bạn. Thay thế PROJECT_IDBUCKET_NAME rồi chạy lệnh sau:

    gsutil iam ch serviceAccount:PROJECT_ID@appspot.gserviceaccount.com:admin \
        gs://BUCKET_NAME

Nếu bạn tắt hoặc xoá tài khoản dịch vụ mặc định App Engine, ứng dụng App Engine sẽ mất quyền truy cập vào cơ sở dữ liệu Cloud Firestore. Nếu đã tắt tài khoản dịch vụ App Engine, bạn có thể bật lại tài khoản đó, xem phần bật tài khoản dịch vụ. Nếu đã xoá tài khoản dịch vụ App Engine trong vòng 30 ngày qua, bạn có thể khôi phục tài khoản dịch vụ của mình, hãy xem phần huỷ xoá tài khoản dịch vụ.

Kiểm thử công việc Cloud Scheduler và Hàm trên đám mây

Bạn có thể kiểm thử công việc Cloud Scheduler trong trang Cloud Scheduler của bảng điều khiển Google Cloud.

  1. Chuyển đến trang Cloud Scheduler trong Google Cloud Console.
    Chuyển đến Cloud Scheduler

  2. Trong hàng cho công việc Cloud Scheduler mới, hãy nhấp vào Chạy ngay.

    Sau vài giây, công việc Cloud Scheduler sẽ cập nhật cột kết quả thành Success (Thành công) và Last run (Lần chạy gần đây nhất) thành thời gian hiện tại. Bạn có thể cần phải nhấp vào Làm mới.

Trang Cloud Scheduler chỉ xác nhận rằng công việc đã gọi Hàm trên đám mây của bạn. Mở trang Hàm trên đám mây để xem nhật ký của hàm.

Xem nhật ký của Cloud Functions

Để xem liệu Hàm trên đám mây có bắt đầu thành công một thao tác xuất hay không, hãy mở nhật ký của hàm:

Bảng điều khiển Firebase

Chuyển đến trang Cloud Functions trong bảng điều khiển của Firebase.

Chuyển đến nhật ký hàm

Bảng điều khiển Google Cloud Platform

Chuyển đến trang Cloud Functions trong Google Cloud Console.

Chuyển đến Trình xem nhật ký

Xem tiến trình xuất

Bạn có thể sử dụng lệnh gcloud firestore operations list để xem tiến trình của các thao tác xuất, hãy xem phần quản lý các thao tác xuất và nhập.

Sau khi thao tác xuất hoàn tất, bạn có thể xem các tệp đầu ra trong bộ chứa Cloud Storage:

Mở trình duyệt Cloud Storage