Zarządzaj indeksami

MongoDB API

Aby utworzyć indeks, użyj metody createIndex(). Przykład:

•   db.restaurants.createIndex({"cuisine" : 1})
    

•   db.restaurants.createIndex({"cuisine" : 1}, {sparse: true})
    

• Tworzenie indeksu za pomocą db.runCommand() jest też obsługiwane w przypadku maksymalnie 1 indeksu.

    db.runCommand({"createIndexes":"restaurant", "index": [{"key": {"cuisine":1}, {"name": "cuisine_index"}]})
    

Pamiętaj o tych ograniczeniach:

• Każda prośba może dotyczyć utworzenia tylko jednego indeksu. db.collection.createIndexes() nie jest obsługiwany.
• Dzienniki kontroli tworzenia indeksu za pomocą interfejsu MongoDB API używają nazwy metody google.firestore.admin.v1.FirestoreAdmin.CreateIndex.
• Listę obsługiwanych opcji indeksu znajdziesz w sekcji Indeksy i właściwości indeksu.

Firebase konsola

1. W konsoli Firebase otwórz stronę Baza danych Firestore.

   Otwórz bazę danych Firestore

2. Wybierz bazę danych z listy baz danych.
3. Na karcie Indeksy kliknij Utwórz indeks.
4. Wpisz identyfikator kolekcji.
5. Dodaj co najmniej jedną ścieżkę pola i wybierz dla każdej z nich opcję indeksu.
6. Wybierz opcję obecności pola: nie rzadkie lub rzadkie.
7. Opcjonalnie możesz ustawić opcję indeksu wielokluczowego.
8. Kliknij Utwórz.
9. Nowy indeks pojawi się na liście indeksów, a Cloud Firestore w trybie zgodności z MongoDB rozpocznie jego tworzenie. Gdy indeks zostanie utworzony, obok niego pojawi się zielona ikona potwierdzenia. Jeśli indeks nie zostanie utworzony, zapoznaj się z sekcją Błędy tworzenia indeksu, aby poznać możliwe przyczyny.

gcloud CLI

Aby utworzyć indeks, użyj polecenia gcloud firestore indexes composite create. Ustaw wartość api-scope na mongodb-compatible-api.

gcloud firestore indexes composite create \
--database='DATABASE_ID' \
--collection-group=COLLECTION \
--field-config=FIELD_CONFIGURATION \
--query-scope=collection-group \
--density=dense \
--api-scope=mongodb-compatible-api

Zastąp następujące elementy:

• DATABASE_ID: identyfikator bazy danych.
• COLLECTION: nazwa kolekcji.
• FIELD_CONFIGURATION: konfiguracja pola. W przypadku każdego pola dodaj --field-config=field-path=. Przykład:

      --field-config=field-path=user-id,order=descending \
      --field-config=field-path=score,order=descending
      

  Więcej informacji o konfigurowaniu tych pól znajdziesz w artykule --field-config.

Aby utworzyć indeks rzadki, ustaw --density=sparse-any.

Aby utworzyć indeks wielokluczowy, dodaj flagę --multikey.

Aby utworzyć unikalny indeks, dodaj flagę --unique.

Terraform

Użyj zasobu google_firestore_index i ustaw api_scope na MONGODB_COMPATIBLE_API oraz query_scope na COLLECTION_GROUP.

resource "google_firestore_index" "index" {
  database    = "DATABASE_ID"
  collection  = "COLLECTION"
  api_scope   = "MONGODB_COMPATIBLE_API"
  query_scope = "COLLECTION_GROUP"

  // You can include multiple field blocks
  fields {
    field_path = "FIELD_PATH"
    order      = "ORDER"
  }

  // Optional
  multikey = true
  density  = "DENSITY"
}

Zastąp następujące elementy:

• DATABASE_ID: identyfikator bazy danych wybranej przez Ciebie bazy danych.
• COLLECTION: nazwa kolekcji do indeksowania.
• FIELD_PATH: nazwa pola do indeksowania.
• ORDER: jedna z wartości ASCENDING lub DESCENDING
• DENSITY: jedna z wartości SPARSE_ANY lub DENSE

MongoDB API

Aby usunąć indeks, użyj metody dropIndex(). Przykład:

Usuwanie indeksu za pomocą nazwy indeksu

db.restaurants.dropIndex("cuisine_index")

Usuwanie indeksu za pomocą definicji indeksu

db.restaurants.dropIndex({"cuisine" : 1})

Firebase konsola

1. W konsoli Firebase otwórz stronę Baza danych Firestore.

   Otwórz bazę danych Firestore

2. Wybierz bazę danych z listy baz danych.
3. Kliknij kartę Indeksy.
4. Na liście indeksów kliknij Usuń na przycisku Więcejmore_vert obok indeksu, który chcesz usunąć.
5. Kliknij Usuń indeks.

gcloud CLI

1. Aby znaleźć nazwę indeksu, użyj polecenia gcloud firestore indexes composite list.

   gcloud firestore indexes composite list \
   --database='DATABASE_ID'

   Zastąp DATABASE_ID identyfikatorem bazy danych.

2. Aby usunąć indeks, użyj polecenia gcloud firestore indexes composite delete.

   gcloud firestore indexes composite delete INDEX_NAME \
   --database='DATABASE_ID'

   Zastąp następujące elementy:

   • INDEX_NAME: nazwa indeksu
   • DATABASE_ID: identyfikator bazy danych