Method: projects.databases.exportDocuments

Xuất bản sao của tất cả hoặc một nhóm nhỏ các tài liệu từ Google Cloud Firestore sang một hệ thống lưu trữ khác, chẳng hạn như Google Cloud Storage. Nội dung cập nhật gần đây đối với tài liệu có thể không được phản ánh trong quá trình xuất. Quá trình xuất sẽ diễn ra ở chế độ nền và bạn có thể giám sát cũng như quản lý tiến trình xuất thông qua tài nguyên Vận hành được tạo. Bạn chỉ có thể sử dụng dữ liệu xuất ra sau khi thực hiện xong thao tác liên kết. Nếu quá trình xuất bị huỷ trước khi hoàn tất, thì có thể để lại một phần dữ liệu trong Google Cloud Storage.

Để biết thêm thông tin chi tiết về hành vi xuất và định dạng đầu ra, hãy tham khảo: https://cloud.google.com/firestore/docs/manage-data/export-nhập

yêu cầu HTTP

POST https://firestore.googleapis.com/v1/{name=projects/*/databases/*}:exportDocuments

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Thông số
name

string

Bắt buộc. Cơ sở dữ liệu để xuất. Phải có dạng: projects/{projectId}/databases/{databaseId}.

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "collectionIds": [
    string
  ],
  "outputUriPrefix": string,
  "namespaceIds": [
    string
  ],
  "snapshotTime": string
}
Trường
collectionIds[]

string

Những mã nhận dạng bộ sưu tập cần xuất. Không xác định có nghĩa là tất cả các bộ sưu tập.
outputUriPrefix

string

URI đầu ra. Hiện tại, chúng tôi chỉ hỗ trợ các URI của Google Cloud Storage ở dạng: gs://BUCKET_NAME[/NAMESPACE_PATH], trong đó BUCKET_NAME là tên của bộ chứa Google Cloud Storage và NAMESPACE_PATH là một đường dẫn không gian tên không bắt buộc trên Google Cloud Storage. Khi chọn tên, hãy nhớ cân nhắc đến nguyên tắc đặt tên của Google Cloud Storage: https://cloud.google.com/storage/docs/naming. Nếu URI là một bộ chứa (không có đường dẫn không gian tên), thì một tiền tố sẽ được tạo dựa trên thời gian bắt đầu.
namespaceIds[]

string

Danh sách trống đại diện cho tất cả không gian tên. Đây là cách sử dụng ưu tiên cho các cơ sở dữ liệu không sử dụng không gian tên.

Một phần tử chuỗi trống đại diện cho không gian tên mặc định. Bạn nên sử dụng thuộc tính này nếu cơ sở dữ liệu có dữ liệu trong không gian tên không phải vùng chứa mặc định nhưng không muốn đưa dữ liệu vào vùng chứa tên đó. Mỗi không gian tên trong danh sách này phải là duy nhất.
snapshotTime

string (Timestamp format)

Dấu thời gian tương ứng với phiên bản của cơ sở dữ liệu sẽ được xuất. Dấu thời gian phải ở trong quá khứ, được làm tròn đến phút và không được cũ hơn earliestVersionTime. Nếu được chỉ định, các tài liệu đã xuất sẽ thể hiện một chế độ xem cơ sở dữ liệu nhất quán tại thời điểm được cung cấp. Nếu không, chúng tôi không đảm bảo về tính nhất quán của các tài liệu đã xuất.

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ chứa một thực thể của Operation.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Để biết thêm thông tin, hãy xem bài viết Tổng quan về việc xác thực.