Bundle: Expiration

The expiration bundle serves a very simple purpose, it deletes documents whose time have passed. Usage scenarios for the Expiration Bundle include storing user sessions in RavenDB or using RavenDB as a cache.

Usage

You can set the expiration date for a document using the following code:

var expiry = DateTime.UtcNow.AddMinutes(5);
using (var session = documentStore.OpenSession())
{
	session.Store(userSession);
	session.Advanced.GetMetadataFor(userSession)["Raven-Expiration-Date"] = new RavenJValue(expiry);
	session.SaveChanges();
}

As you can see, all we need to do is set the Raven-Expiration-Date property on the metadata for the appropriate date. And at the specified time, the document will automatically be deleted.