forked from dbsrgits/sql-translator
-
Notifications
You must be signed in to change notification settings - Fork 0
/
sqlt-graph
executable file
·217 lines (187 loc) · 8.05 KB
/
sqlt-graph
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
#!/usr/bin/env perl
# -------------------------------------------------------------------
# Copyright (C) 2002-2009 SQLFairy Authors
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation; version 2.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
# 02111-1307 USA
# -------------------------------------------------------------------
=head1 NAME
sqlt-graph - Automatically create a graph from a database schema
=head1 SYNOPSIS
./sqlt-graph -d|--db|-f|--from=db_parser [options] schema.sql
Options:
-l|--layout Layout schema for GraphViz
("dot," "neato," "twopi"; default "dot")
-n|--node-shape Shape of the nodes ("record," "plaintext,"
"ellipse," "circle," "egg," "triangle," "box,"
"diamond," "trapezium," "parallelogram," "house,"
"hexagon," "octagon," default "record")
-o|--output Output file name (default STDOUT)
-t|--output-type Output file type ("canon", "text," "ps," "hpgl,"
"pcl," "mif," "pic," "gd," "gd2," "gif," "jpeg,"
"png," "wbmp," "cmap," "ismap," "imap," "vrml,"
"vtx," "mp," "fig," "svg," "plain," default "png")
-c|--color Add colors
--cluster Cluster tables
--no-fields Don't show field names
--height Image height (in inches, default "11",
set to "0" to undefine)
--width Image width (in inches, default "8.5",
set to "0" to undefine)
--fontsize custom font size for node and edge labels
--fontname name of custom font (or full path to font file) for
node, edge, and graph labels
--nodeattr attribute name and value (in key=val syntax) for
nodes; this option may be repeated to specify
multiple node attributes
--edgeattr same as --nodeattr, but for edge attributes
--graphattr same as --nodeattr, but for graph attributes
--natural-join Perform natural joins
--natural-join-pk Perform natural joins from primary keys only
--show-datatypes Show datatype of each field
--show-sizes Show column sizes for VARCHAR and CHAR fields
--show-constraints Show list of constraints for each field
-s|--skip Fields to skip in natural joins
--skip-tables Comma-separated list of table names to exclude
--skip-tables-like Comma-separated list of regexen to exclude tables
--debug Print debugging information
--trace Print parser trace info
=head1 DESCRIPTION
This script will create a graph of your schema. Only the database
driver argument (for SQL::Translator) is required. If no output file
name is given, then image will be printed to STDOUT, so you should
redirect the output into a file.
The default action is to assume the presence of foreign key
relationships defined via "REFERNCES" or "FOREIGN KEY" constraints on
the tables. If you are parsing the schema of a file that does not
have these, you will find the natural join options helpful. With
natural joins, like-named fields will be considered foreign keys.
This can prove too permissive, however, as you probably don't want a
field called "name" to be considered a foreign key, so you could
include it in the "skip" option, and all fields called "name" will be
excluded from natural joins. A more efficient method, however, might
be to simply deduce the foreign keys from primary keys to other fields
named the same in other tables. Use the "natural-join-pk" option
to achieve this.
If the schema defines foreign keys, then the graph produced will be
directed showing the direction of the relationship. If the foreign
keys are intuited via natural joins, the graph will be undirected.
Clustering of tables allows you to group and box tables according to
function or domain or whatever criteria you choose. The syntax for
clustering tables is:
cluster1=table1,table2;cluster2=table3,table4
=cut
# -------------------------------------------------------------------
use strict;
use warnings;
use Data::Dumper;
use Getopt::Long;
use GraphViz;
use Pod::Usage;
use SQL::Translator;
use vars '$VERSION';
$VERSION = '1.59';
#
# Get arguments.
#
my (
$layout, $node_shape, $out_file, $output_type, $db_driver, $add_color,
$natural_join, $join_pk_only, $skip_fields, $show_datatypes,
$show_sizes, $show_constraints, $debug, $help, $height, $width,
$no_fields, $fontsize, $fontname, $skip_tables, $skip_tables_like,
$cluster, $trace
);
# multi-valued options:
my %edgeattrs = ();
my %nodeattrs = ();
my %graphattrs = ();
GetOptions(
'd|db|f|from=s' => \$db_driver,
'o|output:s' => \$out_file,
'l|layout:s' => \$layout,
'n|node-shape:s' => \$node_shape,
't|output-type:s' => \$output_type,
'height:f' => \$height,
'width:f' => \$width,
'fontsize=i' => \$fontsize,
'fontname=s' => \$fontname,
'nodeattr=s' => \%nodeattrs,
'edgeattr=s' => \%edgeattrs,
'graphattr=s' => \%graphattrs,
'c|color' => \$add_color,
'cluster:s' => \$cluster,
'no-fields' => \$no_fields,
'natural-join' => \$natural_join,
'natural-join-pk' => \$join_pk_only,
's|skip:s' => \$skip_fields,
'skip-tables:s' => \$skip_tables,
'skip-tables-like:s' => \$skip_tables_like,
'show-datatypes' => \$show_datatypes,
'show-sizes' => \$show_sizes,
'show-constraints' => \$show_constraints,
'debug' => \$debug,
'trace' => \$trace,
'h|help' => \$help,
) or die pod2usage;
my @files = @ARGV; # the create script(s) for the original db
pod2usage(1) if $help;
pod2usage( -message => "No db driver specified" ) unless $db_driver;
pod2usage( -message => 'No input file' ) unless @files;
my $translator = SQL::Translator->new(
from => $db_driver,
to => 'GraphViz',
debug => $debug || 0,
trace => $trace || 0,
producer_args => {
out_file => $out_file,
layout => $layout,
node_shape => $node_shape,
output_type => $output_type,
add_color => $add_color,
natural_join => $natural_join,
natural_join_pk => $join_pk_only,
skip_fields => $skip_fields,
skip_tables => $skip_tables,
skip_tables_like => $skip_tables_like,
show_datatypes => $show_datatypes,
show_sizes => $show_sizes,
show_constraints => $show_constraints,
cluster => $cluster,
height => $height || 0,
width => $width || 0,
fontsize => $fontsize,
fontname => $fontname,
nodeattrs => \%nodeattrs,
edgeattrs => \%edgeattrs,
graphattrs => \%graphattrs,
show_fields => $no_fields ? 0 : 1,
},
) or die SQL::Translator->error;
for my $file (@files) {
my $output = $translator->translate( $file ) or die
"Error: " . $translator->error;
if ( $out_file ) {
print "Image written to '$out_file'. Done.\n";
}
else {
print $output;
}
}
# -------------------------------------------------------------------
=pod
=head1 AUTHOR
Ken Youens-Clark E<lt>[email protected]<gt>.
=head1 SEE ALSO
perl, SQL::Translator.
=cut