इंडेक्स
FirestoreAdmin
(इंटरफ़ेस)CreateIndexRequest
(मैसेज)DeleteIndexRequest
(मैसेज)ExportDocumentsMetadata
(मैसेज)ExportDocumentsRequest
(मैसेज)ExportDocumentsResponse
(मैसेज)GetIndexRequest
(मैसेज)ImportDocumentsMetadata
(मैसेज)ImportDocumentsRequest
(मैसेज)Index
(मैसेज)Index.State
(enum)IndexField
(मैसेज)IndexField.Mode
(enum)IndexOperationMetadata
(मैसेज)IndexOperationMetadata.OperationType
(enum)ListIndexesRequest
(मैसेज)ListIndexesResponse
(मैसेज)LocationMetadata
(मैसेज)OperationState
(enum)Progress
(मैसेज)
FirestoreAdmin
Cloud Firestore एडमिन एपीआई.
यह एपीआई, Cloud Firestore के लिए कई एडमिन सेवाएं उपलब्ध कराता है.
कॉन्सेप्ट
प्रोजेक्ट, डेटाबेस, नेमस्पेस, कलेक्शन, और दस्तावेज़ का इस्तेमाल, Google Cloud Firestore API में बताए गए तरीके से किया जाता है.
ऑपरेशन: एक ऑपरेशन बैकग्राउंड में किए जा रहे काम को दिखाता है.
सेवाएं
इंडेक्स
इंडेक्स सेवा, Cloud Firestore इंडेक्स को मैनेज करती है.
इंडेक्स बनाने की प्रोसेस, एसिंक्रोनस तरीके से की जाती है. ऐसे हर एसिंक्रोनस ऑपरेशन के लिए एक ऑपरेशन संसाधन बनाया जाता है. ऑपरेशन की स्थिति (जिसमें किसी भी तरह की गड़बड़ी हुई है) के बारे में ऑपरेशन संसाधन से क्वेरी की जा सकती है.
मेटाडेटा
Cloud Firestore में मौजूद डेटा के बारे में मेटाडेटा और आंकड़ों की जानकारी देता है. इस एपीआई के हिस्से के रूप में दिया गया डेटा पुराना हो सकता है.
कार्रवाई
ऑपरेशन से जुड़े कलेक्शन में, किसी प्रोजेक्ट के लिए की गई कार्रवाइयों का रिकॉर्ड होता है. इसमें किसी भी जारी कार्रवाई का रिकॉर्ड भी शामिल होता है. ऑपरेशन सीधे तौर पर नहीं, बल्कि दूसरे कलेक्शन या संसाधनों को कॉल करके बनाए जाते हैं.
अभी तक पूरी न हुई कार्रवाई को रद्द किया जा सकता है. रद्द करने का अनुरोध एसिंक्रोनस होता है. रद्द करने का अनुरोध करने के बाद कुछ समय तक कार्रवाई जारी रह सकती है.
पूरे हो चुके ऑपरेशन को मिटाया जा सकता है, ताकि उसे ऑपरेशन कलेक्शन के हिस्से के तौर पर सूची में न रखा जाए.
कार्रवाइयां FirestoreAdmin
सेवा से बनाई जाती हैं, लेकिन इन्हें सेवा google.longrunning.Operations
से ऐक्सेस किया जाता है.
CreateIndex |
---|
तय किया गया इंडेक्स बनाता है. नए बनाए गए इंडेक्स की शुरुआती स्थिति लिंक बनाते समय, इस प्रोसेस में कोई गड़बड़ी हो सकती है. ऐसे में, इंडेक्स को एक ही फ़ील्ड वाले इंडेक्स नहीं बनाए जा सकते.
|
DeleteIndex |
---|
इंडेक्स को मिटाता है.
|
ExportDocuments |
---|
Google Cloud Firestore से सभी या उनके सबसेट की कॉपी को Google Cloud Storage जैसे किसी दूसरे स्टोरेज सिस्टम में एक्सपोर्ट करता है. ऐसा हो सकता है कि दस्तावेज़ों में हाल ही में किए गए बदलाव एक्सपोर्ट में न दिखें. एक्सपोर्ट, बैकग्राउंड में होता है और इसकी प्रोग्रेस को, बनाए गए ऑपरेशन संसाधन की मदद से मॉनिटर और मैनेज किया जा सकता है. एक्सपोर्ट की प्रोसेस के आउटपुट का इस्तेमाल, उससे जुड़ी कार्रवाई पूरी होने के बाद ही किया जा सकता है. अगर किसी एक्सपोर्ट की प्रोसेस को पूरा होने से पहले ही रद्द कर दिया जाता है, तो हो सकता है कि Google Cloud Storage में उसका कुछ डेटा सेव न हो.
|
GetIndex |
---|
इंडेक्स करता है.
|
ImportDocuments |
---|
Google Cloud Firestore में दस्तावेज़ इंपोर्ट करता है. एक ही नाम वाले मौजूदा दस्तावेज़ों को ओवरराइट कर दिया जाता है. इंपोर्ट, बैकग्राउंड में होता है और इसकी प्रोग्रेस को, बनाए गए ऑपरेशन संसाधन से मॉनिटर और मैनेज किया जा सकता है. अगर ExportDocuments की कार्रवाई रद्द कर दी जाती है, तो हो सकता है कि डेटा के किसी सबसेट को Cloud Firestore में इंपोर्ट कर लिया गया हो.
|
ListIndexes |
---|
यह डायलॉग बॉक्स, तय किए गए फ़िल्टर से मैच करने वाले इंडेक्स की सूची बनाता है.
|
CreateIndexRequest
FirestoreAdmin.CreateIndex
का अनुरोध.
फ़ील्ड | |
---|---|
parent |
उस डेटाबेस का नाम जिस पर यह इंडेक्स लागू होगा. उदाहरण के लिए: |
index |
वह इंडेक्स जिसे बनाना है. नाम और स्थिति फ़ील्ड सिर्फ़ आउटपुट के लिए हैं और इन्हें अनदेखा कर दिया जाएगा. कुछ सिंगल फ़ील्ड इंडेक्स, बनाए या मिटाए नहीं जा सकते. |
DeleteIndexRequest
FirestoreAdmin.DeleteIndex
का अनुरोध.
फ़ील्ड | |
---|---|
name |
इंडेक्स का नाम. उदाहरण के लिए: |
ExportDocumentsMetadata
ExportDocuments की कार्रवाइयों के लिए मेटाडेटा.
फ़ील्ड | |
---|---|
start_time |
वह समय जब कार्रवाई शुरू हुई. |
end_time |
कार्रवाई खत्म होने का समय, चाहे वह हो या किसी और तरीके से. अगर कार्रवाई अब भी चालू है, तो सेट न करें. |
operation_state |
एक्सपोर्ट कार्रवाई की स्थिति. |
progress_documents |
प्रोसेस किए गए दस्तावेज़ों की संख्या का अनुमान. |
progress_bytes |
प्रोसेस किए गए बाइट की संख्या का अनुमान. |
collection_ids[] |
कौनसे संग्रह आईडी एक्सपोर्ट किए जा रहे हैं. |
output_uri_prefix |
जहां इकाइयों को एक्सपोर्ट किया जा रहा है. |
ExportDocumentsRequest
FirestoreAdmin.ExportDocuments
का अनुरोध.
फ़ील्ड | |
---|---|
name |
एक्सपोर्ट किया जाने वाला डेटाबेस. वह इस रूप में होना चाहिए: |
collection_ids[] |
किन संग्रह आईडी को एक्सपोर्ट करना है. तय नहीं का मतलब सभी कलेक्शन. |
output_uri_prefix |
आउटपुट यूआरआई. फ़िलहाल, यह फ़ॉर्म |
ExportDocumentsResponse
google.longrunning.Operation
रिस्पॉन्स फ़ील्ड में लौटाया गया.
फ़ील्ड | |
---|---|
output_uri_prefix |
आउटपुट फ़ाइलों की जगह. कार्रवाई पूरी होने के बाद, इसका इस्तेमाल Cloud Firestore (इस प्रोजेक्ट या किसी अन्य प्रोजेक्ट) में इंपोर्ट शुरू करने के लिए किया जा सकता है. |
GetIndexRequest
FirestoreAdmin.GetIndex
का अनुरोध.
फ़ील्ड | |
---|---|
name |
इंडेक्स का नाम. उदाहरण के लिए: |
ImportDocumentsMetadata
PriceDocuments की कार्रवाइयों के लिए मेटाडेटा.
फ़ील्ड | |
---|---|
start_time |
वह समय जब कार्रवाई शुरू हुई. |
end_time |
कार्रवाई खत्म होने का समय, चाहे वह हो या किसी और तरीके से. अगर कार्रवाई अब भी चालू है, तो सेट न करें. |
operation_state |
इंपोर्ट करने की कार्रवाई की स्थिति. |
progress_documents |
प्रोसेस किए गए दस्तावेज़ों की संख्या का अनुमान. |
progress_bytes |
प्रोसेस किए गए बाइट की संख्या का अनुमान. |
collection_ids[] |
कौनसे संग्रह आईडी इंपोर्ट किए जा रहे हैं. |
input_uri_prefix |
इंपोर्ट किए जा रहे दस्तावेज़ों की जगह. |
ImportDocumentsRequest
FirestoreAdmin.ImportDocuments
का अनुरोध.
फ़ील्ड | |
---|---|
name |
डेटाबेस जिसमें इंपोर्ट किया जाना है. वह इस रूप में होना चाहिए: |
collection_ids[] |
कौनसे संग्रह आईडी इंपोर्ट किए जाने हैं. कोई वैल्यू तय नहीं करने का मतलब है कि इंपोर्ट में शामिल सभी कलेक्शन शामिल हैं. |
input_uri_prefix |
एक्सपोर्ट की गई फ़ाइलों की जगह. यह सही से पूरा हो चुके किसी एक्सपोर्ट से एक्सपोर्ट किए गए ExportDocumentsResponse के formula_uri_prefix से मेल खाना चाहिए. देखें: |
इंडेक्स
इंडेक्स की परिभाषा.
फ़ील्ड | |
---|---|
name |
इंडेक्स के संसाधन का नाम. सिर्फ़ आउटपुट के लिए. |
collection_id |
वह कलेक्शन आईडी जिस पर यह इंडेक्स लागू होता है. ज़रूरी है. |
fields[] |
इंडेक्स करने के लिए फ़ील्ड. |
state |
इंडेक्स की स्थिति. सिर्फ़ आउटपुट के लिए. |
स्थिति
किसी इंडेक्स की स्थिति. इंडेक्स बनाने के दौरान, कोई इंडेक्स CREATING
स्थिति में होगा. अगर इंडेक्स बन जाता है, तो यह READY
स्थिति में चला जाएगा. अगर इंडेक्स नहीं बनाया जा सकता है, तो यह ERROR
स्थिति में बदल जाएगा.
Enums | |
---|---|
STATE_UNSPECIFIED |
राज्य की जानकारी नहीं दी गई है. |
CREATING |
इंडेक्स बनाया जा रहा है. इंडेक्स के लिए एक लंबे समय तक चलने वाली कार्रवाई चल रही है. दस्तावेज़ लिखते समय इंडेक्स को अपडेट किया जाता है. कुछ इंडेक्स डेटा मौजूद हो सकता है. |
READY |
इंडेक्स इस्तेमाल के लिए तैयार है. दस्तावेज़ लिखते समय इंडेक्स को अपडेट किया जाता है. इंडेक्स, सेव किए गए उन सभी दस्तावेज़ों से पूरी तरह भर जाता है जिन पर यह लागू होता है. |
ERROR |
इंडेक्स बनाया जा रहा था, लेकिन कोई गड़बड़ी हुई. इंडेक्स के लिए, लंबे समय तक चलने वाली कोई कार्रवाई नहीं है और सबसे हाल ही में पूरी हुई कार्रवाई पूरी नहीं हुई. दस्तावेज़ लिखते समय इंडेक्स को अपडेट नहीं किया जाता. कुछ इंडेक्स डेटा मौजूद हो सकता है. |
IndexField
इंडेक्स का फ़ील्ड.
फ़ील्ड | |
---|---|
field_path |
फ़ील्ड का पाथ. इसे [google.firestore.v1beta1.Document.fields][fields] में बताए गए फ़ील्ड पाथ स्पेसिफ़िकेशन से मेल खाना चाहिए. खास फ़ील्ड पाथ |
mode |
फ़ील्ड का मोड. |
मोड
मोड से तय होता है कि फ़ील्ड को कैसे इंडेक्स किया जाएगा.
Enums | |
---|---|
MODE_UNSPECIFIED |
मोड की जानकारी नहीं है. |
ASCENDING |
फ़ील्ड की वैल्यू को इंडेक्स किया जाता है, ताकि बढ़ते क्रम में क्रम में लगाया जा सके. साथ ही, <, >, <=, >=, और = से क्वेरी की जा सके. |
DESCENDING |
फ़ील्ड की वैल्यू को इंडेक्स किया जाता है, ताकि सीक्वेंसिंग को घटते क्रम में रखा जा सके. साथ ही, <, >, <=, >=, और = से क्वेरी की जा सके. |
ARRAY_CONTAINS |
फ़ील्ड के अरे की वैल्यू को इंडेक्स किया जाता है, ताकि ARRAY_CONTAINS क्वेरी का इस्तेमाल करके, पैसे चुकाकर सदस्यता लेने की सुविधा दी जा सके. |
IndexOperationMetadata
इंडेक्स की कार्रवाइयों के लिए मेटाडेटा. यह मेटाडेटा, google.longrunning.Operation
के मेटाडेटा फ़ील्ड में जानकारी अपने-आप भर देता है.
फ़ील्ड | |
---|---|
start_time |
वह समय जब कार्रवाई शुरू हुई. |
end_time |
कार्रवाई खत्म होने का समय, चाहे वह हो या किसी और तरीके से. अगर कार्रवाई अब भी चालू है, तो सेट न करें. |
index |
वह इंडेक्स रिसॉर्स जिस पर यह कार्रवाई काम कर रही है. उदाहरण के लिए: |
operation_type |
इंडेक्स की कार्रवाई का टाइप. |
cancelled |
अगर |
document_progress |
मौजूदा कार्रवाई की प्रोग्रेस, दस्तावेज़ों की संख्या के हिसाब से. |
OperationType
इंडेक्स की कार्रवाई का टाइप.
Enums | |
---|---|
OPERATION_TYPE_UNSPECIFIED |
नहीं बताया गया है सर्वर ने कभी सेट नहीं किया. |
CREATING_INDEX |
कार्रवाई से इंडेक्स बनाया जा रहा है. CreateIndex कॉल से शुरू किया गया. |
ListIndexesRequest
FirestoreAdmin.ListIndexes
का अनुरोध.
फ़ील्ड | |
---|---|
parent |
डेटाबेस का नाम. उदाहरण के लिए: |
filter |
|
page_size |
सूची पेज का स्टैंडर्ड साइज़. |
page_token |
स्टैंडर्ड लिस्ट पेज का टोकन. |
ListIndexesResponse
FirestoreAdmin.ListIndexes
के लिए रिस्पॉन्स.
फ़ील्ड | |
---|---|
indexes[] |
इंडेक्स. |
next_page_token |
स्टैंडर्ड लिस्ट नेक्स्ट-पेज टोकन. |
LocationMetadata
इस टाइप के लिए कोई फ़ील्ड नहीं है.
google.cloud.location.Location.metadata
के लिए मेटाडेटा मैसेज.
OperationState
किसी जारी कार्रवाई के लिए अलग-अलग संभावित स्थितियां.
Enums | |
---|---|
STATE_UNSPECIFIED |
नहीं बताया गया है |
INITIALIZING |
अनुरोध को प्रोसेस करने के लिए तैयार किया जा रहा है. |
PROCESSING |
अनुरोध सक्रिय रूप से प्रोसेस किया जा रहा है. |
CANCELLING |
कार्रवाई पर उपयोगकर्ता को google.longrunning.Operations.CancelOperation कॉल करने के बाद, अनुरोध रद्द होने की प्रोसेस जारी है. |
FINALIZING |
अनुरोध को प्रोसेस कर दिया गया है और इस पर काम चल रहा है. |
SUCCESSFUL |
अनुरोध पूरा हो गया. |
FAILED |
अनुरोध पर कार्रवाई पूरी हो गई, लेकिन उसमें कोई गड़बड़ी हुई. |
CANCELLED |
उपयोगकर्ता को google.longrunning.Operations.CancelOperation कॉल करने के बाद, अनुरोध को रद्द कर दिया गया. |
प्रगति
किसी खास मेट्रिक की प्रोग्रेस को मेज़र करता है.
फ़ील्ड | |
---|---|
work_completed |
अनुमान के मुताबिक कितना काम पूरा हुआ है. ध्यान दें कि यह |
work_estimated |
यह एक अनुमान होता है कि कितना काम करने की ज़रूरत है. अनुमानित काम की जानकारी उपलब्ध न होने पर, शून्य. काम के साथ-साथ बदलाव हो सकता है. |