Cloud Firestore इंडेक्स की परिभाषा का रेफ़रंस

Cloud Firestore सबसे ज़्यादा इस्तेमाल किए जाने वाले डेटा के लिए, अपने-आप इंडेक्स बनाता है टाइप की गई क्वेरी के लिए उपलब्ध है, लेकिन इससे आपको कस्टम इंडेक्स और इंडेक्स ओवरराइड को Cloud Firestore गाइड में बताया गया है.

आप Firebase कंसोल में कस्टम इंडेक्स बना सकते हैं, उनमें बदलाव कर सकते हैं, और उन्हें डिप्लॉय कर सकते हैं या सीएलआई का इस्तेमाल करके ऐसा किया जा सकता है. सीएलआई से, अपनी इंडेक्स कॉन्फ़िगरेशन फ़ाइल में बदलाव करें डिफ़ॉल्ट फ़ाइल नाम firestore.indexes.json पर जाएं और firebase deploy निर्देश का इस्तेमाल करके डिप्लॉय करें.

firebase firestore:indexes का इस्तेमाल करके, सीएलआई के साथ इंडेक्स एक्सपोर्ट किए जा सकते हैं.

इंडेक्स कॉन्फ़िगरेशन फ़ाइल एक ऑब्जेक्ट के बारे में बताती है, जिसमें indexes कलेक्शन और वैकल्पिक fieldOverrides कलेक्शन. यहां एक उदाहरण दिया गया है:

{
  // Required, specify compound and vector indexes
  indexes: [
    {
      collectionGroup: "posts",
      queryScope: "COLLECTION",
      fields: [
        { fieldPath: "author", arrayConfig: "CONTAINS" },
        { fieldPath: "timestamp", order: "DESCENDING" }
      ]
    },
    {
      collectionGroup: "coffee-beans",
      queryScope: "COLLECTION",
      fields: [
        {
          fieldPath: "embedding_field",
          vectorConfig: { dimension: 256, flat: {} }
        }
      ]
    }
  ],

  // Optional, disable indexes or enable single-field collection group indexes
  fieldOverrides: [
    {
      collectionGroup: "posts",
      fieldPath: "myBigMapField",
      // We want to disable indexing on our big map field, and so empty the indexes array
      indexes: []
    }
  ]
}

इंडेक्स कॉन्फ़िगरेशन को डिप्लॉय करना

firebase deploy कमांड की मदद से, अपने इंडेक्स कॉन्फ़िगरेशन को डिप्लॉय करें. अगर आपको अपने प्रोजेक्ट में कॉन्फ़िगर किए गए डेटाबेस के लिए इंडेक्स डिप्लॉय करना चाहते हैं. --only firestore फ़्लैग. इस निर्देश के लिए विकल्प संदर्भ देखें.

डिप्लॉय किए गए इंडेक्स की सूची बनाने के लिए, firebase firestore:indexes कमांड चलाएं. जोड़ें आपके अलावा किसी दूसरे डेटाबेस के इंडेक्स को सूची में शामिल करने के लिए --database=<databaseID> फ़्लैग प्रोजेक्ट के डिफ़ॉल्ट डेटाबेस में होता है.

अगर Firebase कंसोल का इस्तेमाल करके, इंडेक्स में बदलाव किया जाता है, तो यह भी पक्का करें कि अपनी लोकल इंडेक्स फ़ाइल अपडेट करने में मदद मिलती है. इंडेक्स को मैनेज करने के बारे में ज़्यादा जानने के लिए, Cloud Firestore गाइड.

JSON फ़ॉर्मैट

इंडेक्स

indexes कलेक्शन में एक ऑब्जेक्ट का स्कीमा इस तरह है. ज़रूरी नहीं है प्रॉपर्टी की पहचान ? वर्ण से की जाती है.

ध्यान दें कि Cloud Firestore दस्तावेज़ के फ़ील्ड को सिर्फ़ एक मोड में इंडेक्स किया जा सकता है, इसलिए, फ़ील्ड ऑब्जेक्ट में order, arrayConfig, और vectorConfig प्रॉपर्टी.

  collectionGroup: string  // Labeled "Collection ID" in the Firebase console
  queryScope: string       // One of "COLLECTION", "COLLECTION_GROUP"
  fields: array
    fieldPath: string
    order?: string         // One of "ASCENDING", "DESCENDING"; excludes arrayConfig and vectorConfig properties
    arrayConfig?: string   // If this parameter used, must be "CONTAINS"; excludes order and vectorConfig properties
    vectorConfig?: object  // Indicates that this is a vector index; excludes order and arrayConfig properties
      dimension: number    // The resulting index will only include vectors of this dimension
      flat: {}             // Indicates the vector index is a flat index

फ़ील्ड ओवरराइड

fieldOverrides कलेक्शन में एक ऑब्जेक्ट का स्कीमा इस तरह है. ज़रूरी नहीं है प्रॉपर्टी की पहचान ? वर्ण से की जाती है.

ध्यान दें कि Cloud Firestore दस्तावेज़ के फ़ील्ड को सिर्फ़ एक मोड में इंडेक्स किया जा सकता है, इसलिए, फ़ील्ड ऑब्जेक्ट में order और arrayConfig, दोनों नहीं हो सकते प्रॉपर्टी.

  collectionGroup: string  // Labeled "Collection ID" in the Firebase console
  fieldPath: string
  ttl?: boolean            // Set specified field to have TTL policy and be eligible for deletion
  indexes: array           // Use an empty array to disable indexes on this collectionGroup + fieldPath
    queryScope: string     // One of "COLLECTION", "COLLECTION_GROUP"
    order?: string         // One of "ASCENDING", "DESCENDING"; excludes arrayConfig property
    arrayConfig?: string   // If this parameter used, must be "CONTAINS"; excludes order property

TTL नीति

fieldOverrides कलेक्शन का इस्तेमाल करके, TTL नीति को चालू या बंद किया जा सकता है. इसके लिए, यह तरीका अपनाएं:

  // Optional, disable index single-field collection group indexes
  fieldOverrides: [
    {
      collectionGroup: "posts",
      fieldPath: "ttlField",
      ttl: "true",  // Explicitly enable TTL on this Field.
      // Disable indexing so empty the indexes array
      indexes: []
    }
  ]

फ़ील्ड में डिफ़ॉल्ट इंडेक्स को बनाए रखने और टीटीएल नीति चालू करने के लिए:

{
  "fieldOverrides": [
    {
      "collectionGroup": "yourCollectionGroup",
      "fieldPath": "yourFieldPath",
      "ttl": true,
      "indexes": [
        { "order": "ASCENDING", "queryScope": "COLLECTION_GROUP" },
        { "order": "DESCENDING", "queryScope": "COLLECTION_GROUP" },
        { "arrayConfig": "CONTAINS", "queryScope": "COLLECTION_GROUP" }
      ]
    }
  ]
}

टाइम-टू-लाइव (टीटीएल) नीतियों के बारे में ज़्यादा जानकारी के लिए, आधिकारिक दस्तावेज़ देखें.