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 i Cloud Firestore rozpocznie się 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 wartość --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 utworzyć indeks tekstowy, użyj metody createIndex(). W poniższym przykładzie, gdy dokument jest zapisywany w kolekcji cities z wypełnionymi polami country lub food, te pola są indeksowane na potrzeby wyszukiwania.

db.cities.createIndex({"country": "text", "food": "text"})

Aby pole mogło zostać zindeksowane, musi być ciągiem znaków lub tablicą ciągów znaków. Indeksy tablic nie są indeksowane na potrzeby wyszukiwania. W rezultacie indeksowanie a.1.b spowoduje zindeksowanie something w {a: {1: {b: something}}}, ale nie w {a: [one, {b: something}]}.

Indeksy możesz też tworzyć za pomocą db.runCommand(). W każdej kolekcji możesz mieć tylko 1 indeks tekstowy, ale w jednym db.runCommand() możesz utworzyć wiele indeksów różnych typów. W tym przykładzie do utworzenia indeksu tekstowego użyto znaku db.runCommand():

db.runCommand({
  createIndexes: "cities",
  indexes: [
    {
      key: { "country": "text", "food": "text" },
      name: "country_text_food_text"
    }
  ]
})

Określanie języka domyślnego

Opcjonalnie możesz też określić domyślny język lub ścieżkę do pola w dokumencie, które będzie zawierać domyślny język.

W tym przykładzie myLanguageField jest określony jako language_override. Gdy dokument w kolekcji cities zawiera pole o nazwie myLanguageField, wartość tego pola jest używana do określania języka indeksowania pola country w tym konkretnym dokumencie. Ta wartość zastępuje domyślny język french.

db.cities.createIndex({"country": "text"}, {"default_language": "french", "language_override": "myLanguageField"})

• Język możesz wpisać w postaci pełnej nazwy (english) lub dwuliterowego kodu języka ISO (en).
• Jeśli język domyślny nie zostanie ustawiony, domyślnie będzie to Cloud Firestore angielski.
• Pole zastąpienia języka musi być polem najwyższego poziomu. Jeśli nie ustawisz tego pola, domyślna wartość pola zastąpienia języka to language.
• Jeśli ustawisz domyślny język na znak null, Cloud Firestore nie będzie używać żadnego pola jako zastąpienia języka.

Dzielenie indeksu tekstowego na partycje

Możesz też podzielić indeks na partycje za pomocą pola, aby filtrować zapytania według określonej wartości pola. Ta konfiguracja umożliwia uruchamianie wydajniejszych zapytań, jeśli zawsze potrzebujesz określonego pola filtrowanego w indeksie, w którym wysyłasz zapytanie.

Aby utworzyć indeks z partycją, skonfiguruj pole firestoreOptions w ten sposób:

db.runCommand({
  createIndexes: "cities",
  indexes: [
    {
      key: { "country": "text", "food": "text"},
      name: "country_text_food_text"
      firestoreOptions: {"customPartitionFields": ["PARTITIONED_FIELD"]
    }
  ]
})

Gdzie:

• PARTITIONED_FIELD to nazwa pola używanego do partycjonowania. Ta wartość musi być ciągiem znaków i odnosić się do pola najwyższego poziomu. Gdy uruchamiasz zapytanie do indeksu podzielonego na partycje, możesz filtrować wyniki na podstawie wartości tego pola. Możesz na przykład podzielić indeks za pomocą znaku city. Jeśli w indeksie tekstowym zdefiniowano pole city, użytkownicy mogą wysyłać zapytania dotyczące konkretnego miasta.

  Partycja musi być tylko jednym polem. Jeśli podzielisz indeks na partycje, możesz uruchamiać tylko zapytania, w których określono pole partycjonowania.

Ograniczenia

• Każda prośba może dotyczyć utworzenia tylko jednego indeksu.
• Logi kontrolne 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 Firebasekonsoli 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. Kliknij Utwórz.

7. Nowy indeks pojawi się na liście indeksów, a operacje zgodne z MongoDB rozpoczną tworzenie indeksu. Gdy indeks zostanie utworzony, obok niego pojawi się zielony znacznik wyboru. Jeśli indeks nie zostanie utworzony, zapoznaj się z sekcją Błędy podczas tworzenia indeksu, aby poznać możliwe przyczyny.

MongoDB API

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

db.restaurants.createIndex({"location" : "2dsphere", "region": "2dsphere"})

Tworzenie indeksu za pomocą db.runCommand() jest też obsługiwane w przypadku co najwyżej jednego indeksu:

db.runCommand({
  createIndexes: "restaurants",
  indexes: [
    {
      key: { "location": "2dsphere", "region": "2dsphere" },
      name: "location_2dsphere_region_2dsphere"
    }
  ]
})

Partycjonowanie indeksu 2dsphere

Możesz też podzielić indeks na partycje za pomocą pola, aby filtrować zapytania według określonej wartości pola. Ta konfiguracja umożliwia uruchamianie wydajniejszych zapytań, jeśli zawsze potrzebujesz określonego pola filtrowanego w indeksie, w którym wysyłasz zapytanie.

Aby utworzyć indeks z partycją, skonfiguruj pole firestoreOptions w ten sposób:

db.runCommand({
  createIndexes: "restaurants",
  indexes: [
    {
      key: { "location": "2dsphere", "region": "2dsphere" },
      name: "location_2dsphere_region_2dsphere"
      firestoreOptions: {"customPartitionFields": ["PARTITIONED_FIELD"]
    }
  ]
})

Gdzie:

• PARTITIONED_FIELD to nazwa pola używanego do partycjonowania. Gdy uruchamiasz zapytanie do indeksu podzielonego na partycje, możesz filtrować wyniki na podstawie wartości tego pola. Jeśli na przykład indeks zawiera pole region z lokalizacjami regionalnymi, możesz podzielić indeks za pomocą pola region, aby użytkownicy mogli wyszukiwać restauracje w swoim regionie.

  Jeśli podzielisz indeks na partycje, możesz uruchamiać tylko zapytania, w których określono pole podziału na partycje.

Ograniczenia

• Każda prośba może dotyczyć utworzenia tylko jednego indeksu.
• Logi kontrolne 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 Firebasekonsoli 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. Kliknij Utwórz.

7. Nowy indeks pojawi się na liście indeksów, a operacje zgodne z MongoDB rozpoczną tworzenie indeksu. Gdy indeks zostanie utworzony, obok niego pojawi się zielony znacznik wyboru. Jeśli indeks nie zostanie utworzony, zapoznaj się z sekcją Błędy podczas tworzenia indeksu, aby poznać możliwe przyczyny.

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