Method: projects.databases.exportDocuments

दस्तावेज़ों के सभी या एक सबसेट को Google Cloud Firestore से किसी दूसरे स्टोरेज सिस्टम में एक्सपोर्ट करता है, जैसे कि Google Cloud Storage. ऐसा हो सकता है कि दस्तावेज़ों में हाल ही में किए गए अपडेट, एक्सपोर्ट में न दिखें. एक्सपोर्ट, बैकग्राउंड में होता है. एक्सपोर्ट की प्रोग्रेस को, बनाए गए ऑपरेशन संसाधन के ज़रिए मॉनिटर और मैनेज किया जा सकता है. संबंधित कार्रवाई पूरी होने के बाद ही, एक्सपोर्ट के आउटपुट का इस्तेमाल किया जा सकता है. अगर एक्सपोर्ट की प्रोसेस पूरी होने से पहले ही रद्द कर दी जाती है, तो हो सकता है कि डेटा का कुछ हिस्सा Google Cloud Storage में न रहे.

एचटीटीपी अनुरोध

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

यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

पाथ पैरामीटर

पैरामीटर
name

string

एक्सपोर्ट किया जाने वाला डेटाबेस. इसका फ़ॉर्मैट ऐसा होना चाहिए: projects/{projectId}/databases/{databaseId}.

अनुरोध का मुख्य भाग

अनुरोध के मुख्य हिस्से में, यहां दिए गए स्ट्रक्चर का डेटा शामिल होता है:

JSON के काेड में दिखाना 
{
  "collectionIds": [
    string
  ],
  "outputUriPrefix": string
}
फ़ील्ड
collectionIds[]

string

कौनसे कलेक्शन आईडी एक्सपोर्ट करने हैं. जिस कलेक्शन की जानकारी नहीं दी गई है उसका मतलब है कि सभी कलेक्शन.
outputUriPrefix

string

आउटपुट यूआरआई. फ़िलहाल, यह फ़ॉर्म gs://BUCKET_NAME[/NAMESPACE_PATH] के Google Cloud Storage के यूआरआई के साथ ही काम करता है. इसमें BUCKET_NAME, Google Cloud Storage बकेट का नाम है और NAMESPACE_PATH, Google Cloud Storage नेमस्पेस का पाथ है. हालांकि, इसका इस्तेमाल करना ज़रूरी नहीं है. कोई नाम चुनते समय, Google Cloud Storage के नाम रखने के दिशा-निर्देशों को ध्यान में रखें: https://cloud.google.com/storage/docs/naming. अगर यूआरआई एक बकेट (बिना नेमस्पेस पाथ के) है, तो शुरुआत के समय के आधार पर एक प्रीफ़िक्स जनरेट किया जाएगा.

जवाब का लेख

कामयाब होने पर, जवाब के मुख्य हिस्से में Operation का एक इंस्टेंस शामिल होता है.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

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

ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.