インデックスの管理

MongoDB API

createIndex() メソッドを使用してインスタンスを作成します。次に例を示します。

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

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

• db.runCommand() を使用したインデックス作成も、最大 1 つのインデックスでサポートされています。

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

次の制約があります。

• リクエストごとに作成できるインデックスは 1 つだけです。db.collection.createIndexes() はサポートされていません。
• MongoDB API を使用したインデックス作成の監査ログでは、メソッド名 google.firestore.admin.v1.FirestoreAdmin.CreateIndex が使用されます。
• サポートされているインデックス オプションについては、インデックスとインデックス プロパティをご覧ください。

Firebase コンソール

1. Firebase コンソールで、[Firestore データベース] ページに移動します。

   [Firestore データベース] に移動

2. データベースのリストからデータベースを選択します。
3. [インデックス] タブで、[インデックスを作成] をクリックします。
4. コレクション ID を入力します。
5. 1 つ以上のフィールドパスを追加し、それぞれにインデックス オプションを選択します。
6. フィールド プレゼンス オプション（非スパースまたはスパース）を選択します。
7. 必要に応じて、マルチキー インデックス オプションを設定できます。
8. [作成] をクリックします。
9. 新しいインデックスがインデックスのリストに表示され、MongoDB 互換の Cloud Firestore がインデックスの作成を開始します。インデックスが作成されると、インデックスの横に緑色のチェックマークが表示されます。インデックスが作成されていない場合は、考えられる原因をインデックス構築エラーで確認してください。

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: データベース 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 フラグを追加します。

Terraform

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: 選択したデータベースのデータベース ID
• COLLECTION: インデックスを作成するコレクションの名前
• FIELD_PATH: インデックスを作成するフィールドの名前
• ORDER: ASCENDING、DESCENDING のいずれか
• DENSITY: SPARSE_ANY、DENSE のいずれか

MongoDB API

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 をデータベース ID に置き換えます。

2. インデックスを削除するには、gcloud firestore indexes composite delete コマンドを使用します。

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

   以下を置き換えます。

   • INDEX_NAME: インデックスの名前
   • DATABASE_ID: データベース ID