README.md in databasion-0.0.1 vs README.md in databasion-0.0.2
- old
+ new
@@ -2,12 +2,14 @@
## Google Spreadsheet/Excel -> YAML -> Ruby Migration -> Database Management Tool
If we were all part of a hive mind, we wouldn't need management anything. Databases would get built, the correct columns would get used, programmers would align their ORMs, and keeping it all together wouldn't be some kind of management nightmare.
-Fortunately we aren't a hive mind (and if we were I would be just as confused as I am any other day, our office's main language is Japanese). Still, even though my coworkers can't read my mind, we've come up with a tool that allows top end planners to describe system data in a spreadsheet, programmers to fudge in the column types, sizes, and database relationships, and everyone to export it out into YAML and Ruby migration scripts which update your infrastructure. Ideally the fully automated suite is used in your test environment so your planner can quickly test changes, and a step by step process used if you are updating production machines.
+Fortunately we aren't a hive mind*. Still, even though my coworkers can't read my mind, we've come up with a tool that allows top end planners to describe system data in a spreadsheet, programmers to fudge in the column types, sizes, and database relationships, and everyone to export it out into YAML and Ruby migration scripts which update your infrastructure. Ideally the fully automated suite is used in your test environment so your planner can quickly test changes, and a step by step process used if you are updating production machines.
+* If we were I would be just as confused as I am any other day, our office's main language is Japanese. Although I've been studying it for 9 years...
+
## Requirements
### Ruby
* Ruby >= 1.8.7
@@ -94,33 +96,46 @@
databasion --create project
cd project
Edit _config/google.yml_. Then run the scripts.
- databasion --system google
+ databasion --google
databasion --migrate
+ databasion --update
+ databasion --svn
-Or run them both in order.
+Or run them all in order.
- databasion --system google --migrate
+ databasion --google --migrate --update --svn
You can supply a different config path as well.
- databasion -s google -m --config config/my.other.config.yml
+ databasion -g -m -u -s --config config/my.other.config.yml
+Someone administrating a production database with this tool would definitely want to run each script sequentially by hand.
+
### YAML Configuration
#### Google
* _login_: A valid Google username and password.
* _sheets_: A list of the keys gleaned from the Google Docs URL, and a human readable name.
* _output_: Where to output the relevant data.
+* _svn_: SVN configuration data.
+## SVN
+
+If the currently created databasion project is committed to SVN, running the _--svn_ switch will auto-add and commit all the project files. This is useful for maintaining version control of the system, especially if something goes wrong and you need to do a rollback.
+
## Roadmap
-__0.0.2__
+__0.0.3__
* Add ability to read existing tables, and make relative alter table migration scripts.
+
+__0.0.2__
+
+* <del>Add SVN hooks.</del>
__0.0.1__
* <del>Write this documentation.</del>
* <del>Add table name specification.</del>