REST Resource: projects.databases.collectionGroups.indexes

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

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

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__ को ASCENDING के लिए क्रम में लगाया जाएगा (जब तक कि साफ़ तौर पर बताया न गया हो).

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

enum (State)

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

तरीके

create

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

delete

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

get

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

list

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