wukong-migrate 0.0.4 → 0.0.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    N2RlYzkzMTE2NDhhY2Q2MDdlMzNlNzMyMGZjYjAwNDVkOGQyMDJmYQ==
+    MTY1Mjk1ZTgyNjFiOWEyNDdmODZkMDRkYzI0YzdlYWEwYTRiZjY0Nw==
   data.tar.gz: !binary |-
-    YTczYjgyM2ExYzRhYmZkMmY0MTQ4YWVjMjQ4OTZlZjE2YWE4OGFhZQ==
+    NzM0YjYzZTI4N2Y3MzY1ODE5MGRiNGNjZTVkMWFkNjA1N2Q1NzEyYg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZDI3MjQ0MGQxYTJkMmViZjgyMDA1MDg5MTEwNjI5YTQyMWE0MTUwNmFiOWE0
-    ZGNlMDYyNmRmZDRkZDdlNjdhNjAzMDc5NDBhNmYxMzlkMTNlZWRmODQxMjhi
-    ZWNlN2YwOGIyYWJlM2MzODliMGJjYTY3OWM4YjU2OWI4ZDdmYTU=
+    ZTc2NzM2YTg1N2FlNWYxZGNmNDdlYjk4MWE2ZjgwZGU5MzZkYTE4YjY3OWY2
+    ODg3OTVmNmYzMjE5Y2YyZjI5ZmMwZjU1YjU5NWUxMmM0Yjg1ZmMwZmVjNDUy
+    ZDc5ZTUyYmIzYWNkOTgyNmRjODc3YzJmZjFmOTljMTk2ZWE2OTQ=
   data.tar.gz: !binary |-
-    YWM1MWMyOWI4YjQwOTU4OTgzOWY4ODQ3MGI2ZDA3MDUzMDIyZDljZTU1NGI1
-    Yjk0MGNjYmRiZDdlY2JjOTkzNjliNWY3YjIzZWY1NDcwMzY4MjRmZTIwOGVm
-    MWM5NWI5NTg1MTA2OTEzYzM1MDc5MTA3NWY0ZTg2MTBlMGVhNDA=
+    NTU1YjRlYjliZTBmZDZlNzY1NDE4OWU0ZmQwMmM2NzgxZGViMDg2YWQ0ODlk
+    ZjUwZjhmOGVjZjIxNjFhN2RkNzEyMTE2YTIxNjBiOTI4ZTU5M2I3NmExOTZh
+    OTgwYzYxM2NjZjFkMGY1NWNlNTliYjUzZThlM2QyODY0NWRiMWI=

data/README.md

