diff --git a/README.md b/README.md index 039f084..9b32734 100644 --- a/README.md +++ b/README.md @@ -446,6 +446,9 @@ To create an index, use `datastore.ensureIndex(options, cb)`, where callback is Note: the `_id` is automatically indexed with a unique constraint, no need to call `ensureIndex` on it. +You can remove a previously created index with `datastore.removeIndex(fieldName, cb)`. + +If your datastore is persistent, the indexes you created are persisted in the datafile, when you load the database a second time they are automatically created for you. No need to remove any `ensureIndex` though, if it is called on a database that already has the index, nothing happens. ```javascript db.ensureIndex({ fieldName: 'somefield' }, function (err) { @@ -470,6 +473,10 @@ db.insert({ somefield: 'nedb' }, function (err) { // , message: 'Unique constraint violated for key name' } }); }); + +// Remove index on field somefield +db.removeIndex('somefield', 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).