Zarządzaj indeksami

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"})

Pole musi być ciągiem znaków lub tablicą ciągów znaków, aby można było je zindeksować. 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 jeden indeks tekstowy, ale w jednej bazie danych db.runCommand() możesz utworzyć wiele indeksów różnych typów. W tym przykładzie użyto db.runCommand() do utworzenia indeksu tekstowego:

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

Określanie języka domyślnego

Możesz też opcjonalnie określić domyślny język lub ścieżkę pola w dokumencie, która 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ślenia 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"})

• Możesz wpisać język w pełnej formie (english) lub jako dwuliterowy kod ISO (en).
• Jeśli nie ustawisz języka domyślnego, Cloud Firestore domyślnie będzie używać języka angielskiego.
• Pole zastąpienia języka musi być polem najwyższego poziomu. Jeśli nie ustawisz tego pola, domyślna wartość 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.

Partycjonowanie indeksu tekstowego

Możesz też podzielić indeks na partycje za pomocą pola, aby filtrować zapytania według określonej wartości pola. Ta konfiguracja pozwala na uruchamianie bardziej wydajnych zapytań, jeśli zawsze potrzebujesz określonego pola filtrowanego w indeksie, do którego 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 na potrzeby partycji. Ta wartość musi być ciągiem znaków i musi odnosić się do pola najwyższego poziomu. Gdy uruchamiasz zapytanie względem indeksu partycjonowanego, możesz filtrować wyniki na podstawie wartości tego pola. Możesz na przykład podzielić indeks na partycje za pomocą city. Jeśli w indeksie tekstowym zdefiniowane jest 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 partycjonowane.

Ograniczenia

• W ramach jednego żądania możesz utworzyć tylko jeden indeks.
• Logi kontrolne tworzenia indeksu za pomocą interfejsu MongoDB API używają nazwy metody google.firestore.admin.v1.FirestoreAdmin.CreateIndex.
• Informacje o obsługiwanych opcjach indeksów znajdziesz w artykule o indeksach i ich właściwościach.

Konsola Firebase

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 1 ścieżkę pola i wybierz opcję indeksu dla każdej z nich.

6. Kliknij Utwórz.

7. Nowy indeks pojawi się na liście indeksów, a operacje zgodne z MongoDB zaczną go tworzyć. Gdy indeks zostanie utworzony, pojawi się obok niego zielona ikona potwierdzenia. Jeśli indeks nie został utworzony, zapoznaj się z artykułem Błędy podczas tworzenia indeksu, aby poznać możliwe przyczyny.

gcloud CLI

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

gcloud firestore indexes composite create \
  --database='DATABASE_ID' \
  --collection-group=COLLECTION_GROUP \
  --field-config=field-path=FIELD_NAME,search-config='{"text-spec": {"index-specs": [{"index-type": "tokenized", "match-type": "match-globally"}]}}' \
  --api-scope=mongodb-compatible-api \
  --search-index-options=text-language=en \
  --async

Zastąp następujące elementy:

• DATABASE_ID: identyfikator bazy danych.
• COLLECTION_GROUP: identyfikator kolekcji do zindeksowania.
• FIELD_NAME: nazwa pola do zindeksowania.

Flaga --async powoduje, że operacja tworzenia indeksu jest wykonywana w tle.

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 maksymalnie 1 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 pozwala na uruchamianie bardziej wydajnych zapytań, jeśli zawsze potrzebujesz określonego pola filtrowanego w indeksie, do którego 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. Podczas wykonywania zapytania na indeksie podzielonym 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 na partycje za pomocą 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 partycjonowane.

Ograniczenia

• W ramach jednego żądania możesz utworzyć tylko jeden indeks.
• Logi kontrolne tworzenia indeksu za pomocą interfejsu MongoDB API używają nazwy metody google.firestore.admin.v1.FirestoreAdmin.CreateIndex.
• Informacje o obsługiwanych opcjach indeksów znajdziesz w artykule o indeksach i ich właściwościach.

Konsola Firebase

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 1 ścieżkę pola i wybierz opcję indeksu dla każdej z nich.

6. Kliknij Utwórz.

7. Nowy indeks pojawi się na liście indeksów, a operacje zgodne z MongoDB zaczną go tworzyć. Gdy indeks zostanie utworzony, pojawi się obok niego zielona ikona potwierdzenia. Jeśli indeks nie został utworzony, zapoznaj się z artykułem Błędy podczas tworzenia indeksu, aby poznać możliwe przyczyny.

gcloud CLI

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

gcloud firestore indexes composite create \
  --database='DATABASE_ID' \
  --collection-group=COLLECTION_GROUP \
  --field-config=field-path=FIELD_NAME,search-config='{"geo-spec": {}}' \
  --api-scope=mongodb-compatible-api \
  --async

Zastąp następujące elementy:

• DATABASE_ID: identyfikator bazy danych.
• COLLECTION_GROUP: identyfikator kolekcji do zindeksowania.
• FIELD_NAME: nazwa pola do zindeksowania.

Flaga --async powoduje, że operacja tworzenia indeksu jest wykonywana w tle.