Управление индексами

MongoDB API

Чтобы создать текстовый индекс, используйте метод createIndex(). В следующем примере, когда документ записывается в коллекцию cities с заполненными полями country или food, эти поля индексируются для целей поиска.

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

Поле должно быть строкой или массивом строк, которые нужно проиндексировать. Индексы массивов не индексируются для поиска. В результате индексирование a.1.b приведет к индексированию something в {a: {1: {b: something}}}, но не в {a: [one, {b: something}]}.

Вы также можете создавать индексы с помощью db.runCommand(). В одной коллекции может быть только один текстовый индекс, но в одной базе данных db.runCommand() можно создать несколько индексов разных типов. В примере ниже для создания текстового индекса используется db.runCommand().

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

Укажите язык по умолчанию

Вы также можете указать язык по умолчанию или путь к полю в документе, которое будет содержать язык по умолчанию.

В примере ниже в качестве language_override указано значение myLanguageField. Если документ в коллекции cities содержит поле с названием myLanguageField, значение этого поля используется для определения языка индексирования поля country для этого конкретного документа. Это значение переопределяет язык по умолчанию (french).

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

• Язык можно указать в виде полного названия (english) или двухбуквенного кода ISO (en).
• Если язык по умолчанию не задан, то Cloud Firestore по умолчанию использует английский.
• Поле переопределения языка должно быть полем верхнего уровня. Если поле не заполнено, по умолчанию используется значение language.
• Если в качестве языка по умолчанию вы укажете символ null, то Cloud Firestore не будет использовать никакое поле для переопределения языка.

Как разделить текстовый индекс

Вы также можете разделить индекс по полю, чтобы фильтровать запросы по определенному значению поля. Такая конфигурация позволяет выполнять более эффективные запросы, если вам всегда нужно фильтровать определенное поле в запрашиваемом индексе.

Чтобы создать индекс с разделом, настройте поле firestoreOptions следующим образом:

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

Место:

• PARTITIONED_FIELD – название поля, используемого для разбиения. Значение должно быть строкой и относиться к полю верхнего уровня. При выполнении запроса к секционированному индексу вы можете отфильтровать результаты по значению этого поля. Например, вы можете разделить индекс, используя city. Если в текстовом индексе определено поле city, пользователи могут выполнять запросы по определенному городу.

  Раздел должен содержать только одно поле. Если вы разделите индекс, то сможете выполнять только запросы, в которых указано разделенное поле.

Ограничения

• В одном запросе можно создать только один индекс.
• В журналах аудита для создания индекса с помощью MongoDB API используется название метода google.firestore.admin.v1.FirestoreAdmin.CreateIndex.
• Поддерживаемые варианты индексов описаны в статье Индексы и их свойства.

Консоль Firebase

1. В консоли Firebase перейдите на страницу База данных Firestore.

   Перейти к базе данных Firestore

2. Выберите базу данных из списка.

3. На вкладке Индексы нажмите Создать индекс.

4. Введите идентификатор коллекции.

5. Добавьте один или несколько путей к полям и выберите вариант индекса для каждого из них.

6. Нажмите Создать.

7. Новый индекс появится в списке индексов, и совместимые с MongoDB операции начнут создавать ваш индекс. Когда индекс будет создан, рядом с ним появится зеленая галочка. Если индекс не создан, ознакомьтесь с возможными причинами в разделе Ошибки при создании индекса.

gcloud CLI

Чтобы создать текстовый индекс, используйте команду gcloud firestore indexes composite create. Задайте для параметра --api-scope значение 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

Замените следующее:

• DATABASE_ID – идентификатор базы данных.
• COLLECTION_GROUP – идентификатор коллекции, которую нужно проиндексировать.
• FIELD_NAME – название поля для индексирования.

Флаг --async запускает операцию создания индекса в фоновом режиме.

MongoDB API

Чтобы создать индекс, используйте метод createIndex(). Пример:

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

Создание индекса с помощью db.runCommand() также поддерживается максимум с одним индексом:

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

Как разделить индекс 2dsphere

Вы также можете разделить индекс по полю, чтобы фильтровать запросы по определенному значению поля. Такая конфигурация позволяет выполнять более эффективные запросы, если вам всегда нужно фильтровать определенное поле в запрашиваемом индексе.

Чтобы создать индекс с разделом, настройте поле firestoreOptions следующим образом:

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

Место:

• PARTITIONED_FIELD – название поля, используемого для разбиения. При выполнении запроса к секционированному индексу вы можете отфильтровать результаты по значению этого поля. Например, если в индексе есть поле region для регионов, вы можете разделить индекс по полю region, чтобы пользователи могли искать рестораны в своем регионе.

  Если вы разбиваете индекс на разделы, то можете выполнять запросы только с указанием поля, по которому выполнено разбиение.

Ограничения

• В одном запросе можно создать только один индекс.
• В журналах аудита для создания индекса с помощью MongoDB API используется название метода google.firestore.admin.v1.FirestoreAdmin.CreateIndex.
• Поддерживаемые варианты индексов описаны в статье Индексы и их свойства.

Консоль Firebase

1. В консоли Firebase перейдите на страницу База данных Firestore.

   Перейти к базе данных Firestore

2. Выберите базу данных из списка.

3. На вкладке Индексы нажмите Создать индекс.

4. Введите идентификатор коллекции.

5. Добавьте один или несколько путей к полям и выберите вариант индекса для каждого из них.

6. Нажмите Создать.

7. Новый индекс появится в списке индексов, и совместимые с MongoDB операции начнут создавать ваш индекс. Когда индекс будет создан, рядом с ним появится зеленая галочка. Если индекс не создан, ознакомьтесь с возможными причинами в разделе Ошибки при создании индекса.

gcloud CLI

Чтобы создать индекс 2dsphere, используйте команду gcloud firestore indexes composite create. Задайте для параметра --api-scope значение 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

Замените следующее:

• DATABASE_ID – идентификатор базы данных.
• COLLECTION_GROUP – идентификатор коллекции, которую нужно проиндексировать.
• FIELD_NAME – название поля для индексирования.

Флаг --async запускает операцию создания индекса в фоновом режиме.