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

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