Method: projects.databases.exportDocuments

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

एक्सपोर्ट के व्यवहार और आउटपुट फ़ॉर्मैट के बारे में ज़्यादा जानकारी के लिए यहां जाएं: https://cloud.google.com/firestore/docs/manage-data/export-import

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

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

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

पाथ के पैरामीटर

पैरामीटर
name

string

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

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

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

जेएसओएन के काेड में दिखाना 
{
  "collectionIds": [
    string
  ],
  "outputUriPrefix": string,
  "namespaceIds": [
    string
  ],
  "snapshotTime": 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. अगर यूआरआई एक बकेट (बिना नेमस्पेस पाथ के) है, तो शुरुआत के समय के आधार पर प्रीफ़िक्स जनरेट किया जाएगा.
namespaceIds[]

string

एक खाली सूची सभी नेमस्पेस को दिखाती है. यह उन डेटाबेस के लिए इस्तेमाल करने का पसंदीदा तरीका है जो नेमस्पेस का इस्तेमाल नहीं करते.

खाली स्ट्रिंग एलिमेंट से डिफ़ॉल्ट नेमस्पेस दिखाया जाता है. इसका इस्तेमाल तब किया जाना चाहिए, जब डेटाबेस में डेटा, नॉन-डिफ़ॉल्ट नेमस्पेस में है, लेकिन उसे शामिल नहीं करना है. इस सूची में हर नेमस्पेस यूनीक होना चाहिए.
snapshotTime

string (Timestamp format)

एक्सपोर्ट किए जाने वाले डेटाबेस के वर्शन से जुड़ा टाइमस्टैंप. टाइमस्टैंप अतीत में होना चाहिए, मिनट के हिसाब से पूर्णांक होना चाहिए और earliestVersionTime से पहले का नहीं होना चाहिए. अगर इसके बारे में बताया गया है, तो एक्सपोर्ट किए गए दस्तावेज़ में, दिए गए समय पर डेटाबेस का एक जैसा व्यू दिखेगा. ऐसा न होने पर, एक्सपोर्ट किए गए दस्तावेज़ों के मेल खाने की कोई गारंटी नहीं है.

RFC3339 यूटीसी "ज़ुलु" फ़ॉर्मैट में एक टाइमस्टैंप, जिसमें नैनोसेकंड का रिज़ॉल्यूशन और नौ फ़्रैक्शनल अंक हो सकते हैं. उदाहरण: "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

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