REST Resource: projects.databases.indexes

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

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

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

string

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

string

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

object (IndexField)

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

enum (State)

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

IndexField

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

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

string

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

enum (Mode)

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

मोड

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

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

स्थिति

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

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

तरीके

create

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

delete

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

get

 इंडेक्स करता है.

list

 यह डायलॉग बॉक्स, तय किए गए फ़िल्टर से मैच करने वाले इंडेक्स की सूची बनाता है.