Setting expiry time for a collection in mongodb using mongoose

Question

Below is the command that can be used via the mongo terminal to set an expiry time for collections (a TTL):

db.log.events.ensureIndex( { "status": 1 }, { expireAfterSeconds: 3600 } )

How do I do this from my code in Node.js using mongoose?

Answer 1

In Mongoose, you create a TTL index on a Date field via the expires property in the schema definition of that field:

// expire docs 3600 seconds after createdAt
new Schema({ createdAt: { type: Date, expires: 3600 }});

Note that:

• MongoDB's data expiration task runs once a minute, so an expired doc might persist up to a minute past its expiration.
• This feature requires MongoDB 2.2 or later.
• It's up to you to set createdAt to the current time when creating docs, or add a default to do it for you as suggested here.
  • { createdAt: { type: Date, expires: 3600, default: Date.now }}

Answer 2

this code is working for me.

may it help

let currentSchema = mongoose.Schema({
    id: String,
    name: String,
    packageId: Number,
    age: Number
}, {timestamps: true});

currentSchema.index({createdAt: 1},{expireAfterSeconds: 3600});

Answer 3

Providing a string to expires also works nicely with Mongoose if you do not want to deal with the expire time calculation and improve the overall readability of the schema.

For example here we are setting the expires to 2m (2 minutes) and mongoose would convert to 120 seconds for us:

var TestSchema = new mongoose.Schema({
  name: String,
  createdAt: { type: Date, expires: '2m', default: Date.now }
});

Mongoose would create an index in the background and auto set the expireAfterSeconds to in this case 120 seconds (specified by the 2m).

It is important to note that the TTL process runs once every 60 seconds so it is not perfectly on time always.

Answer 4

If you are working with Mongodb Atlas Replica Sets - try:

import * as mongoose from 'mongoose'; 

let currentSchema = new mongoose.Schema({
        createdAt: { type: Date, expires: 10000, default: Date.now },
        id: String,
        name: String,
        packageId: Number,
        age: Number
        });

currentSchema.index({"lastModifiedDate": 1 },{ expireAfterSeconds: 10000 });

Answer 5

new Scehma({
    expireAt: {
      type: Date,
      expires: 11,
      default: Date.now
  }
)}

This is the solution that worked for me according to this in the current Mongoose docs.

Answer 6

9/2022 Working Solution using Mongoose 6.5.4

None of the answers here worked for me, but I was able to finally get it working using the latest version of Mongoose currently available, 6.5.4.

Say our Schema looks like this:

const MySchema = new mongoose.Schema({
  id: { type: Number },
  myCustomTTLField: { type: Date }
});

myCustomTTLField is the field you want to index and have control the expiration. To achieve this, we add the following under our schema definition:

MySchema.path('myCustomTTLField').index({ expires: 60 });

The argument in MySchema.path is the name of the field you want to index for TTL. The expires option should be the number of seconds that will elapse from the Date represented in myCustomTTLField before the document is deleted. In the example above, the document will be deleted 60 seconds after whatever date is saved in myCustomTTLField. The full example:

const MySchema = new mongoose.Schema({
  id: { type: Number },
  myCustomTTLField: { type: Date }
});
MySchema.path('myCustomTTLField').index({ expires: 60 });

Please let me know if this works for you, I hope this helps. Mongoose TTL has been a thorn in my side for a long time, as their docs are notoriously tough to navigate. I found this solution via a small example buried in the docs here.

IMPORTANT NOTE: TTL is not guaranteed to happen at exactly the time specified by your date + expiration seconds. This is due to how MongoDB's background delete process works. It runs every 60 seconds, so you may theoretically wait up to 60 seconds past expected TTL before seeing your document deleted. More info on that from the MongoDB docs.

Answer 7

There is a npm library - 'mongoose-ttl'.:

var schema = new Schema({..});
schema.plugin(ttl, { ttl: 5000 });

you can see all the options of this library: https://www.npmjs.com/package/mongoose-ttl

Answer 8

const Schema = new mongoose.Schema({id: {
type: Number}, 
createdAt: {
type: Date, expires: '4h', index: true,
default: Date.now}});

You need to add index: true while creating you schema

Answer 9

FWIW I could only get the expires feature to work on a field called expiresAt. Here's my interface, and schema for implementing this in Typescript.

import { model, Schema, Types } from 'mongoose';

export interface ISession {
  sessionId: string;
  userId: Types.ObjectId;
  role: string;
  expiresAt?: Date;
}

const sessionSchema = new Schema<ISession>({
  sessionId: { type: String, required: true, indexes: { unique: true} },
  userId: { type: Schema.Types.ObjectId, required: true, ref: 'users'},
  role: { type: String, required: true, enum: [ 'ADMIN', 'BASIC_USER' ]},
  expiresAt: { type: Date, expires: '1h', default: Date.now }
}, { versionKey: false });

Reading the Mongoose documentation it seems like all the other proposed solutions should work too. I don't know why they were not for me. You can read the official Mongoose docs on expiresAt here.