Update README.md

pull/2/head
Louis Chatriot 9 years ago
parent 47c4454a2c
commit 8d376c7e71
  1. 5
      README.md

@ -553,6 +553,7 @@ To create an index, use `datastore.ensureIndex(options, cb)`, where callback is
* **fieldName** (required): name of the field to index. Use the dot notation to index a field in a nested document. * **fieldName** (required): name of the field to index. Use the dot notation to index a field in a nested document.
* **unique** (optional, defaults to `false`): enforce field uniqueness. Note that a unique index will raise an error if you try to index two documents for which the field is not defined. * **unique** (optional, defaults to `false`): enforce field uniqueness. Note that a unique index will raise an error if you try to index two documents for which the field is not defined.
* **sparse** (optional, defaults to `false`): don't index documents for which the field is not defined. Use this option along with "unique" if you want to accept multiple documents for which it is not defined. * **sparse** (optional, defaults to `false`): don't index documents for which the field is not defined. Use this option along with "unique" if you want to accept multiple documents for which it is not defined.
* **expireAfterSeconds** (number of seconds, optional): if set, the created index is a TTL (time to live) index, that will automatically remove documents when the system date becomes larger than the date on the indexed field plus `expireAfterSeconds`
Note: the `_id` is automatically indexed with a unique constraint, no need to call `ensureIndex` on it. Note: the `_id` is automatically indexed with a unique constraint, no need to call `ensureIndex` on it.
@ -587,6 +588,10 @@ db.insert({ somefield: 'nedb' }, function (err) {
// Remove index on field somefield // Remove index on field somefield
db.removeIndex('somefield', function (err) { db.removeIndex('somefield', function (err) {
}); });
// Example of using expireAfterSeconds to remove documents 1 hour after their creation (timestampData option is true here)
db.ensureIndex({ fieldName: 'createdAt', expireAfterSeconds: 3600 }, function (err) {
});
``` ```
**Note:** the `ensureIndex` function creates the index synchronously, so it's best to use it at application startup. It's quite fast so it doesn't increase startup time much (35 ms for a collection containing 10,000 documents). **Note:** the `ensureIndex` function creates the index synchronously, so it's best to use it at application startup. It's quite fast so it doesn't increase startup time much (35 ms for a collection containing 10,000 documents).

Loading…
Cancel
Save