MongoDB TTL索引的实例详解

简介

MongoDB 中 TTL（Time To Live） 索引是一种特殊类型的索引，可以使文档在某一固定时间后自动过期。该索引可以帮助我们自动删除一些过期的数据。

在实际的业务场景中，一些数据不适合一直保存在数据库中，过期的数据可能会占用太多的空间或导致查询变得缓慢，所以我们需要及时地对它们进行清理。

TTL 索引的使用会对读写性能有一定影响，需要谨慎使用。

创建 TTL 索引

创建 TTL 索引的语法如下：

db.collection.createIndex({ field: 1, expireAfterSeconds: 0 })

其中，field 是指需要过期的字段，expireAfterSeconds 指定了该字段需要过期的时间，单位为秒。

一些注意点如下：

• 只能有一个 TTL 索引。
• TTL 索引只支持 Date 类型的字段。
• 在插入或更新文档时，MongoDB 会自动检查 TTL 索引。如果索引中字段的值小于当前时间，MongoDB 将文档自动删除。

例如，下面我们将创建一个名为 users 的集合，并创建一个名称为 expire_at 的 TTL 索引。该索引会在用户注册后的 30 秒钟内自动将该用户数据从数据库中删除。

> use test
> db.createCollection("users")
> db.users.createIndex({ "expire_at": 1 }, { expireAfterSeconds: 30 })

示例 1：使用 TTL 索引自动删除过期的文档

假设我们需要存储一些活动的信息，并在活动过期后自动从数据库中将其删除。我们可以使用以下代码来演示如何实现：

// 首先创建一个名为 activities 的集合，并在 expire_at 字段上创建一个 TTL 索引
> db.createCollection("activities")
> db.activities.createIndex({ "expire_at": 1 }, { expireAfterSeconds: 0 })

// 插入一个活动，设置其过期时间为一分钟后
> db.activities.insertOne({
...   "title": "周末游泳",
...   "description": "周末去海边游泳",
...   "expire_at": new Date(Date.now() + 60*1000) // 设置过期时间
... })

// 过期前查找活动并删除
> db.activities.find({}).pretty()
{
  "_id": ObjectId("6159ed0813c50863aee75fe1"),
  "title": "周末游泳",
  "description": "周末去海边游泳",
  "expire_at": ISODate("2021-10-04T14:36:24.945Z")
}
> sleep(60*1000) // 等待一分钟
> db.activities.find({}).pretty()

上面的操作中，我们首先在 activities 集合上创建了一个 TTL 索引，并向其中插入了一个活动数据，并将其过期时间设置为一分钟后。过期时间到达后，该文档自动从数据库中删除。

示例 2：使用 TTL 索引实现消息队列

再看一个更实际的应用：消息队列。我们需要实现这样一个功能：向消息队列中插入一条消息，并在指定时间后自动将其删除。TTL 索引正好能够帮我们实现这个功能。

以下是代码示例：

// 首先创建一个名为 messages 的集合，并在 expire_at 字段上创建一个 TTL 索引。
> db.createCollection("messages")
> db.messages.createIndex({ "expire_at": 1 }, { expireAfterSeconds: 0 })

// 插入一条消息，并设置其过期时间为 10 秒后
> db.messages.insertOne({
...   "content": "hello, world",
...   "expire_at": new Date(Date.now() + 10*1000) // 设置过期时间
... })

// 等待过期时间，检查消息是否自动被删除
> sleep(10*1000)
> db.messages.find({}).pretty()

以上操作中，我们首先在 messages 集合上创建了一个 TTL 索引，然后向其中插入了一条消息，并将其过期时间设置为 10 秒后。当过期时间到达后，该文档自动从数据库中删除。