ייצוא עותק של כל המסמכים או של קבוצת משנה שלהם מ-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 |
חובה. מסד הנתונים לייצוא. הוא אמור להופיע בפורמט: |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "collectionIds": [ string ], "outputUriPrefix": string, "namespaceIds": [ string ], "snapshotTime": string } |
שדות | |
---|---|
collectionIds[] |
אילו מזהי אוספים לייצא אם לא צוין אחרת, המשמעות היא כל האוספים. |
outputUriPrefix |
ה-URI של הפלט. נכון לעכשיו יש תמיכה במזהי URI של Google Cloud Storage בצורה הבאה: |
namespaceIds[] |
רשימה ריקה מייצגת את כל מרחבי השמות. זהו השימוש המועדף במסדי נתונים שלא משתמשים במרחבי שמות. רכיב מחרוזת ריק מייצג את ברירת המחדל של מרחב השמות. צריך להשתמש באפשרות הזו אם מסד הנתונים מכיל נתונים במרחבי שמות שאינם מוגדרים כברירת מחדל, אבל הוא לא רוצה לכלול אותם. כל מרחב שמות ברשימה זו חייב להיות ייחודי. |
snapshotTime |
חותמת הזמן שתואמת לגרסת מסד הנתונים שרוצים לייצא. חותמת הזמן חייבת להיות בעבר, מעוגלת לדקה ולא מלפני יותר מ- חותמת זמן בפורמט "זולו" RFC3339 UTC, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה מכיל מופע של Operation
.
היקפי הרשאות
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
מידע נוסף זמין בסקירה הכללית על אימות.