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

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมการตรวจสอบสิทธิ์