MongoDB（91）如何在MongoDB中使用TTL索引？

MongoDB 支持 TTL（Time To Live）索引，这种索引类型允许你自动从集合中删除文档。在某些应用场景中，如日志管理、缓存系统等，TTL 是非常有用的。TTL 索引会根据文档中的日期字段自动移除文档，来减少存储和保持数据的新鲜性。下面详细介绍如何在 MongoDB 中使用 TTL 索引。

一、TTL 索引的工作原理

TTL 索引是基于日期字段的，在指定的时间过后，MongoDB 会自动删除超过 TTL 期限的文档。TTL 索引有一个 expireAfterSeconds 参数，用于指定文档的生存时间。

二、使用 TTL 索引的步骤

1. 准备工作

确保你的 MongoDB 服务器正在运行，并且你已经连接到数据库。

2. 创建集合和插入数据

首先，创建一个集合并插入一些示例数据：

use mydatabase;

// 插入一些示例数据
db.logs.insertMany([
    { message: "Log 1", createdAt: new Date() },
    { message: "Log 2", createdAt: new Date(new Date().getTime() - 3600 * 1000) }, // 1 hour ago
    { message: "Log 3", createdAt: new Date(new Date().getTime() - 2 * 3600 * 1000) } // 2 hours ago
]);

3. 创建 TTL 索引

在 createdAt 字段上创建 TTL 索引，并设置文档的生存时间为 3600 秒（即 1 小时）：

db.logs.createIndex({ "createdAt": 1 }, { expireAfterSeconds: 3600 });

这意味着任何 createdAt 字段的时间戳超过当前时间 1 小时的文档将会被自动删除。

三、验证 TTL 索引

你可以通过等待一段时间，来验证文档是否被自动删除。TTL 删除操作并不是实时的，MongoDB 每 60 秒检查一次符合 TTL 条件的文档并进行删除。

1. 检查索引

使用 getIndexes 查看索引信息，确保 TTL 索引已经创建：

db.logs.getIndexes();

输出可能如下：

[
    {
        "v": 2,
        "key": {
            "createdAt": 1
        },
        "name": "createdAt_1",
        "expireAfterSeconds": 3600
    }
]

2. 等待并检查数据

等待超过 1 小时，然后检查集合中的数据是否被删除：

// 查看集合中的剩余数据
db.logs.find();

如果一切正常，1 小时前的日志将被自动删除，只剩下新的日志。

四、代码示例

以下是一个完整的 Node.js 示例，展示了如何使用 Mongoose 创建 TTL 索引：

1. 安装 Mongoose

npm install mongoose

2. 创建 app.js

const mongoose = require('mongoose');

const dbURL = 'mongodb://localhost:27017/mydatabase';

mongoose.connect(dbURL, {
    useNewUrlParser: true,
    useUnifiedTopology: true
}).then(() => {
    console.log('Connected to MongoDB');
}).catch(err => {
    console.error('Connection error', err);
});

// 定义 Schema
const logSchema = new mongoose.Schema({
    message: String,
    createdAt: {
        type: Date,
        default: Date.now,
        index: { expires: '1h' }  // TTL 索引，文档将在 1 小时后过期
    }
});

// 创建 Model
const Log = mongoose.model('Log', logSchema);

// 插入示例数据
const log1 = new Log({ message: 'Log 1' });
const log2 = new Log({ message: 'Log 2', createdAt: new Date(new Date().getTime() - 3600 * 1000) }); // 1 hour ago
const log3 = new Log({ message: 'Log 3', createdAt: new Date(new Date().getTime() - 2 * 3600 * 1000) }); // 2 hours ago

log1.save();
log2.save();
log3.save();

console.log('Logs inserted');
setTimeout(async () => {
    // 查询集合中的数据
    const logs = await Log.find();
    console.log('Remaining logs:', logs);
}, 3700 * 1000); // 等待稍长于 1 小时，以确保 TTL 有时间生效

五、注意事项

1. TTL 删除并非实时：MongoDB 的 TTL 监控器每 60 秒运行一次，因此文档的删除可能会有一些延迟。
2. TTL 精度：TTL 精度在几秒钟到一分钟之间，具体取决于 MongoDB 服务器的负载和配置。
3. 限制：TTL 索引只能创建在单个字段上，且该字段必须是日期类型或包含日期类型的数组。
4. 性能：在高写入负载的情况下，TTL 删除可能会对性能产生影响，需要进行测试和优化。

总结

TTL 索引是 MongoDB 提供的一个强大功能，可以帮助自动管理数据的生命周期。通过使用 TTL 索引，可以有效减少存储空间占用，并确保数据的及时更新和删除。上述示例和步骤展示了如何在 MongoDB 中创建和使用 TTL 索引，帮助你在实际项目中更好地管理数据。