REST Resource: projects.databases.collectionGroups.indexes

संसाधन: इंडेक्स

Cloud Firestore इंडेक्स, डेटाबेस में दस्तावेज़ों के लिए आसान और मुश्किल क्वेरी चालू करता है.

जेएसओएन के काेड में दिखाना 
{
  "name": string,
  "queryScope": enum (QueryScope),
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
फ़ील्ड
name

string

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

enum (QueryScope)

जो इंडेक्स, कलेक्शन क्वेरी के दायरे वाले इंडेक्स होते हैं वे ऐसे कलेक्शन के ख़िलाफ़ क्वेरी को अनुमति देते हैं जो किसी खास दस्तावेज़ का चाइल्ड कलेक्शन होता है. क्वेरी के समय तय किया जाता है और उसका कलेक्शन आईडी एक जैसा होता है.

कलेक्शन ग्रुप क्वेरी के दायरे वाले इंडेक्स, उन सभी कलेक्शन के लिए क्वेरी को अनुमति देते हैं जो क्वेरी के समय तय किए गए किसी खास दस्तावेज़ से डिसीस्ड हैं. ऐसे दस्तावेज़ जिनका कलेक्शन आईडी, इस इंडेक्स के जैसा ही है.
fields[]

object (IndexField)

इस इंडेक्स से काम करने वाले फ़ील्ड.

कंपोज़िट इंडेक्स के लिए, इसमें हमेशा दो या उससे ज़्यादा फ़ील्ड होते हैं. फ़ील्ड की आखिरी एंट्री हमेशा फ़ील्ड पाथ __name__ के लिए होती है. अगर फ़ील्ड बनाते समय, __name__ को आखिरी फ़ील्ड के तौर पर नहीं बताया गया था, तो वह अपने-आप उसी दिशा में जुड़ जाएगा जिस दिशा में आखिरी फ़ील्ड के लिए दिया गया था. अगर किसी कंपोज़िट इंडेक्स का फ़ाइनल फ़ील्ड दिशात्मक नहीं है, तो __name__ को ASCENDING के लिए ऑर्डर किया जाएगा (जब तक कि साफ़ तौर पर बताया न गया हो).

सिंगल फ़ील्ड इंडेक्स के लिए, यह हमेशा सिर्फ़ एक एंट्री होगी. इसका फ़ील्ड पाथ, जुड़े हुए फ़ील्ड के फ़ील्ड पाथ के बराबर होगा.
state

enum (State)

सिर्फ़ आउटपुट के लिए. इंडेक्स की सेवा की स्थिति.

तरीके

create

 कंपोज़िट इंडेक्स बनाता है.

delete

 कंपोज़िट इंडेक्स को मिटाता है.

get

 कंपोज़िट इंडेक्स लेता है.

list

 कंपोज़िट इंडेक्स की सूची बनाता है.