TTL Indexes

Cree un índice TTL

Para crear un índice TTL, utiliza createIndex(). Especifica un campo de índice que sea un tipo de fecha o un arreglo que contenga valores de tipo de fecha. Utiliza la opción expireAfterSeconds para especificar un valor de TTL en segundos.

El valor del índice TTL expireAfterSeconds debe estar entre 0 y 2147483647, inclusive.

Por ejemplo, para crear un índice TTL en el campo lastModifiedDate de la colección eventlog con un valor TTL de 3600 segundos, utilice la siguiente operación en mongosh:

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

A partir de MongoDB 7.0, puedes crear índices TTL parciales en colecciones de series de tiempo. Estos índices utilizan la colección timeField como campo clave y requieren una expresión de filtro parcial en el metaField.

Las colecciones de series de tiempo incluyen un campo opcional expireAfterSeconds. Si no se establece expireAfterSeconds, un índice TTL con una partialFilterExpression permite establecer un período de expiración para los documentos que coinciden con el filtro. Si se configura expireAfterSeconds, un índice TTL parcial permite establecer un período de caducidad diferente y más corto para los documentos coincidentes. Solo se puede crear una partialFilterExpression en el metaField.

Si una colección de series de tiempo contiene documentos con marcas de tiempo timeField antes de 1970-01-01T00:00:00.000Z o después de 2038-01-19T03:14:07.000Z, ningún documento se elimina de la colección por la funcionalidad TTL "tiempo de vida".

Esta colección de series de tiempo de datos meteorológicos borra documentos después de 24 horas:

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

Este índice TTL borra documentos del sensor meteorológico de la sede de MongoDB en Nueva York después de 1 hora, en lugar de 24 horas:

db.weather24h.createIndex(
  { "timestamp": 1 },
  {
     partialFilterExpression: {
        "sensor": { $eq: "40.761873, -73.984287" }
     },
     expireAfterSeconds: 3600
  }
)

Convertir un índice de campo único que no sea TTL en un índice TTL

A partir de MongoDB 5.1, puedes añadir la opción expireAfterSeconds a un índice de campo único existente. Para cambiar un índice de campo único no TTL a un índice TTL, usa el comando de base de datos collMod:

db.runCommand({
  "collMod": <collName>,
  "index": {
    "keyPattern": <keyPattern>,
    "expireAfterSeconds": <number>
  }
})

El siguiente ejemplo convierte un índice de un solo campo no-TTL con el patrón { "lastModifiedDate": 1 } en un índice TTL:

db.runCommand({
  "collMod": "tickets",
  "index": {
    "keyPattern": { "lastModifiedDate": 1 },
    "expireAfterSeconds": 100
  }
})

Cambiar el valor de expireAfterSeconds para un índice TTL

Para cambiar el valor expireAfterSeconds de un índice TTL, usa el comando de base de datos collMod:

db.runCommand({
  "collMod": <collName>,
  "index": {
    "keyPattern": <keyPattern>,
    "expireAfterSeconds": <number>
  }
})

El siguiente ejemplo cambia el valor de expireAfterSeconds para un índice con el patrón { "lastModifiedDate": 1 } en la colección tickets:

db.runCommand({
  "collMod": "tickets",
  "index": {
    "keyPattern": { "lastModifiedDate": 1 },
    "expireAfterSeconds": 100
  }
})

Comportamiento

TTL y validación de esquema

Aunque los índices TTL no requieren validación de esquema, el uso de la validación puede ayudar a garantizar un comportamiento coherente al estandarizar la existencia y el formato del campo de fecha utilizado para la expiración.

Por ejemplo, puedes utilizar la validación de esquema para aplicar la presencia de un campo lastModifiedDate y asegurarse de que su valor cumpla con un formato de fecha válido:

db.createCollection(
   "eventlog",
   {
      validator: {
         $jsonSchema: {
            bsonType: "object",
            required: [ "lastModifiedDate" ],
            properties: {
               lastModifiedDate: {
                  bsonType: "date",
                  description: "Must be a valid date."
               }
            }
         }
      }
   }
)

La validación garantiza:

• Cada documento en la colección eventlog incluye el campo lastModifiedDate.

• El campo lastModifiedDate contiene un valor de fecha válido.

Restricciones

• Los índices TTL son índices de campo único. Los índices compuestos no brindan soporte a TTL e ignoran la opción expireAfterSeconds.

• El campo _id no brinda soporte a índices TTL.

• No puedes crear un índice TTL en una colección con tamaño fijo.

• A partir de MongoDB 7.0, puedes crear un índice TTL parcial en la colección de series de tiempo metaField. En versiones anteriores de MongoDB, solo puedes crear un índice TTL para el timeField de una colección de series de tiempo.

• No puedes usar createIndex() para cambiar el valor de expireAfterSeconds de un índice existente. En su lugar, utiliza el comando de base de datos collMod. Para obtener más detalles, consulta Cambiar el valor de expireAfterSeconds para un índice TTL.

• Si ya existe un índice de campo único no TTL para un campo, no puedes crear un índice TTL en el mismo campo porque no se pueden crear índices que tengan la misma especificación de clave y que solo se diferencien por las opciones. Para cambiar un índice de campo único que no sea TTL a un índice TTL, utiliza el comando de base de datos collMod.