Method: projects.databases.exportDocuments

ส่งออกสำเนาเอกสารทั้งหมดหรือบางส่วนจาก Google Cloud Firestore ไปยังระบบพื้นที่เก็บข้อมูลอื่น เช่น Google Cloud Storage การอัปเดตเอกสารล่าสุดอาจไม่แสดงในการส่งออก การส่งออกจะเกิดขึ้นในเบื้องหลัง และคุณสามารถตรวจสอบและจัดการความคืบหน้าได้ผ่านทรัพยากรการดำเนินการที่สร้างขึ้น เอาต์พุตของการส่งออกจะใช้ได้เมื่อการดำเนินการที่เกี่ยวข้องเสร็จสิ้นเท่านั้น หากการดำเนินการส่งออกถูกยกเลิกก่อนที่จะเสร็จสมบูรณ์ ระบบอาจทิ้งข้อมูลบางส่วนไว้ใน Google Cloud Storage

ดูรายละเอียดเพิ่มเติมเกี่ยวกับลักษณะการทำงานการส่งออกและรูปแบบเอาต์พุตได้ที่ https://cloud.google.com/firestore/docs/manage-data/export-IMPORT

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
name

string

ต้องระบุ ฐานข้อมูลที่จะส่งออก ควรอยู่ในรูปแบบ: projects/{projectId}/databases/{databaseId}

เนื้อความของคำขอ

เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้

การแสดง JSON 
{
  "collectionIds": [
    string
  ],
  "outputUriPrefix": string,
  "namespaceIds": [
    string
  ],
  "snapshotTime": string
}
ช่อง
collectionIds[]

string

รหัสคอลเล็กชันที่จะส่งออก "ไม่ระบุ" หมายถึงคอลเล็กชันทั้งหมด
outputUriPrefix

string

URI เอาต์พุต ปัจจุบันรองรับเฉพาะ URI ของ Google Cloud Storage ในรูปแบบ gs://BUCKET_NAME[/NAMESPACE_PATH] โดยที่ BUCKET_NAME คือชื่อของที่เก็บข้อมูล Google Cloud Storage และ NAMESPACE_PATH คือเส้นทางเนมสเปซ Google Cloud Storage ที่ไม่บังคับ เมื่อเลือกชื่อ โปรดพิจารณาหลักเกณฑ์การตั้งชื่อ Google Cloud Storage ที่ https://cloud.google.com/storage/docs/naming หาก URI เป็นที่เก็บข้อมูล (ไม่มีเส้นทางเนมสเปซ) ระบบจะสร้างคำนำหน้าตามเวลาเริ่มต้น
namespaceIds[]

string

รายการที่ว่างเปล่าจะแสดงเนมสเปซทั้งหมด ซึ่งเป็นการใช้งานที่ต้องการสำหรับฐานข้อมูลที่ไม่ได้ใช้เนมสเปซ

องค์ประกอบสตริงว่างเปล่าแสดงเนมสเปซเริ่มต้น ควรใช้แอตทริบิวต์นี้หากฐานข้อมูลมีข้อมูลในเนมสเปซที่ไม่ใช่ค่าเริ่มต้น แต่ไม่ต้องการรวมข้อมูลดังกล่าว เนมสเปซแต่ละรายการในรายการนี้ต้องไม่ซ้ำกัน
snapshotTime

string (Timestamp format)

การประทับเวลาที่ตรงกับเวอร์ชันของฐานข้อมูลที่จะส่งออก การประทับเวลาต้องเป็นที่ผ่านมา โดยปัดเศษเป็นนาที และไม่เกิน earliestVersionTime หากระบุ เอกสารที่ส่งออกจะแสดงมุมมองที่สอดคล้องกันของฐานข้อมูล ณ เวลาที่ระบุ ไม่เช่นนั้นก็ไม่สามารถรับประกันความสอดคล้องของเอกสารที่ส่งออกได้

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Operation

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้

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

สำหรับข้อมูลเพิ่มเติม โปรดดูภาพรวมการตรวจสอบสิทธิ์