TTL Indexes

创建 TTL 索引

要创建 TTL 索引，请使用 createIndex()。指定一个日期类型或包含日期类型值的数组的索引字段。使用 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 索引匹配“weather24h”集合中的文档，其中“sensor”字段设置为“MDB_NYC”，并在 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>
  }
})

以下示例更改 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 数据库命令。