Dokumentacja definicji indeksu Cloud Firestore

Cloud Firestore automatycznie tworzy indeksy do obsługi najczęstszych typów zapytań, ale umożliwia definiowanie niestandardowych indeksów i zastąpień indeksów zgodnie z opisem w przewodnikach po Cloud Firestore.

Indeksy niestandardowe możesz tworzyć, modyfikować i wdrażać w konsoli Firebase lub za pomocą interfejsu wiersza poleceń. W interfejsie wiersza poleceń zmodyfikuj plik konfiguracji indeksu z domyślną nazwą pliku firestore.indexes.json i wdróż go za pomocą polecenia firebase deploy.

Indeksy możesz eksportować za pomocą interfejsu wiersza poleceń za pomocą firebase firestore:indexes.

Plik konfiguracji indeksu definiuje jeden obiekt zawierający tablicę indexes i opcjonalną tablicę fieldOverrides. Oto przykład:

{
  // 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: []
    }
  ]
}

Wdrażanie konfiguracji indeksu

Wdróż konfigurację indeksu za pomocą polecenia firebase deploy. Jeśli chcesz wdrażać indeksy tylko dla baz danych skonfigurowanych w projekcie, dodaj flagę --only firestore. Zobacz informacje o opcjach tego polecenia.

Aby wyświetlić listę wdrożonych indeksów, uruchom polecenie firebase firestore:indexes. Dodaj flagę --database=<databaseID>, aby wyświetlić listę indeksów bazy danych innej niż domyślna baza danych projektu.

Jeśli edytujesz indeksy za pomocą konsoli Firebase, pamiętaj, aby zaktualizować też plik indeksów lokalnych. Więcej informacji o zarządzaniu indeksami znajdziesz w przewodnikach po Cloud Firestore.

Format JSON

Indeksy

Oto schemat jednego obiektu w tablicy indexes. Właściwości opcjonalne są oznaczone znakiem ?.

Pamiętaj, że pola dokumentów w Cloud Firestore można indeksować tylko w 1 trybie. Dlatego obiekt pola może zawierać tylko jedną z właściwości order, arrayConfig i 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

Oto schemat jednego obiektu w tablicy fieldOverrides. Właściwości opcjonalne są oznaczone znakiem ?.

Pamiętaj, że pola dokumentów w Cloud Firestore można indeksować tylko w jednym trybie, więc obiekt pola nie może zawierać jednocześnie właściwości order i 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

Zasada TTL

Zasadę TTL można włączyć lub wyłączyć za pomocą tablicy fieldOverrides w ten sposób:

  // 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: []
    }
  ]

Aby zachować domyślne indeksowanie w polu i włączyć zasadę TTL:

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

Więcej informacji o zasadach dotyczących czasu życia danych (TTL) znajdziesz w oficjalnej dokumentacji.