bin/sqlt-graph

   1 #!/usr/bin/perl
   2
   3 # -------------------------------------------------------------------
   4 # $Id: sqlt-graph,v 1.6 2004-08-30 18:59:09 kycl4rk Exp $
   5 # -------------------------------------------------------------------
   6 # Copyright (C) 2002-4 SQLFairy Authors
   7 #
   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.
  11 #
  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.
  16 #
  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
  20 # 02111-1307  USA
  21 # -------------------------------------------------------------------
  22
  23 =head1 NAME
  24
  25 sqlt-graph - Automatically create a graph from a database schema
  26
  27 =head1 SYNOPSIS
  28
  29   ./sqlt-graph -d|--db|-f|--from=db_parser [options] schema.sql
  30
  31   Options:
  32
  33     -l|--layout        Layout schema for GraphViz
  34                        ("dot," "neato," "twopi"; default "dot")
  35     -n|--node-shape    Shape of the nodes ("record," "plaintext,"
  36                        "ellipse," "circle," "egg," "triangle," "box,"
  37                        "diamond," "trapezium," "parallelogram," "house,"
  38                        "hexagon," "octagon," default "record")
  39     -o|--output        Output file name (default STDOUT)
  40     -t|--output-type   Output file type ("canon", "text," "ps," "hpgl,"
  41                        "pcl," "mif," "pic," "gd," "gd2," "gif," "jpeg,"
  42                        "png," "wbmp," "cmap," "ismap," "imap," "vrml,"
  43                        "vtx," "mp," "fig," "svg," "plain," default "png")
  44     -c|--color         Add colors
  45     --no-fields        Don't show field names
  46     --height           Image height (in inches, default "11",
  47                        set to "0" to undefine)
  48     --width            Image width (in inches, default "8.5",
  49                        set to "0" to undefine)
  50     --natural-join     Perform natural joins
  51     --natural-join-pk  Perform natural joins from primary keys only
  52     --show-datatypes   Show datatype of each field
  53     --show-sizes       Show column sizes for VARCHAR and CHAR fields
  54     --show-constraints Show list of constraints for each field
  55     -s|--skip          Fields to skip in natural joins
  56     --debug            Print debugging information
  57
  58 =head1 DESCRIPTION
  59
  60 This script will create a graph of your schema.  Only the database
  61 driver argument (for SQL::Translator) is required.  If no output file
  62 name is given, then image will be printed to STDOUT, so you should
  63 redirect the output into a file.
  64
  65 The default action is to assume the presence of foreign key
  66 relationships defined via "REFERNCES" or "FOREIGN KEY" constraints on
  67 the tables.  If you are parsing the schema of a file that does not
  68 have these, you will find the natural join options helpful.  With
  69 natural joins, like-named fields will be considered foreign keys.
  70 This can prove too permissive, however, as you probably don't want a
  71 field called "name" to be considered a foreign key, so you could
  72 include it in the "skip" option, and all fields called "name" will be
  73 excluded from natural joins.  A more efficient method, however, might
  74 be to simply deduce the foriegn keys from primary keys to other fields
  75 named the same in other tables.  Use the "natural-join-pk" option
  76 to acheive this.
  77
  78 If the schema defines foreign keys, then the graph produced will be
  79 directed showing the direction of the relationship.  If the foreign
  80 keys are intuited via natural joins, the graph will be undirected.
  81
  82 =cut
  83
  84 # -------------------------------------------------------------------
  85
  86 use strict;
  87 use Data::Dumper;
  88 use Getopt::Long;
  89 use GraphViz;
  90 use Pod::Usage;
  91 use SQL::Translator;
  92
  93 use vars '$VERSION';
  94 $VERSION = sprintf "%d.%02d", q$Revision: 1.6 $ =~ /(\d+)\.(\d+)/;
  95
  96 #
  97 # Get arguments.
  98 #
  99 my (
 100     $layout, $node_shape, $out_file, $output_type, $db_driver, $add_color,
 101     $natural_join, $join_pk_only, $skip_fields, $show_datatypes,
 102     $show_sizes, $show_constraints, $debug, $help, $height, $width,
 103     $no_fields
 104 );
 105
 106 GetOptions(
 107     'd|db|f|from=s'    => \$db_driver,
 108     'o|output:s'       => \$out_file,
 109     'l|layout:s'       => \$layout,
 110     'n|node-shape:s'   => \$node_shape,
 111     't|output-type:s'  => \$output_type,
 112     'height:f'         => \$height,
 113     'width:f'          => \$width,
 114     'c|color'          => \$add_color,
 115     'no-fields'        => \$no_fields,
 116     'natural-join'     => \$natural_join,
 117     'natural-join-pk'  => \$join_pk_only,
 118     's|skip:s'         => \$skip_fields,
 119     'show-datatypes'   => $show_datatypes,
 120     'show-sizes'       => $show_sizes,
 121     'show-constraints' => $show_constraints,
 122     'debug'            => \$debug,
 123     'h|help'           => \$help,
 124 ) or die pod2usage;
 125 my @files = @ARGV; # the create script(s) for the original db
 126
 127 pod2usage(1) if $help;
 128 pod2usage( -message => "No db driver specified" ) unless $db_driver;
 129 pod2usage( -message => 'No input file'          ) unless @files;
 130
 131 my $translator           =  SQL::Translator->new(
 132     from                 => $db_driver,
 133     to                   => 'GraphViz',
 134     debug                => $debug || 0,
 135     producer_args        => {
 136         out_file         => $out_file,
 137         layout           => $layout,
 138         node_shape       => $node_shape,
 139         output_type      => $output_type,
 140         add_color        => $add_color,
 141         natural_join     => $natural_join,
 142         natural_join_pk  => $join_pk_only,
 143         skip_fields      => $skip_fields,
 144         show_datatypes   => $show_datatypes,
 145         show_sizes       => $show_sizes,
 146         show_constraints => $show_constraints,
 147         height           => $height || 0,
 148         width            => $width  || 0,
 149         show_fields      => $no_fields ? 0 : 1,
 150     },
 151 ) or die SQL::Translator->error;
 152
 153 for my $file (@files) {
 154     my $output = $translator->translate( $file ) or die
 155                  "Error: " . $translator->error;
 156     if ( $out_file ) {
 157         print "Image written to '$out_file'.  Done.\n";
 158     }
 159     else {
 160         print $output;
 161     }
 162 }
 163
 164 # -------------------------------------------------------------------
 165
 166 =pod
 167
 168 =head1 AUTHOR
 169
 170 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
 171
 172 =head1 SEE ALSO
 173
 174 perl, SQL::Translator.
 175
 176 =cut