インデックスを管理

このページでは、インデックスの管理方法について説明します。インデックスの詳細については、インデックスの概要をご覧ください。

始める前に

MongoDB 互換の Firestore でインデックスを作成する前に、自身に次のいずれかのロールが割り当てられていることを確認してください。

• roles/datastore.owner
• roles/datastore.indexAdmin
• roles/editor
• roles/owner

ロールを付与するには、単一のロールを付与するをご覧ください。Firestore のロールと関連する権限の詳細については、事前定義ロールをご覧ください。

カスタムロールを定義している場合、インデックスを作成するには次のすべての権限を割り当ててください。

• datastore.indexes.create
• datastore.indexes.delete
• datastore.indexes.get
• datastore.indexes.list
• datastore.indexes.update

インデックスの作成

インデックスを作成するには、次の操作を行います。

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

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

インデックスを削除する

インデックスを削除する手順は次のとおりです。

インデックスの構築時間

インデックスを構築するには、MongoDB 互換の Firestore でインデックスを作成し、既存のデータでインデックス エントリをバックフィルする必要があります。インデックスの作成に必要な時間は、次の要素によって決まります。

• インデックスの最小構築時間は、空のデータベースであっても数分です。

• インデックス エントリのバックフィルに必要な時間は、新しいインデックスに既存のデータがどの程度存在するかによって異なります。インデックス定義に一致するフィールド値が多いほど、インデックス エントリのバックフィルにかかる時間が長くなります。

長時間実行オペレーションを管理する

インデックスの構築は長時間実行オペレーションです。以降のセクションでは、インデックスの長時間実行オペレーションを操作する方法について説明します。

インデックスの作成を開始すると、MongoDB 互換の Firestore によりオペレーションに一意の名前が割り当てられます。次のように、オペレーション名の先頭には projects/PROJECT_ID/databases/DATABASE_ID/operations/ という文字列が付きます。

projects/PROJECT_ID/databases/DATABASE_ID/operations/ASA1MTAwNDQxNAgadGx1YWZlZAcSeWx0aGdpbi1zYm9qLW5pbWRhEgopEg

describe コマンド用のオペレーション名を指定するときは、接頭辞を省略できます。

すべての長時間実行オペレーションを一覧表示する

長時間実行オペレーションを一覧表示するには、gcloud firestore operations list コマンドを使用します。このコマンドは、実行中のオペレーションと最近完了したオペレーションを一覧表示します。オペレーションは、完了後数日間一覧表示されます。

gcloud firestore operations list

オペレーションのステータスを確認する

すべての長時間実行オペレーションを一覧表示する代わりに、1 つのオペレーションの詳細を一覧表示できます。

gcloud firestore operations describe operation-name

完了時間の見積もり

オペレーションを実行すると、state フィールドの値で、オペレーション全体のステータスが確認できます。

長時間実行オペレーションのステータスをリクエストすると、workEstimated と workCompleted の指標も合わせて返されます。workEstimated には、オペレーションで処理される推定の合計ドキュメント数が表示されます。workCompleted には、これまでに処理されたドキュメント数が表示されます。オペレーションが完了すると、workCompleted には実際に処理されたドキュメントの合計数が反映されます。これは workEstimated の値とは異なる場合があります。

オペレーションの進行状況を推定するには、workCompleted を workEstimated で割ります。

インデックスの作成の進行状況の例を次に示します。

{
  "operations": [
    {
      "name": "projects/project-id/operations/AyAyMDBiM2U5NTgwZDAtZGIyYi0zYjc0LTIzYWEtZjg1ZGdWFmZWQHEjF0c2Flc3UtcmV4ZWRuaS1uaW1kYRUKSBI",
      "metadata": {
        "@type": "type.googleapis.com/google.firestore.admin.v1.IndexOperationMetadata",
        "common": {
          "operationType": "CREATE_INDEX",
          "startTime": "2020-06-23T16:52:25.697539Z",
          "state": "PROCESSING"
        },
        "progressDocuments": {
          "workCompleted": "219327",
          "workEstimated": "2198182"
        }
       },
    },
    ...

オペレーションが完了すると、オペレーションの説明に、"done": true が含まれます。オペレーションの結果をみるには、state フィールドの値を確認します。done フィールドがレスポンスに設定されていない場合、オペレーションは完了していません。