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" ، مع دقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.