TTL を設定してコレクションのデータを期限切れにする

MongoDB Atlas UI でのドキュメントの期限切れ

Atlas の UI でデータを期限切れにするには、次の手順を行います。

指定した秒数後にドキュメントを期限切れにする

ターミナルで指定した秒数後にデータを期限切れにすることができます。インデックス フィールドで指定した秒数が経過した後にデータを期限切れにするには、BSON Date 型の値または BSON Date 型オブジェクトの配列を保持するフィールドに TTL インデックスを作成し、 expireAfterSeconds フィールドにゼロ以外の正の値を指定します。ドキュメントは、インデックス フィールドで指定された時間から expireAfterSeconds フィールドの秒数が経過すると期限切れになります。[1]

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

たとえば、次の操作では、 log_events コレクションの createdAt フィールドにインデックスを作成し、 expireAfterSeconds 値で 10 を指定すると、 createdAt で指定した時刻の 10 秒後が有効期限として設定されます。

db.log_events.createIndex( { "createdAt": 1 }, { expireAfterSeconds: 10 } )

log_events コレクションにドキュメントを追加するときは、 createdAt フィールドを現在の時刻に設定します。

db.log_events.insertOne( {
   "createdAt": new Date(),
   "logEvent": 2,
   "logMessage": "Success!"
} )

MongoDBは、ドキュメントの createdAt 値 [1] がexpireAfterSeconds で指定された秒数よりも古くなると、 log_events コレクションからドキュメントを自動的に削除します。

フィルター条件でドキュメントメントを期限切れにする

特定のフィルター式を使用してドキュメントを期限切れにするには、部分インデックスと TTL インデックスの両方のインデックスを作成します。

パーシャル TTL インデックスの作成

db.foo.createIndex(
   { F: 1 },
   {
      name: "Partial-TTL-Index",
      partialFilterExpression: { D : 1 },
      expireAfterSeconds: 10
   }
)

2 つのドキュメントを挿入します。いずれか 1 つは partialFilterExpression のフィルター式 { D : 1 } と一致します。

db.foo.insertMany( [
   { "F" : ISODate("2019-03-07T20:59:18.428Z"), "D" : 3},
   { "F" : ISODate("2019-03-07T20:59:18.428Z"), "D" : 1}
] )

10 秒待ってから foo コレクションをクエリします。

db.foo.find({}, {_id: 0, F: 1, D: 1})

{ D : 1 } の partialFilterExpression に一致するドキュメントは削除されています (期限切れ)。その結果、 foo コレクションには 1 つのドキュメントのみが残ります。

{ "F" : ISODate("2019-03-07T20:59:18.428Z"), "D" : 3}

特定のクロック時間後にドキュメントを期限切れにする

ターミナルで指定した時刻にデータを期限切れにすることができます。特定の時刻にドキュメントを期限切れにするには、まず、BSON Date 型または BSON Date 型オブジェクトの配列の値を保持するフィールドに TTL インデックスを作成し、expireAfterSeconds 値として 0 を指定します。コレクション内の各ドキュメントについて、インデックス付き日付フィールドに、ドキュメントの期限が切れる時間に対応する値を設定します。インデックス付きの日付フィールドに過去の日付が含まれている場合、MongoDB はドキュメントを期限切れと見なします。

たとえば、次の操作は log_events コレクションの expireAt フィールドにインデックスを作成し、 expireAfterSeconds 値を 0 に指定します。

db.log_events.createIndex( { "expireAt": 1 }, { expireAfterSeconds: 0 } )

各ドキュメントについて、ドキュメントが期限切れになる時間に対応するように expireAt の値を設定します。たとえば、次のinsertOne()操作は、 July 22, 2013 14:00:00に期限切れとなるドキュメントを追加します。

db.log_events.insertOne( {
   "expireAt": new Date('July 22, 2013 14:00:00'),
   "logEvent": 2,
   "logMessage": "Success!"
} )

MongoDB は、ドキュメントの expireAt 値が expireAfterSeconds で指定された秒数よりも古い場合、つまりここでは 0 秒古い場合、log_events コレクションからドキュメントを自動的に削除します。そのため、指定された expireAt 値でデータが期限切れになります。

NaN を使用して設定されたインデックス

TTL インデックス構成で expireAfterSeconds を NaN に設定しないでください。

MongoDB 5.0 以前のバージョンでは、TTL インデックスの expireAfterSeconds が NaN に設定されている場合、MongoDB はログにエラーを記録し、レコードを削除しません。

MongoDB 5.0.0 - 5.0.13 (および 6.0.0 - 6.0.1) 以降、NaN は 0 として扱われます。TTL インデックスが expireAfterSeconds を NaN に設定して構成されている場合、すべての TTL インデックス付きドキュメントは直ちに期限切れになります。

MongoDB 5.0.14 (および 6.0.2) 以降では、サーバーは expireAfterSeconds が NaN に設定されている TTL インデックスを使用しません。

ただし、予期しない動作が発生しうる状況は依然としてあります。次の場合、ドキュメントが期限切れとなる場合があります。

• MongoDB 5.0.0 - 5.0.13（または 6.0.0 - 6.0.1）より前のバージョンへの最初の同期中。

• 以前のバージョンから MongoDB 5.0.0 - 5.0.13 にアップグレードする場合。

• 5.0より前からコレクションを復元する場合 mongodumpを MongoDB 5.0.0 - 5に変換します。 0 。 13 （または6 . 0 . 0 - 6 。 0 。 1 ） インスタンス。

問題を回避するには、誤って構成された TTL インデックスを削除するか修正してください。

function getNaNIndexes() {
   const nan_index = [];
   const dbs = db.adminCommand({ listDatabases: 1 }).databases;
   dbs.forEach((d) => {
      if (d.name != 'local') {
         const listCollCursor = db
            .getSiblingDB(d.name)
            .runCommand({ listCollections: 1 }).cursor;
         const collDetails = {
            db: listCollCursor.ns.split(".$cmd")[0],
            colls: listCollCursor.firstBatch.map((c) => c.name),
         };
         collDetails.colls.forEach((c) =>
            db
               .getSiblingDB(collDetails.db)
               .getCollection(c)
               .getIndexes()
               .forEach((entry) => {
                  if (Object.is(entry.expireAfterSeconds, NaN)) {
                     nan_index.push({ ns: `${collDetails.db}.${c}`, index: entry });
                  }
               })
         );
      }
   });
   return nan_index;
};
getNaNIndexes();