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

API MongoDB

Для создания индекса используйте метод createIndex() . Например:

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

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

• Поддерживается также создание индексов с помощью db.runCommand() , при этом допускается создание не более одного индекса.

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

Обратите внимание на следующие ограничения:

• За один запрос можно создать только один индекс. db. collection .createIndexes() не поддерживается.
• В журналах аудита для создания индексов с помощью API MongoDB используется метод с именем google.firestore.admin.v1.FirestoreAdmin.CreateIndex .
• Список поддерживаемых параметров индексов см. в разделах «Индексы» и «Свойства индексов» .

Консоль Firebase

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

   Перейдите в базу данных Firestore.

2. Выберите базу данных из списка баз данных.
3. На вкладке «Индексы» нажмите «Создать индекс» .
4. Введите идентификатор коллекции .
5. Добавьте один или несколько путей к полям и выберите для каждого из них параметр индекса.
6. Выберите вариант наличия поля: неразреженный или разреженный.
7. При желании можно задать параметр многоключевого индекса .
8. Нажмите «Создать» .
9. Ваш новый индекс отобразится в списке индексов, и Cloud Firestore с поддержкой MongoDB начнет его создание. После создания индекса рядом с ним появится зеленая галочка. Если индекс не создан, см. раздел «Ошибки построения индекса» для получения информации о возможных причинах.

gcloud CLI

Для создания индекса используйте команду ` gcloud firestore indexes composite create . Установите api-scope в значение 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

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

• DATABASE_ID : идентификатор базы данных.
• COLLECTION : название коллекции.
• FIELD_CONFIGURATION : конфигурация поля. Для каждого поля добавьте --field-config=field-path= . Например:

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

  Для получения дополнительной информации о настройке этих полей см. --field-config .

Для создания разреженного индекса установите --density=sparse-any .

Для создания многоключевого индекса добавьте флаг --multikey .

Для создания уникального индекса добавьте флаг --unique .

Терраформирование

Используйте ресурс google_firestore_index и установите api_scope в значение MONGODB_COMPATIBLE_API , а query_scope в значение 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"
}

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

• DATABASE_ID : Идентификатор базы данных для выбранной вами базы данных.
• COLLECTION : Название коллекции для индексации.
• FIELD_PATH : Имя поля для индексации
• ORDER : один из ASCENDING или DESCENDING
• DENSITY : Один из вариантов: SPARSE_ANY или DENSE

API MongoDB

Для удаления индекса используйте метод dropIndex() . Например:

Удаление индекса по имени индекса

db.restaurants.dropIndex("cuisine_index")

Удаление индекса с помощью определения индекса

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

Консоль Firebase

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

   Перейдите в базу данных Firestore.

2. Выберите базу данных из списка баз данных.
3. Перейдите на вкладку «Указатели» .
4. В списке индексов выберите «Удалить» с помощью кнопки «Дополнительно» more_vert для индекса, который вы хотите удалить.
5. Нажмите «Удалить индекс» .

gcloud CLI

1. Чтобы узнать имя индекса, используйте команду gcloud firestore indexes composite list .

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

   Замените DATABASE_ID на идентификатор базы данных.

2. Для удаления индекса используйте команду ` gcloud firestore indexes composite delete .

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

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

   • INDEX_NAME : имя индекса
   • DATABASE_ID : идентификатор базы данных