तय किया गया इंडेक्स बनाता है. नए इंडेक्स की शुरुआती स्थिति CREATING
है. लौटाए गए google.longrunning.Operation
के पूरा होने पर, READY
की स्थिति दिखेगी. अगर इंडेक्स पहले से मौजूद है, तो कॉल ALREADY_EXISTS
वाली स्थिति दिखाएगा.
बनाए जाने के दौरान, इस प्रोसेस की वजह से कोई गड़बड़ी हो सकती है. इस स्थिति में, इंडेक्स ERROR
की स्थिति में चला जाएगा. गड़बड़ी की वजह डेटा को ठीक करके, इंडेक्स को delete
से हटाकर, फिर create
की मदद से इंडेक्स बनाकर इस प्रोसेस को वापस पाया जा सकता है.
एक फ़ील्ड वाले इंडेक्स नहीं बनाए जा सकते.
एचटीटीपी अनुरोध
POST https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*}/indexes
यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.
पाथ पैरामीटर
पैरामीटर | |
---|---|
parent |
उस डेटाबेस का नाम जिस पर यह इंडेक्स लागू होगा. उदाहरण के लिए: |
अनुरोध का मुख्य भाग
अनुरोध के मुख्य हिस्से में Index
का एक इंस्टेंस शामिल है.
जवाब का लेख
कामयाब होने पर, जवाब के मुख्य हिस्से में Operation
का नया इंस्टेंस शामिल किया जाता है.
अनुमति के दायरे
इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.