Method: projects.databases.collectionGroups.fields.patch

फ़ील्ड कॉन्फ़िगरेशन को अपडेट करता है. फ़िलहाल, फ़ील्ड अपडेट सिर्फ़ सिंगल फ़ील्ड इंडेक्स कॉन्फ़िगरेशन पर लागू होते हैं. हालांकि, FirestoreAdmin.UpdateField पर किए जाने वाले कॉल के लिए फ़ील्ड मास्क देना चाहिए. ऐसा करके, किसी ऐसे कॉन्फ़िगरेशन को बदलने से बचा जा सकता है जिसके बारे में कॉलर को पता न हो. फ़ील्ड मास्क को इस तरह से दिखाया जाना चाहिए: { paths: "indexConfig" }.

यह कॉल, google.longrunning.Operation दिखाता है, जिसका इस्तेमाल फ़ील्ड अपडेट की स्थिति को ट्रैक करने के लिए किया जा सकता है. कार्रवाई का मेटाडेटा FieldOperationMetadata टाइप होगा.

डेटाबेस के लिए डिफ़ॉल्ट फ़ील्ड सेटिंग को कॉन्फ़िगर करने के लिए, रिसॉर्स नाम के साथ खास Field का इस्तेमाल करें: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/*.

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

PATCH https://firestore.googleapis.com/v1beta2/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}

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

पाथ पैरामीटर

पैरामीटर
field.name

string

projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath} फ़ॉर्म का फ़ील्ड नाम

फ़ील्ड पाथ, कोई सामान्य फ़ील्ड नाम हो सकता है , जैसे कि address या MapValue में मौजूद फ़ील्ड का पाथ, जैसे कि address.city या कोई खास फ़ील्ड पाथ. सिर्फ़ * खास फ़ील्ड ही मान्य है. यह किसी भी फ़ील्ड के बारे में बताता है.

फ़ील्ड पाथ को (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include:*,., ``` (backtick),[,]` और किसी ASCII (ASCII) सिम्बॉलिक वर्णों का इस्तेमाल करके कोट किया जा सकता है.

उदाहरण: (ध्यान दें: यहां टिप्पणियां मार्कडाउन सिंटैक्स में लिखी जाती हैं, इसलिए कोड ब्लॉक को दिखाने के लिए बैकटिक की एक अतिरिक्त लेयर होती है) \address.city`represents a field namedaddress.city, not the map key शहरin the fieldपता. `*`represents a field named*`, इसमें कोई फ़ील्ड नहीं होता.

खास Field में, सभी फ़ील्ड को इंडेक्स करने की डिफ़ॉल्ट सेटिंग होती हैं. इस फ़ील्ड के संसाधन का नाम यह है: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* इस Field में तय किए गए इंडेक्स, उन सभी फ़ील्ड पर लागू किए जाएंगे जिनमें अपना Field इंडेक्स कॉन्फ़िगरेशन नहीं है.

क्वेरी पैरामीटर

पैरामीटर
updateMask

string (FieldMask format)

फ़ील्ड के हिसाब से मास्क. अगर तय किया गया है, तो फ़ील्ड में सिर्फ़ इस फ़ील्ड_मास्क से तय किए गए कॉन्फ़िगरेशन को अपडेट किया जाएगा.

यह फ़ील्ड के पूरी तरह क्वालिफ़ाइड नाम की सूची है, जिसे कॉमा लगाकर अलग किया गया है. उदाहरण: "user.displayName,photo".

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

अनुरोध के मुख्य हिस्से में Field का एक इंस्टेंस शामिल है.

जवाब का लेख

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

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

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

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

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