TTL Indexes

TTL インデックスの作成

TTL インデックスを作成するには、createIndex() を使用します。Date 型または Date 型の値を含む配列のインデックス フィールドを指定します。expireAfterSeconds オプションを使って TTL 値を秒単位で指定します。

TTLインデックスの expireAfterSeconds 値は、0 から 2147483647 の範囲内（両端を含む）である必要があります。

たとえば、eventlog コレクションの lastModifiedDate フィールドで TTL 値 3600 秒を使用して TTL インデックスを作成するには、mongosh で次の操作を使用します。

db.eventlog.createIndex(
   { "lastModifiedDate": 1 },
   { expireAfterSeconds: 3600 }
)

時系列コレクションに TTL インデックスを作成する

たとえば、次の気象データ時系列コレクションを作成し、expireAfterSeconds フィールドを設定して、24 時間後にドキュメントを削除するようにします。

db.createCollection(
   "weather24h",
   {
      timeseries: {
         timeField: "timestamp",
         metaField: "sensor",
         granularity: "hours"
      },
      expireAfterSeconds: 86400
   }
)

また、partialFilterExpression フィールドを使用してコレクションに TTL インデックスを作成することもできます。これらのインデックスは、コレクションの timeField をキー フィールドとして使用します。また、次の項目も指定してください。

• ドキュメントのサブセットに対して明示的な有効期限を設定する expireAfterSeconds フィールド。コレクションを作成する際に expireAfterSeconds フィールドを設定していても、partialFilterExpression フィールドを使用することで、一致するドキュメントのサブセットに対して異なる、より短い有効期限を設定できます。

• metaField 上の部分フィルター式。partial filter expression は、expireAfterSeconds フィールドで定義された時間に有効期限切れとなるドキュメントのセットを定義します。

次の TTL インデックスは、「ensor」フィールドが「MDB_NYC」に設定されている「weather24h」コレクション内のドキュメントに一致しており、1 時間後にそれらを削除し、コレクションの作成時に設定したデフォルトの 24 時間を上書きします。

db.weather24h.createIndex(
   { "timestamp": 1 },
   {
      expireAfterSeconds: 3600,
      partialFilterExpression: { "sensor": { $eq: "MDB_NYC" } }
   }
)

TTL 以外の単一フィールド インデックスの TTL インデックスへの変換

MongoDB 5.1 以降では、既存の単一フィールド インデックスに expireAfterSeconds オプションを追加できます。TTL 以外の単一フィールド インデックスを TTL インデックスに変更するには、collMod データベースコマンドを使用します。

db.runCommand({
  "collMod": <collName>,
  "index": {
    "keyPattern": <keyPattern>,
    "expireAfterSeconds": <number>
  }
})

次の例では、パターン { "lastModifiedDate": 1 } を含む TTL 以外の単一フィールド インデックスを TTL インデックスに変換しています。

db.runCommand({
  "collMod": "tickets",
  "index": {
    "keyPattern": { "lastModifiedDate": 1 },
    "expireAfterSeconds": 100
  }
})

TTL インデックスの expireAfterSeconds 値の変更

TTL インデックスの expireAfterSeconds 値を変更するには、collMod データベースコマンドを使用します。

db.runCommand({
  "collMod": <collName>,
  "index": {
    "keyPattern": <keyPattern>,
    "expireAfterSeconds": <number>
  }
})

次の例では、パターン { "lastModifiedDate": 1 } を含むインデックスの expireAfterSeconds の値を tickets コレクションで変更しています。

db.runCommand({
  "collMod": "tickets",
  "index": {
    "keyPattern": { "lastModifiedDate": 1 },
    "expireAfterSeconds": 100
  }
})

動作

TTL とスキーマ検証

TTL インデックスはスキーマ検証を必要としませんが、検証を使用することで、存在および日付フィールドの形式を標準化することにより、一貫した動作を確保し、有効期限の管理に役立ちます。

例として、スキーマ検証を使用して lastModifiedDate フィールドの存在を強制し、その値が有効な日付形式に従っていることを確認できます。

db.createCollection(
   "eventlog",
   {
      validator: {
         $jsonSchema: {
            bsonType: "object",
            required: [ "lastModifiedDate" ],
            properties: {
               lastModifiedDate: {
                  bsonType: "date",
                  description: "Must be a valid date."
               }
            }
         }
      }
   }
)

このスキーマ検証ルールは、以下を保証します。

• eventlogコレクション内のすべてのドキュメントにはlastModifiedDateフィールドが含まれています。

• lastModifiedDateフィールドには有効な日付値が含まれています。

制限事項

• TTL インデックスは単一フィールドのインデックスです。複合インデックスは TTL をサポートしておらず、expireAfterSeconds オプションを無視します。

• _id フィールドは TTL インデックスをサポートしていません。

• MongoDB7.0 以降では、 時系列コレクション の に 部分的な TTL インデックスmetaField を作成できます。MongoDB の以前のバージョンでは、時系列コレクションのtimeFieldの TTL インデックスのみを作成できます。

• 既存のインデックスのexpireAfterSecondsの値を変更するために、 createIndex()は使用できません。 代わりに、 collModデータベースコマンドを使用します。 詳しくは、「 TTL インデックスのexpireAfterSeconds値の変更 」を参照してください。

• TTL 以外の単一フィールド インデックスがフィールドにすでにある場合、同じフィールドに TTL インデックスを作成できません。キー仕様が同じで、オプションのみが異なるインデックスは作成できないためです。 TTL 以外の単一フィールド インデックスを TTL インデックスに変更するには、 collModデータベースコマンドを使用します。