TTL Indexes

创建 TTL 索引

要创建 TTL 索引，请使用 createIndex()。指定一个日期类型或包含日期类型值的数组的索引字段。使用 expireAfterSeconds 选项指定 TTL 值（以秒为单位）。

TTL 索引 expireAfterSeconds 值必须介于 0 和 2147483647（包含两者）之间。

例如，要在 eventlog 集合的 lastModifiedDate 字段上创建 TTL 值为 3600 秒的 TTL 索引，则在 mongosh 中使用以下操作：

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

从 MongoDB 7.0 开始，您可对时间序列集合创建部分 TTL 索引。这些索引使用集合 timeField 作为键字段，并且需要针对 metaField 的部分过滤表达式。

时间序列集合包含可选的 expireAfterSeconds 字段。如果未设置 expireAfterSeconds，则您可以使用带有 partialFilterExpression 的 TTL 索引为与过滤器匹配的文档设置过期期限。如果设置了 expireAfterSeconds，则您也可使用部分 TTL 索引为匹配文档设置较短的过期期限。只能在 metaField 上创建 partialFilterExpression。

此天气数据时间序列集合会在 24 小时后删除文档：

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

此 TTL 索引会在 1 小时（而不是 24 小时）后从 MongoDB NYC 总部天气传感器中删除文档：

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

更改 TTL 索引的 expireAfterSeconds 值

要更改 TTL 索引的 expireAfterSeconds 值，请使用 collMod 数据库命令：

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

以下示例更改 tickets 集合上具有模式 { "lastModifiedDate": 1 } 的索引的 expireAfterSeconds 值：

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 索引。

• 从 MongoDB 7.0开始，您可以在时间序列集合的 metaField 上创建一个部分 TTL 索引。在早期 MongoDB 版本中，您只能为时间序列集合的 timeField 创建 TTL 索引。

• 不能使用 createIndex() 更改现有索引的 expireAfterSeconds 值。请使用 collMod 数据库命令。有关详情，请参阅更改 TTL 索引的 expireAfterSeconds 值。

• 如果某个字段已存在非 TTL 单字段索引，则无法对同一字段创建 TTL 索引，因为无法创建具有相同键规范且仅选项不同的索引。要将非 TTL 单字段索引更改为 TTL 索引，请使用 collMod 数据库命令。