3 # -------------------------------------------------------------------
5 # -------------------------------------------------------------------
6 # Copyright (C) 2002-2009 SQLFairy Authors
8 # This program is free software; you can redistribute it and/or
9 # modify it under the terms of the GNU General Public License as
10 # published by the Free Software Foundation; version 2.
12 # This program is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 # General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program; if not, write to the Free Software
19 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
21 # -------------------------------------------------------------------
25 sqlt-diagram - Automatically create a diagram from a database schema
29 ./sqlt-diagram -d|-f|--from|--db=db_parser [options] schema.sql
33 -o|--output Output file name (default STDOUT)
34 -i|--image Output image type ("png" or "jpeg," default "png")
35 -t|--title Title to give schema
36 -c|--cols Number of columns
37 -n|--no-lines Don't draw lines
38 --font-size Font size ("small," "medium," "large," or "huge,"
40 --gutter Gutter size between tables
42 --show-fk-only Only show fields that act as primary
45 --natural-join Perform natural joins
46 --natural-join-pk Perform natural joins from primary keys only
47 -s|--skip Fields to skip in natural joins
48 --debug Print debugging information
52 This script will create a picture of your schema. Only the database
53 driver argument (for SQL::Translator) is required. If no output file
54 name is given, then image will be printed to STDOUT, so you should
55 redirect the output into a file.
57 The default action is to assume the presence of foreign key
58 relationships defined via "REFERENCES" or "FOREIGN KEY" constraints on
59 the tables. If you are parsing the schema of a file that does not
60 have these, you will find the natural join options helpful. With
61 natural joins, like-named fields will be considered foreign keys.
62 This can prove too permissive, however, as you probably don't want a
63 field called "name" to be considered a foreign key, so you could
64 include it in the "skip" option, and all fields called "name" will be
65 excluded from natural joins. A more efficient method, however, might
66 be to simply deduce the foriegn keys from primary keys to other fields
67 named the same in other tables. Use the "natural-join-pk" option
82 $out_file, $image_type, $db_driver, $title, $no_columns,
83 $no_lines, $font_size, $add_color, $debug, $show_fk_only,
84 $gutter, $natural_join, $join_pk_only, $skip_fields, $help
88 'd|db|f|from=s' => \$db_driver,
89 'o|output:s' => \$out_file,
90 'i|image:s' => \$image_type,
91 't|title:s' => \$title,
92 'c|columns:i' => \$no_columns,
93 'n|no-lines' => \$no_lines,
94 'font-size:s' => \$font_size,
95 'gutter:i' => \$gutter,
96 'color' => \$add_color,
97 'show-fk-only' => \$show_fk_only,
98 'natural-join' => \$natural_join,
99 'natural-join-pk' => \$join_pk_only,
100 's|skip:s' => \$skip_fields,
104 my @files = @ARGV; # the create script(s) for the original db
106 pod2usage(1) if $help;
107 pod2usage( -message => "No db driver specified" ) unless $db_driver;
108 pod2usage( -message => 'No input file' ) unless @files;
110 my $translator = SQL::Translator->new(
113 debug => $debug || 0,
115 out_file => $out_file,
116 image_type => $image_type,
117 gutter => $gutter || 0,
119 no_columns => $no_columns,
120 no_lines => $no_lines,
121 font_size => $font_size,
122 add_color => $add_color,
123 show_fk_only => $show_fk_only,
124 natural_join => $natural_join,
125 join_pk_only => $join_pk_only,
126 skip_fields => $skip_fields,
128 ) or die SQL::Translator->error;
130 for my $file (@files) {
131 my $output = $translator->translate( $file ) or die
132 "Error: " . $translator->error;
134 print "Image written to '$out_file'. Done.\n";
141 # -------------------------------------------------------------------
147 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.