@@ -0,0 +1,75 @@
+# Wukong Migrate
+
+A Wukong plugin that allows you to update database schema using predefined models from your deploy pack and a migration DSL.
+
+## Commands
+
+The following commands are available
+
+### Generate
+
+Creates a new migration file templated to match the chosen database. This command will create a new ruby file in `db/migrate` named after the argument supplied to `generate`. The only currently supported database is Elasticsearch, with future plans to support Hbase and others.
+
+```
+$ bundle exec wu-migrate generate change_schema --db=elasticsearch
+# INFO 2013-07-29 14:14:51 [MigrateRunner       ] -- Creating migration: db/migrate/change_schema.rb
+```
+
+### Perform 
+
+Performs the specified migration. This will talk to the database directly and apply the changes found in the migration. The tool will only perform migrations found in db/migrate, and specifying the `.rb` extension is not necessary. Currently, this is NOT an idempotent operation, and makes no guarantee of data safety on multiple invocations. Configuration is derived from command line parameters and through `Wukong::Deploy` settings.
+
+```
+$ bundle exec wu-migrate perform change_schema --db=elasticsearch
+# INFO 2013-07-29 14:18:20 [MigrateRunner       ] -- Creating index jedi
+# INFO 2013-07-29 14:18:21 [MigrateRunner       ] -- Operation complete
+# INFO 2013-07-29 14:18:21 [MigrateRunner       ] -- Add alias :light_side for index jedi
+# INFO 2013-07-29 14:18:21 [MigrateRunner       ] -- Operation complete
+```
+
+### All
+
+Performs all available migrations in `db/migrate`. This is useful when setting up mirrored or development databases from existing migrations.
+
+## Syntax
+
+The following syntax is used to define migrations.
+
+### Elasticsearch
+
+All definitions take place inside of a `.define` block.
+
+```ruby
+EsMigration.define 'name_of_migration' do
+...
+end
+```
+Top-level methods are `create_index`, `update_index`, and `delete_index`. They can be used with or without block syntax.
+
+```ruby
+EsMigration.define 'name_of_migration' do
+  create_index(:index_name) do
+  ...
+  end
+  delete_index(:old_index)		   
+end
+```
+
+Inside of an index block, you have access to mappings, aliases and index-level settings. Aliases are created/deleted one at a time and optionally accept filters. Mapping methods accept blocks for object-level settings.
+
+```ruby
+EsMigration.define 'name_of_migration' do
+  create_index(:index_name) do
+    number_of_replicas 4
+    ...
+    alias_to           :other_name, filter: { range: { date: { gt: '2013-05-05' } } }
+    remove_alias       :prior_name
+    create_mapping(:obj_type) do
+      dynamic true
+      source  false
+      ...
+    end			      
+  end
+  delete_index(:old_index)		   
+end
+```

data/lib/wukong-migrate/migrate_runner.rb

@@ -6,7 +6,17 @@ module Wukong
       
       description <<-DESC.gsub(/^ {8}/, '').strip
         Use this tool to create and perform database migrations using models
-        defined in app/models.
+        defined in app/models. Options may be passed in as params on the commandline,
+        else are discovered using Wukong::Deploy.settings
+
+        $ wu-migrate generate schema_change --db=elasticsearch
+        # Creates a template Elasticsearch migration file in db/migrate/schema_change.rb
+ 
+        $ wu-migrate perform schema_change --db=elasticsearch
+        # Interprets and runs the migration db/migrate/schema_change.rb
+
+        $ wu-migrate all
+        # Runs all migrations found in db/migrate
 
         Commands:
 

data/lib/wukong-migrate/version.rb

@@ -1,5 +1,5 @@
 module Wukong
   module Migrate
-    VERSION = '0.0.4'
+    VERSION = '0.0.5'
   end
 end

data/wukong-migrate.gemspec

@@ -11,7 +11,11 @@ Gem::Specification.new do |gem|
 
   gem.summary     = 'Wukong utility to push database schema changes based upon your defined models'
   gem.description = <<-DESC.gsub(/^ {4}/, '')
-    wukong-migrate, inspired by rails, all up in yer deploy pack, pushing yer schema changes
+    Wukong-migrate, inspired by rails, makes updating database schemas and settings painless and straightforward.
+
+    Utilizing your app's models and the settings discovered by Wukong-deploy, only a simple migrate script is required
+    to be able to make changes to databases. Keep your databases in sync with your app code more cleanly and with less
+    effort.
   DESC
 
   gem.files         = `git ls-files`.split("\n")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wukong-migrate
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Travis Dempsey
@@ -66,8 +66,17 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.8.7
-description: ! 'wukong-migrate, inspired by rails, all up in yer deploy pack, pushing
-  yer schema changes
+description: ! 'Wukong-migrate, inspired by rails, makes updating database schemas
+  and settings painless and straightforward.
+
+
+  Utilizing your app''s models and the settings discovered by Wukong-deploy, only
+  a simple migrate script is required
+
+  to be able to make changes to databases. Keep your databases in sync with your app
+  code more cleanly and with less
+
+  effort.
 
 '
 email: coders@infochimps.com
@@ -78,6 +87,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- README.md
 - Rakefile
 - bin/wu-migrate
 - lib/gorillib/model/elasticsearch_ext.rb