Method: projects.databases.exportDocuments

מייצא עותק של כל המסמכים או חלק מהם מ-Google Cloud Firestore למערכת אחסון אחרת, כגון Google Cloud Storage. ייתכן שעדכונים אחרונים למסמכים לא ישתקפו בייצוא. הייצוא מתרחש ברקע וניתן לעקוב אחר התקדמותו ולנהל אותו באמצעות משאב התפעול שנוצר. ניתן להשתמש בפלט של ייצוא רק לאחר ביצוע הפעולה הקשורה. אם פעולת ייצוא תבוטל לפני השלמתה, היא עלולה להשאיר נתונים חלקיים מאחור ב-Google Cloud Storage.

בקשת HTTP

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

כתובת האתר משתמשת בתחביר GRPC Transcoding .

פרמטרים של נתיב

פרמטרים
name

string

מסד נתונים לייצוא. צריך להיות מהצורה: projects/{projectId}/databases/{databaseId} .

גוף הבקשה

גוף הבקשה מכיל נתונים עם המבנה הבא:

ייצוג JSON
{
  "collectionIds": [
    string
  ],
  "outputUriPrefix": 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 הוא דלי (ללא נתיב מרחב שמות), תיווצר קידומת על סמך שעת ההתחלה.

גוף תגובה

אם זה מצליח, גוף התגובה מכיל מופע של Operation .

היקפי הרשאה

דורש אחד מהיקפי OAuth הבאים:

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

למידע נוסף, עיין בסקירת האימות .