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

MongoDB 6.3 以降では、時系列コレクションで部分的な TTL インデックスを作成できます。これらのインデックスはコレクション timeField をキー フィールドとして使用し、metaField で部分的なフィルター式を必要とします。

時系列コレクションには任意のexpireAfterSecondsフィールドが含まれています。 expireAfterSecondsを設定しない場合、 partialFilterExpressionを含む TTL インデックスを使用して、フィルターに一致するドキュメントの有効期限を設定できます。 expireAfterSecondsを設定する場合、部分的な TTL インデックスを使用すると、一致するドキュメントの別の短い有効期限を設定できます。 partialFilterExpressionはmetaFieldでのみ作成できます。

1970-01-01T00:00:00.000Z の前または 2038-01-19T03:14:07.000Z の後に timeField タイムスタンプがあるドキュメントが時系列コレクションに含まれる場合、TTL（time to live） 機能によってコレクションからドキュメントが削除されることはありません。

次の気象データ時系列コレクションは、24時間後にドキュメントを削除します。

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

次の TTL インデックスは、MongoDB NYC 本社の気象センサーから 24 時間後ではなく 1 時間後にドキュメントを削除します。

db.eventlog.createIndex(
  { "timestamp": 1 },
  { partialFilterExpression: { "sensor": { $eq: "40.761873, -73.984287" } } },
  { expireAfterSeconds: 3600 } )

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

expireAfterSecondsTTL インデックスの 値の変更

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 をサポートしておらず、expireAfterSeconds オプションを無視します。

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

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

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

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