REST Resource: projects.databases.indexes

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

इंडेक्स की परिभाषा.

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

string

इंडेक्स के संसाधन का नाम. सिर्फ़ आउटपुट के लिए.
collectionId

string

वह कलेक्शन आईडी जिस पर यह इंडेक्स लागू होता है. ज़रूरी है.
fields[]

object (IndexField)

इंडेक्स किए जाने वाले फ़ील्ड.
state

enum (State)

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

इंडेक्सफ़ील्ड

इंडेक्स का फ़ील्ड.

JSON के काेड में दिखाना 
{
  "fieldPath": string,
  "mode": enum (Mode)
}
फ़ील्ड
fieldPath

string

फ़ील्ड का पाथ. यह [google.firestore.v1beta1.Document.fields][fields] में बताई गई फ़ील्ड पाथ की खास बातों से मेल खाना चाहिए. खास फ़ील्ड पाथ __name__ का इस्तेमाल खुद या पाथ के आखिर में किया जा सकता है. __type__ का इस्तेमाल सिर्फ़ पाथ के आखिर में किया जा सकता है.
mode

enum (Mode)

फ़ील्ड का मोड.

मोड

मोड से यह तय होता है कि किसी फ़ील्ड को कैसे इंडेक्स किया जाता है.

एनम्स
MODE_UNSPECIFIED मोड की जानकारी नहीं है.
ASCENDING फ़ील्ड की वैल्यू को इंडेक्स किया जाता है, ताकि वे बढ़ते क्रम में काम कर सकें. साथ ही, <, >, <=, >=, और = के हिसाब से क्वेरी भी की जा सकती है.
DESCENDING फ़ील्ड की वैल्यू को इंडेक्स किया जाता है, ताकि क्रम को घटते क्रम में चलाया जा सके और <, >, <=, >=, और = के हिसाब से क्वेरी भी की जा सके.
ARRAY_CONTAINS फ़ील्ड की अरे वैल्यू को इंडेक्स किया जाता है, ताकि ARRAY_CONTAINS क्वेरी का इस्तेमाल करके सदस्यता ली जा सके.

राज्य

इंडेक्स की स्थिति. इंडेक्स बनाने के दौरान, इंडेक्स CREATING की स्थिति में होगा. अगर इंडेक्स बन जाता है, तो इसका स्टेटस READY में बदल जाएगा. अगर इंडेक्स नहीं बन पाता है, तो इसका स्टेटस ERROR में बदल जाएगा.

एनम्स
STATE_UNSPECIFIED राज्य की जानकारी नहीं है.
CREATING इंडेक्स बनाया जा रहा है. इंडेक्स करने के लिए, लंबे समय से एक प्रोसेस चल रही है. कोई दस्तावेज़ लिखते समय इंडेक्स को अपडेट किया जाता है. इंडेक्स किया गया कुछ डेटा मौजूद हो सकता है.
READY इंडेक्स इस्तेमाल के लिए तैयार है. कोई दस्तावेज़ लिखते समय इंडेक्स को अपडेट किया जाता है. इंडेक्स में, सेव किए गए उन सभी दस्तावेज़ों से पूरी जानकारी अपने-आप भर जाती है जिन पर यह लागू होता है.
ERROR इंडेक्स बनाया जा रहा था, लेकिन कोई गड़बड़ी हुई. इंडेक्स के लिए, लंबे समय तक चलने वाली कोई कार्रवाई नहीं है. साथ ही, हाल ही में खत्म हुई, लंबे समय तक चलने वाली कार्रवाई नहीं हो सकी. दस्तावेज़ लिखते समय इंडेक्स को अपडेट नहीं किया जाता. इंडेक्स किया गया कुछ डेटा मौजूद हो सकता है.

तरीके

create

 तय किया गया इंडेक्स बनाता है.

delete

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

get

 इंडेक्स मिलता है.

list

 ऐसे इंडेक्स की सूची बनाता है जो तय फ़िल्टर से मेल खाते हैं.