convergence 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fcf2eb1b4a4cc1cc52648e454b2ad4087dea84e
-  data.tar.gz: f82751ac5a1a4749bbe7546905e1f2a2a6f4963a
+  metadata.gz: 206de6bb62a2051e7d5f97ffe26e85f7f1809e6e
+  data.tar.gz: e31e17a94d6a522eb3c4682bd23776ec55df3caf
 SHA512:
-  metadata.gz: f3a8d474d2869584658a1b20d6408b349711477a43561e31cf11778490a33b730bbae3aead1131b2a5dd1ad188021ea7ded8e4c15adcd2fa238b1c11032c1720
-  data.tar.gz: 5a1e4a4f8476e51e903c28ad22cbbd1f8b868b9be9ee51a80bd4308f758a8f26522c97b970fc966656dd4f2da225d25990ae32a63fd66a58ea9951eb3d11609f
+  metadata.gz: 2a50c6601f503efafbd4a3b5bd64029f05bb1d8f95802a42a10a4a9fda709ccbd791131ad426f96c21ea139cba8fc6acf4f66d90b4b9dd6f1838ebd4a6dee837
+  data.tar.gz: 8e575d10f0e2402b86b15b4685e48ad71c69bc181f1417fc2f676527aa4aec843579b1b844aa3c47140f2c5bb02d9a385d9ec2e86c356d2ff722cfe5aea481d9

data/.gitignore

@@ -1,3 +1,4 @@
 tmp/
 tags
 database.yml
+pkg/

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    convergence (0.0.1)
+    convergence (0.0.2)
       diff-lcs
       diffy
       mysql2

data/README.md

@@ -3,6 +3,10 @@
 Convergence is a Database Schema management tools.
 Currently, This tools is support only MySQL.
 
