A migration tool for RethinkDB
Forked from ParabolInc/migrate-rethinkdb
migrate-rethinkdb
is a utility allowing you to version
changes to a RethinkDB database. Forward
or backward migrate structural or data changes. Share
and control these changes with other developers.
This code is a fork of Johan Obrink's
rethink-migrate.
migrate-rethinkdb
is more actively maintained.
$ npm install -g migrate-rethinkdb
Install a RethinkDB driver:
npm install --save rethinkdb
or
npm install --save rethinkdbdash
Create a database.json
file in the root of your solution with the format:
{
"host": "localhost",
"port": 28015,
"db": "migrations",
"discovery": true,
"timeout": 60
}
Other, optional, parameters are authKey
and ssl
.
You can also use environment variables or arguments to override.
The default is info. This will log info, warnings and errors. Possible values for logLevel are "debug" | "info" | "warning" | "error" | "none".
$ migrate-rethinkdb create [migration name]
For example:
migrate-rethinkdb create add-tables
Open the file ./migrations/[timestamp]-[migration name].js
Add the changes to be made. For example:
exports.up = function (r, connection) {
return r.tableCreate('foo').run(connection);
};
exports.down = function (r, connection) {
return r.tableDrop('foo').run(connection);
};
migrate-rethinkdb up --one
will run one up migration.
migrate-rethinkdb up --all
will run all outstanding up migrations.
migrate-rethinkdb down --one
will run one down migration.
migrate-rethinkdb down --all
will run all outstanding down migrations.
If either --all
or --one
isn't specified, --all
is the default.
migrate-rethinkdb up --root ./build
will run all outstanding up migrations
found in ./build/migrations
with database.json
in ./build
.
-r
can be used as an alias.
migrate-rethinkdb up --logLevel debug
will set logLevel to debug.
Possible values are: debug | info | warning | error | none.
-l
can be used as an alias.
migrate-rethinkdb up --loadEnv
will load .env file to environmental variable.
-le
can be used as an alias.
Run docker-compose up
If necessary, change the IP address in test/database.json
Run gulp jshint test
To run tests continually, add watch
to the gulp command
The MIT License (MIT)
Copyright (c) 2017 Parabol, Inc. Copyright (c) 2015 Johan Öbrink
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.