github/overleaf
1
0
Fork 0
mirror of https://github.com/overleaf/overleaf.git synced 2024-12-01 13:42:21 -05:00
Code Issues Projects Releases Packages Wiki Activity

Add commentary on ttl index

Browse source
This commit is contained in:
Shane Kilkelly 2016-08-11 12:03:50 +01:00
parent 05e390ef89
commit a17040f00f
2 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
services/notifications/README.md
View file

@ -2,3 +2,13 @@ notifications-sharelatex
=============== ===============
An API for managing user notifications in ShareLaTeX An API for managing user notifications in ShareLaTeX
database indexes
================
For notification expiry to work, a ttl index on `notifications.expiresFrom` must be created:
```javascript
db.notifications.createIndex({expiresFrom: 1}, {expireAfterSeconds: (60*60*24*30)})
```

2
services/notifications/app/coffee/Notifications.coffee
View file

@ -29,6 +29,8 @@ module.exports =
templateKey: notification.templateKey templateKey: notification.templateKey
expires: notification.expires || false expires: notification.expires || false
# ttl index on `expiresFrom` field # ttl index on `expiresFrom` field
# in Mongo, TTL indexes only work on date fields,
# and ignore the document when that field is missing
if doc.expires if doc.expires
doc.expiresFrom = new Date() doc.expiresFrom = new Date()
db.notifications.insert(doc, callback) db.notifications.insert(doc, callback)