Skip to content

Commit

Permalink
move east and east mongo note text above at readme
Browse files Browse the repository at this point in the history
  • Loading branch information
okv committed Jan 26, 2020
1 parent d8e8b0f commit 400eebd
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
mongodb adapter for [east](https://github.com/okv/east) (node.js database migration tool) which uses
[mongodb native driver](http://mongodb.github.io/node-mongodb-native/)

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.

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:

* `db` - instance of [mongodb native db](http://mongodb.github.io/node-mongodb-native/3.4/api/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 400eebd

Please sign in to comment.