TTL 索引

创建TTL索引

要创建一个TTL索引，请使用createIndex()方法。[点击此处查看详情](/docs/manual/reference/method/db.collection.createIndex/#mongodb-method-db.collection.createIndex)。指定一个索引字段，该字段可以是日期类型或包含日期类型值的数组。使用expireAfterSeconds选项来指定以秒为单位的TTL值。

TTL索引的expireAfterSeconds值必须在0到2147483647之间（包含）。

例如，要在eventlog集合的lastModifiedDate字段上创建一个TTL值为3600秒的TTL索引，请使用以下在mongosh中进行的操作。[点击此处查看详情](https://mongodb.ac.cn/docs/mongodb-shell/#mongodb-binary-bin.mongosh)

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

从MongoDB 6.3版本开始，您可以为时间序列集合创建部分TTL索引。[点击此处查看详情](/docs/manual/core/timeseries-collections/#std-label-manual-timeseries-landing)。这些索引使用集合的timeField作为键字段，并在metaField上需要部分过滤表达式。

时间序列集合包含一个可选的expireAfterSeconds字段。如果您未设置expireAfterSeconds，则具有部分过滤表达式的TTL索引可让您为与过滤器匹配的文档设置过期期限。如果您设置了expireAfterSeconds，则部分TTL索引可让您为匹配的文档设置不同的、较短的过期期限。您只能在metaField上创建部分过滤表达式。

如果时间序列集合包含timeField时间戳早于1970-01-01T00:00:00.000Z或晚于2038-01-19T03:14:07.000Z的文档，则TTL“存活时间”功能不会从集合中删除任何文档。

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

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

此TTL索引在1小时后从MongoDB纽约总部天气传感器中删除文档，而不是24小时

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并忽略expireAfterSeconds选项。

• id字段不支持TTL索引。

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

• 您不能使用 createIndex() 来更改现有索引中 expireAfterSeconds 的值。相反，请使用 collMod 数据库命令。有关详细信息，请参阅 更改 TTL 索引的 expireAfterSeconds 值。

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