REST Resource: projects.databases.collectionGroups.indexes

संसाधन: सूचकांक

क्लाउड फायरस्टोर इंडेक्स डेटाबेस में दस्तावेज़ों के विरुद्ध सरल और जटिल क्वेरी सक्षम करते हैं।

JSON प्रतिनिधित्व
{
  "name": string,
  "queryScope": enum (QueryScope),
  "apiScope": enum (ApiScope),
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
खेत
name

string

केवल आउटपुट. इस सूचकांक के लिए एक सर्वर परिभाषित नाम. समग्र अनुक्रमितों के लिए इस नाम का रूप होगा: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id} एकल फ़ील्ड अनुक्रमणिका के लिए, यह फ़ील्ड खाली होगी।

queryScope

enum ( QueryScope )

निर्दिष्ट संग्रह क्वेरी दायरे वाले इंडेक्स उस संग्रह के विरुद्ध प्रश्नों की अनुमति देते हैं जो एक विशिष्ट दस्तावेज़ का बच्चा है, जो क्वेरी समय पर निर्दिष्ट होता है, और जिसकी संग्रह आईडी समान होती है।

निर्दिष्ट संग्रह समूह क्वेरी स्कोप वाले इंडेक्स, क्वेरी समय पर निर्दिष्ट एक विशिष्ट दस्तावेज़ से निकले सभी संग्रहों के विरुद्ध क्वेरी की अनुमति देते हैं, और जिनकी संग्रह आईडी इस इंडेक्स के समान होती है।

apiScope

enum ( ApiScope )

इस सूचकांक द्वारा समर्थित एपीआई दायरा।

fields[]

object ( IndexField )

इस सूचकांक द्वारा समर्थित फ़ील्ड.

समग्र अनुक्रमित के लिए, इसके लिए न्यूनतम 2 और अधिकतम 100 फ़ील्ड की आवश्यकता होती है। अंतिम फ़ील्ड प्रविष्टि हमेशा फ़ील्ड पथ __name__ के लिए होती है। यदि, निर्माण पर, __name__ अंतिम फ़ील्ड के रूप में निर्दिष्ट नहीं किया गया था, तो इसे अंतिम परिभाषित फ़ील्ड के समान दिशा के साथ स्वचालित रूप से जोड़ा जाएगा। यदि समग्र सूचकांक में अंतिम फ़ील्ड दिशात्मक नहीं है, तो __name__ आरोही क्रम में रखा जाएगा (जब तक कि स्पष्ट रूप से निर्दिष्ट न किया गया हो)।

एकल फ़ील्ड इंडेक्स के लिए, यह हमेशा संबंधित फ़ील्ड के फ़ील्ड पथ के बराबर फ़ील्ड पथ के साथ बिल्कुल एक प्रविष्टि होगी।

state

enum ( State )

केवल आउटपुट. सूचकांक की सेवा स्थिति.

तरीकों

create

एक समग्र सूचकांक बनाता है.

delete

एक समग्र सूचकांक हटाता है.

get

एक समग्र सूचकांक प्राप्त होता है।

list

समग्र सूचकांक सूचीबद्ध करता है।