Skip to content

Commit

Permalink
add note about east compatibility to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
okv committed Dec 28, 2019
1 parent 55b2109 commit d6e4b07
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ All executed migrations names will be stored at `_migrations` collection in the
current database. Object with following properties will be passed to `migrate`
and `rollback` functions:

*Please note* that mainstream mongodb adapter version (>= 1.x) requires
east >= 1.x, for using adapter with older east versions (prior to 1.x) please
use mongodb adapter version < 1.x.

* `db` - instance of [mongodb native db](http://mongodb.github.io/node-mongodb-native/api-generated/db.html)
* `dropIndexIfExists` function(collection, index, callback) - helper function
which can be used for dropping index in safe way (contrasting to
Expand Down

0 comments on commit d6e4b07

Please sign in to comment.