Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/percolatestudio/meteor-migrations
Simple migration system for Meteor
https://github.com/percolatestudio/meteor-migrations
hacktoberfest meteor
Last synced: 27 days ago
JSON representation
Simple migration system for Meteor
- Host: GitHub
- URL: https://github.com/percolatestudio/meteor-migrations
- Owner: percolatestudio
- License: mit
- Created: 2014-01-10T15:56:10.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2024-07-31T16:56:18.000Z (3 months ago)
- Last Synced: 2024-09-26T19:20:11.909Z (about 1 month ago)
- Topics: hacktoberfest, meteor
- Language: JavaScript
- Homepage: https://atmospherejs.com/percolate/migrations
- Size: 137 KB
- Stars: 245
- Watchers: 10
- Forks: 58
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-meteor - percolate:migrations - Simple migration system for Meteor (Deployment)
README
# percolate:migrations
[](https://travis-ci.org/percolatestudio/meteor-migrations)
A simple migration system for [Meteor](http://meteor.com) supporting up/downwards migrations and command line usage. There is also [a fork available](https://github.com/emmanuelbuah/mgdb-migrator) for use outside of Meteor.
## Installation
Meteor Migrations can be installed through Meteor's package manager. Type:
``` sh
$ meteor add percolate:migrations
```
## API
### Basics
To write a simple migration, somewhere in the server section of your project define:
``` javascript
Migrations.add({
version: 1,
up: function() {//code to migrate up to version 1}
});
```
To run this migration from within your app call:
``` javascript
Meteor.startup(() => {
Migrations.migrateTo('latest');
});
```
### Advanced
A more complete set of migrations might look like:
``` javascript
Migrations.add({
version: 1,
name: 'Adds pants to some people in the db.',
up: function() {//code to migrate up to version 1}
down: function() {//code to migrate down to version 0}
});
Migrations.add({
version: 2,
name: 'Adds a hat to all people in the db who are wearing pants.',
up: function() {//code to migrate up to version 2}
down: function() {//code to migrate down to version 1}
});
```
As in 'Basics', you can migrate to the latest by running:
``` javascript
Meteor.startup(function() {
Migrations.migrateTo('latest');
});
```
*Note: Migrations should be run from `Meteor.startup` to allow for log output configuration.*
By specifying a version, you can migrate directly to that version (if possible). The migrations system will automatically determine which direction to migrate in.
In the above example, you could migrate directly to version 2 by running:
``` javascript
Migrations.migrateTo(2);
```
If you wanted to undo all of your migrations, you could migrate back down to version 0 by running:
``` javascript
Migrations.migrateTo(0);
```
Sometimes (usually when somethings gone awry), you may need to re-run a migration. You can do this with the rerun subcommand, like:
``` javascript
Migrations.migrateTo('3,rerun');
```
**NOTE**: You cannot create your own migration at version 0. This version is reserved by migrations for a 'vanilla' system, that is, one without any migrations applied.
To see what version the database is at, call:
``` javascript
Migrations.getVersion();
```
### Configuration
You can configure Migrations with the `config` method. Defaults are:
``` javascript
Migrations.config({
// Log job run details to console
log: true,
// Use a custom logger function (defaults to Meteor's logging package)
logger: null,
// Enable/disable logging "Not migrating, already at version {number}"
logIfLatest: true,
// migrations collection name to use in the database
collectionName: "migrations"
});
```
### Logging
Migrations uses Meteor's `logging` package by default. If you want to use your
own logger (for sending to other consumers or similar) you can do so by
configuring the `logger` option.
Migrations expects a function as `logger`, and will pass arguments to it for
you to take action on.
```js
var MyLogger = function(opts) {
console.log('Level', opts.level);
console.log('Message', opts.message);
console.log('Tag', opts.tag);
}
Migrations.config({
logger: MyLogger
});
Migrations.add({ name: 'Test Job', ... });
```
The `opts` object passed to `MyLogger` above includes `level`, `message`, and `tag`.
- `level` will be one of `info`, `warn`, `error`, `debug`.
- `message` is something like `Finished migrating.`.
- `tag` will always be `"Migrations"` (handy for filtering).
### Custom collection name
By default, the collection name is **migrations**. There may be cases where this is inadequate such as using the same Mongo database for multiple Meteor applications that each have their own set of migrations that need to be run.
### Command line use
*** DEPRECATED ***
This info is for pre 0.9 users as post 0.9 the `migrate.sh` script is no longer included in the package folder.
You can also run migrations from the command line using the included shell script. This will
1. Launch your Meteor app
2. Call `Migrations.migrateTo(version)`
3. Exit your app
For instance, from your project's root, run:
``` sh
$ ./packages/percolatestudio-migrations/migrate.sh latest
```
You can also specify additional arguments to be passed into meteor, like:
``` sh
$ ./packages/percolatestudio-migrations/migrate.sh latest --settings ./setting.json
```
### Errors
1. `Not migrating, control is locked`
Migrations set a lock when they are migrating, to prevent multiple instances of your clustered app from running migrations simultaneously. If your migrations throw an exception, you will need to manually remove the lock (and ensure your db is still consistent) before re-running the migration.
From the mongo shell update the migrations collection like this:
```
$ meteor mongo
db.migrations.update({_id:"control"}, {$set:{"locked":false}});
exit
```
Alternatively you can unlock the collection from either server code or the meteor shell using:
```
Migrations.unlock();
```
### Threading and Callbacks
The following is example code to wait for asynchronous code to complete prior to going on to next migration.
```js
Migrations.add({
version: 1,
up: Meteor.wrapAsync(async (_, next) => {
await doSomethingAsynchonously();
next();
}),
down: Meteor.wrapAsync(async (_, next) => {
await doDownAsynchronously();
next();
}),
});
```
For Meteor 2.8+ you can pass async function directly.
* Note: You may want to call migration after startup in case your host (such as Heroku) limits the amount of time given for startup
``` javascript
Meteor.startup(function() {
setTimetout("Migrations.migrateTo('latest')", 0);
});
```
## License
MIT. (c) Percolate Studio, Meteor Software
Meteor Migrations was developed as part of the [Verso](http://versoapp.com) project.