Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/2do2go/east-postgres
postgres adapter for "east"
https://github.com/2do2go/east-postgres
Last synced: 29 days ago
JSON representation
postgres adapter for "east"
- Host: GitHub
- URL: https://github.com/2do2go/east-postgres
- Owner: 2do2go
- Created: 2015-01-28T06:10:23.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2018-02-15T07:07:08.000Z (almost 7 years ago)
- Last Synced: 2024-11-15T08:27:11.000Z (about 2 months ago)
- Language: JavaScript
- Homepage: https://github.com/2do2go/east-postgres
- Size: 8.79 KB
- Stars: 2
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# east postgres
postgresql adapter for [east](https://github.com/okv/east) (node.js database migration tool) which uses
[node-postgres](https://github.com/brianc/node-postgres)
All executed migrations names will be stored at `_migrations` table in the
current database. Object with following properties will be passed to `migrate`
and `rollback` functions:
* `db` - instance of [node-postgres](https://github.com/brianc/node-postgres/wiki/Client)
## Installation
```sh
npm install east east-postgres -g
```
alternatively you could install it locally
## Usage
go to project dir and run
```sh
east init
```
create `.eastrc` file at current directory
```js
{
"adapter": "east-postgres",
"url": "postgres://user:[email protected]:5432/database"
}
```
where `url` is url for connect to postgresql db: "postgres://someuser:somepassword@somehost:381/sometable"
now we can create some migrations
```sh
east create apples
east create bananas
```
created files will looks like this one
```js
exports.migrate = function(client, done) {
var db = client.db;
done();
};
exports.rollback = function(client, done) {
var db = client.db;
done();
};
```
edit created files and insert
to 1_apples
```js
exports.migrate = function(client, done) {
var db = client.db;
var sqlStr = 'insert into things values($1, $2, $3)';
db.run(sqlStr, [1, 'apple', 'red'], function(err) {
if (err) return done(err);
db.run(sqlStr, [2, 'apple', 'green'], done);
});
};
exports.rollback = function(client, done) {
var db = client.db;
db.run('delete from things where id in (1, 2)', done);
};
```
to 2_bananas
```js
exports.migrate = function(client, done) {
var db = client.db;
db.run('insert into things values($1, $2, $3)', [3, 'banana', 'yellow'], done);
};
exports.rollback = function(client, done) {
var db = client.db;
db.run('delete from things where id=3', done);
};
```
now we can execute our migrations
```sh
east migrate
```
output
```sh
target migrations:
1_apples
2_bananas
migrate `1_apples`
migration done
migrate `2_bananas`
migration done
```
and roll them back
```sh
east rollback
```
output
```sh
target migrations:
2_bananas
1_apples
rollback `2_bananas`
migration successfully rolled back
rollback `1_apples`
migration successfully rolled back
```
you can specify one or several particular migrations for migrate/rollback e.g.
```sh
east migrate 1_apples
```
or
```sh
east migrate 1_apples 2_bananas
```
Run `east -h` to see all commands, `east -h` to see detail command help,
see also [east page](https://github.com/okv/east#usage) for command examples.
## Running test
run [east](https://github.com/okv/east#running-test) tests with this adapter