+It defines DB Schema using Convergence DSL(like Rails DSL).
+For more information about Convergence DSL, See below 'Detail About Convergence DSL'.
+
+
 [![Build Status](https://travis-ci.org/nishio-dens/convergence.svg?branch=master)](https://travis-ci.org/nishio-dens/convergence)
 
 ## Installation
@@ -25,6 +29,101 @@ Or install it yourself as:
 gem install convergence
 ```
 
+## What's this?
+
+```
+$ mysql -u root -e 'create database example_database;'
+$ cat database.yml
+
+adapter: mysql
+database: example_database
+host: 127.0.0.1
+username: root
+password:
+
+$ cat example.schema
+
+create_table 'test_tables' do |t|
+  t.int :id, primary_key: true, extra: 'auto_increment'
+  t.varchar :name, limit: 100, null: true
+  t.datetime :created_at
+  t.datetime :updated_at
+
+  t.index :name
+end
+
+$ convergence -c database.yml -i example.schema --dryrun
+
+#
+#
+# CREATE TABLE `test_tables` (
+#   `id` int(11) NOT NULL AUTO_INCREMENT,
+#   `name` varchar(100) CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT NULL,
+#   `created_at` datetime NOT NULL,
+#   `updated_at` datetime NOT NULL,
+#   PRIMARY KEY (`id`),
+#   KEY `index_test_tables_on_name` (`name`)
+# ) ENGINE=InnoDB ROW_FORMAT=Compact DEFAULT CHARACTER SET=utf8 COLLATE=utf8_general_ci;
+
+$ convergence -c database.yml -i example.schema --apply
+
+SET FOREIGN_KEY_CHECKS=0;
+  --> 0.000794s
+CREATE TABLE `test_tables` (
+  `id` int(11) NOT NULL AUTO_INCREMENT,
+  `name` varchar(100) CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT NULL,
+  `created_at` datetime NOT NULL,
+  `updated_at` datetime NOT NULL,
+  PRIMARY KEY (`id`),
+  KEY `index_test_tables_on_name` (`name`)
+) ENGINE=InnoDB ROW_FORMAT=Compact DEFAULT CHARACTER SET=utf8 COLLATE=utf8_general_ci;
+  --> 0.01485s
+SET FOREIGN_KEY_CHECKS=1;
+  --> 0.000115s
+
+$ cat changed_example.schema
+
+create_table 'test_tables', comment: 'Table Comment Test', engine: 'MyISAM' do |t|
+  t.int :id, primary_key: true, extra: 'auto_increment'
+  t.varchar :name, limit: 100, null: true
+  t.datetime :created_at
+  t.datetime :posted_at
+end
+
+$ convergence -c database.yml -i changed_example.schema  --dryrun
+
+# ALTER TABLE `test_tables` DROP COLUMN `updated_at`;
+# ALTER TABLE `test_tables` ADD COLUMN `posted_at` datetime NOT NULL AFTER `created_at`;
+# DROP INDEX `index_test_tables_on_name` ON `test_tables`;
+# ALTER TABLE `test_tables` ENGINE=MyISAM COMMENT='Table Comment Test';
+
+$ convergence -c database.yml -i changed_example.schema  --apply
+SET FOREIGN_KEY_CHECKS=0;
+  --> 0.000847s
+ALTER TABLE `test_tables` DROP COLUMN `updated_at`;
+  --> 0.034026s
+ALTER TABLE `test_tables` ADD COLUMN `posted_at` datetime NOT NULL AFTER `created_at`;
+  --> 0.025328s
+DROP INDEX `index_test_tables_on_name` ON `test_tables`;
+  --> 0.011465s
+ALTER TABLE `test_tables` ENGINE=MyISAM COMMENT='Table Comment Test';
+  --> 0.01115s
+SET FOREIGN_KEY_CHECKS=1;
+  --> 0.000147s
+
+$ mysql -u root example_database -e 'show create table test_tables\G'
+
+*************************** 1. row ***************************
+       Table: test_tables
+Create Table: CREATE TABLE `test_tables` (
+  `id` int(11) NOT NULL AUTO_INCREMENT,
+  `name` varchar(100) DEFAULT NULL,
+  `created_at` datetime NOT NULL,
+  `posted_at` datetime NOT NULL,
+  PRIMARY KEY (`id`)
+) ENGINE=MyISAM DEFAULT CHARSET=utf8 ROW_FORMAT=COMPACT COMMENT='Table Comment Test'
+```
+
 ## Usage
 
 ```
@@ -38,3 +137,165 @@ Usage: convergence [options]
         --apply        execute sql to your database
     -h, --help         Display this help message.
 ```
+
+### DB Config
+
+You need to make database.yml to access your database.
+
+```
+$ cat database.yml
+dapter: mysql
+database: convergence_test
+host: 127.0.0.1
+username: root
+password:
+```
+
+### Export Your DB Schema
+
+First, you need to create database.yml.
+And then, execute command like below.
+
+```
+$ convergence -c database.yml --export > example.schema
+```
+
+Export DSL like this.
+
+```
+create_table "authors", collate: "utf8_general_ci" do |t|
+  t.int "id", primary_key: true, extra: "auto_increment"
+  t.varchar "name", limit: 110
+  t.datetime "created_at", null: true
+  t.datetime "updated_at", null: true
+
+  t.index "created_at", name: "index_authors_on_created_at"
+end
+
+create_table "papers", collate: "utf8_general_ci", comment: "Paper" do |t|
+  t.int "id", primary_key: true, extra: "auto_increment"
+  t.varchar "title1", limit: 300, comment: "Title 1"
+  t.varchar "title2", limit: 300, comment: "Title 2"
+  t.text "description", null: true, comment: "Description"
+end
+
+create_table "paper_authors", collate: "utf8_general_ci", comment: "Paper Author Relation" do |t|
+  t.int "id", primary_key: true, extra: "auto_increment"
+  t.int "paper_id", comment: "Paper id"
+  t.int "author_id", comment: "Paper author id"
+
+  t.foreign_key "author_id", reference: "authors", reference_column: "id", name: "paper_authors_author_id_fk"
+  t.foreign_key "paper_id", reference: "papers", reference_column: "id", name: "paper_authors_paper_id_fk"
+end
+```
+
+### Dryrun
+
+```
+$ convergence -c database.yml -i example.schema --dryrun
+```
+
+### Apply
+
+```
+$ convergence -c database.yml -i example.schema --apply
+```
+
+## Detail About Convergence DSL
+
+### support column types
+
+Convergence is currently support column types below.
+
+- tinyint
+- smallint
+- mediumint
+- int
+- bigint
+- float
+- double
+- decimal
+- char
+- varchar
+- tinyblob
+- blob
+- mediumblob
+- tinytext
+- text
+- mediumtext
+- longtext
+- date
+- time
+- datetime
+- timestamp
+- year
+
+```
+create_table "tests", comment: 'Column type example' do |t|
+  t.int 'id', primary_key: true, extra: 'auto_increment'
+  t.float 'float_col', comment: 'Float column'
+  t.decimal 'decimal_col', default: "0.000", precision: 12, scale: 3
+  t.varchar 'test_string', null: true, default: 'hello', limit: 300
+  t.text 'text_col'
+  t.datetime 'created_at'
+end
+```
+
+### index
+
+```
+create_table "tests", comment: 'Index example' do |t|
+  t.int 'id', primary_key: true, extra: 'auto_increment'
+  t.varchar 'column1'
+  t.varchar 'column2'
+
+  t.index 'column1'
+  t.index ['column2', 'column1']
+  t.index 'column2', name: 'column2_idx'
+end
+```
+
+### foreign key
+
+```
+create_table "authors" do |t|
+  t.int "id", primary_key: true, extra: "auto_increment"
+  t.varchar "name", limit: 110
+end
+
+create_table "papers", collate: "utf8_general_ci", comment: "Paper" do |t|
+  t.int "id", primary_key: true, extra: "auto_increment"
+  t.varchar "title1"
+end
+
+create_table "paper_authors", collate: "utf8_general_ci", comment: "Paper Author Relation" do |t|
+  t.int "id", primary_key: true, extra: "auto_increment"
+  t.int "paper_id", comment: "Paper id"
+  t.int "author_id", comment: "Paper author id"
+
+  t.foreign_key "author_id", reference: "authors", reference_column: "id"
+  t.foreign_key "paper_id", reference: "papers", reference_column: "id", name: "paper_authors_paper_id_fk"
+end
+
+```
+
+### table options
+
+```
+create_table "authors", comment: 'Author', engine: 'MyISAM', collate: "utf8_general_ci", default_charset: 'utf8' do |t|
+  t.int "id", primary_key: true, extra: "auto_increment"
+  t.varchar "name", limit: 110
+end
+```
+
+
+## Test
+
+```
+$ bundle exec rake db:convergence:prepare
+$ bundle exec rspec
+```
+
+## Copyright
+
+Copyright © 2014 S.nishio. See LICENSE.txt for further details.

data/lib/convergence/version.rb

@@ -1,3 +1,3 @@
 module Convergence
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: convergence
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Shinsuke Nishio
@@ -183,7 +183,6 @@ files:
 - README.md
 - Rakefile
 - bin/convergence
-- convergence-0.0.1.gem
 - convergence.gemspec
 - database.yml.example
 - lib/convergence.rb