https://github.com/joker1007/redshift_simple_migrator

super simple migrator for AWS Redshift (and PostgreSQL)
https://github.com/joker1007/redshift_simple_migrator

Last synced: 2 days ago
JSON representation

super simple migrator for AWS Redshift (and PostgreSQL)

• Host: GitHub
• URL: https://github.com/joker1007/redshift_simple_migrator
• Owner: joker1007
• Created: 2015-06-15T10:40:51.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2019-07-01T20:25:04.000Z (over 5 years ago)
• Last Synced: 2024-10-01T11:19:39.915Z (about 1 month ago)
• Language: Ruby
• Homepage:
• Size: 18.6 KB
• Stars: 3
• Watchers: 3
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# RedshiftSimpleMigrator

[![Build Status](https://travis-ci.org/joker1007/redshift_simple_migrator.svg?branch=master)](https://travis-ci.org/joker1007/redshift_simple_migrator)

this gem is super simple migrator for AWS Redshift (and PostgreSQL).

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'redshift_simple_migrator'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install redshift_simple_migrator

## Usage

### Define migration

Migration definition is like ActiveRecord::Migration,

but this gem supports only `execute` method.

It has no other migration dsl.

#### Migration File

```ruby

class CreateKpiMiddleTable < RedshiftSimpleMigrator::Migration

  def up

    execute <<-SQL

      CREATE TABLE company_users DISTKEY (id) AS

      SELECT

        a.id,

        a.company_id

      FROM

        users a

          INNER JOIN companies b ON a.company_id = b.id;

    SQL

  end

  def down

    execute <<-SQL

      DROP TABLE company_users;

    SQL

  end

end

```

#### File name convention

File name convention is same with ActiveRecord::Migration.

```

% ls redshift/migrate/

001_create_kpi_middle_table.rb

```

### Command

```sh

# Show current migration version

$ redshift_simple_migrator version -c 

# List execute migrations

$ redshift_simple_migrator list  -c  -p 

# Execute migration

$ redshift_simple_migrator migrate  -c  -p 

```

If you use with rails, config is autoloaded from `config/redshift_simple_migrator.yml`, and define Rake tasks.

### Rake tasks

```

rake redshift:migrate                   # Migrate the AWS Redshift (options: VERSION=x)

rake redshift:migrate:status            # Display status of AWS Redshift migration (options: VERSION=x)

```

### config.yml example

```yml

default: &default

  host: hogehoge.redshift.amazonaws.com

  port: 5439

  dbname: sample

  user: admin

  password: password

  connect_timeout: 30000

  schema_migrations_table_name: redshift_schema_migrations

development:

  <<: *default

```

If `schema_migrations_table_name` table doesn't exist, this gem creates the table automatically.

`schema_migrations` table schema is following.

```sql

CREATE TABLE  (version text NOT NULL)

```

## TODO

- Refine `migrations_path` config.

- Write test codes.

If you want to change target environment, set `REDSHIFT_ENV` environment variable.

For example, `REDSHIFT_ENV=prouduction redshift_simple_migrator migrate -c config.yml -p db/migrate`

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec redshift_simple_migrator` to use the gem in this directory, ignoring other installed copies of this gem.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/joker1007/redshift_simple_migrator.