API Docs for: 0.8.0
Show:

TTLIndexHelper Class

Defined in: include/dao/mongo/ttl_index_helper.js:25
Module: dao

Used to change the TTL index on a collection without elevated permissions

Constructor

TTLIndexHelper

()

Defined in include/dao/mongo/ttl_index_helper.js:25

Item Index

Methods

Properties

Methods

ensureIndex

(
  • procedure
  • cb
)

Defined in include/dao/mongo/ttl_index_helper.js:51

Parameters:

  • procedure Object
  • cb Function

hasCorrectTTLIndex

(
  • collection
  • indexName
  • expectedExpiry
  • cb
)

Defined in include/dao/mongo/ttl_index_helper.js:138

Retrieves and compares the expiry of a TTL index on the specified collection to the expiry provided. Calls back with TRUE if and only if the index is found the expiries match.

Parameters:

  • collection String
  • indexName String
  • expectedExpiry Integer
  • cb Function

Properties

INDEX_MOD_KEY_PREFIX

String private static

Defined in include/dao/mongo/ttl_index_helper.js:41