h1. sqld4r

h1. → 'sqld4r'


h2. What is this?

The sqld4r is model generator for SQLDesigner(http://ondras.zarovi.cz/sql/demo/).<br />
If you have a xml file of the SQLDesigner, you will be able to generate migration files and model files on a minute.<br />
I recommend that you use it with a rocketstarter gem.<br />

h2. Features

* generate migration files and model files from SQLDesigner xml file.<br />
* generate migration file for your model's PKs and FKs.<br />
* execute command list before finish.<br />
(exp., execute 'rake db:create:all' for migrate to your database).<br />
* save the DBDesigner xml file.<br />

h2. Installing

<pre syntax="ruby">gem install sqld4r</pre>

h2. The basics

This gem needs activesupport ver 2.1.0 or higher.
(because I checked this version only. I don't know about another version.)

h2. Demonstration of usage

<pre syntax="ruby">
Usage: sqld4r SQLDesigner_xml_path [options]
Usage: sqld4r --init [options]
Usage: sqld4r --check [options]
and more...
Usage: sqld4r --help
</pre>

h2. How to use

1. Set environment valiable if you want to change a config file path.

<pre syntax="ruby">
$ export SQLD4R_CONF=~/.sqld4r
</pre>

- Default is $HOME/.sqld4r

2. Create config file.

<pre syntax="ruby">
$ sqld4r --init
</pre>

3. Modify default values and command list.

<pre syntax="ruby">
$ vi ~/.sqld4r
$ vi ~/sqld4r_execute_commands
</pre>

4. Test for setting

<pre syntax="ruby">
$ sqld4r --check
</pre>

5. Generate migration files and model files from SQLDesigner xml file.

<pre syntax="ruby">
$ cd your-rails-root
$ sqld4r /path/to/SQLDesigner.xml
</pre>

h2. Forum

"http://groups.google.com/group/sqld4r (English)":http://groups.google.com/group/sqld4r
"http://groups.google.co.jp/group/sqld4r (Japanese)":http://groups.google.co.jp/group/sqld4r

h2. How to submit patches

Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/ and for section "8b: Submit patch to Google Groups":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups, use the Google Group above.

You can fetch the source from either:

<% if rubyforge_project_id %>

* rubyforge: "http://rubyforge.org/scm/?group_id=<%= rubyforge_project_id %>":http://rubyforge.org/scm/?group_id=<%= rubyforge_project_id %>

<pre>git clone git://rubyforge.org/sqld4r.git</pre>

<% else %>

* rubyforge: MISSING IN ACTION

TODO - You can not created a RubyForge project, OR have not run <code>rubyforge config</code>
yet to refresh your local rubyforge data with this projects' id information.

When you do this, this message will magically disappear!

Or you can hack website/index.txt and make it all go away!!

<% end %>

h3. Build and test instructions

<pre>cd sqld4r
rake test
rake install_gem</pre>


h2. License

This code is free to use under the terms of the MIT license. 

h2. Contact

Comments are welcome. Send an email to "Yusuke Ohmichi(maimuzo)":mailto:maimuzo@gmail.com via the "forum":http://groups.google.com/group/sqld4r