.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 .\" .\" Standard preamble: .\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp .ne 5 .PP \fB\\$1\fR .PP .. .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. | will give a .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' .\" expand to `' in nroff, nothing in troff, for use with C<>. .tr \(*W-|\(bv\*(Tr .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .\" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .hy 0 .if n .na .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "SQL::Translator::Producer::GraphViz 3" .TH SQL::Translator::Producer::GraphViz 3 "2008-01-01" "perl v5.8.8" "User Contributed Perl Documentation" .SH "NAME" SQL::Translator::Producer::GraphViz \- GraphViz producer for SQL::Translator .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use SQL::Translator; .Ve .PP .Vb 11 \& my $trans = new SQL::Translator( \& from => 'MySQL', # or your db of choice \& to => 'GraphViz', \& producer_args => { \& out_file => 'schema.png', \& add_color => 1, \& show_constraints => 1, \& show_datatypes => 1, \& show_col_sizes => 1 \& } \& ) or die SQL::Translator->error; .Ve .PP .Vb 1 \& $trans->translate or die $trans->error; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Creates a graph of a schema using the amazing graphviz (see http://www.graphviz.org/) application (via the GraphViz module). It's nifty\*(--you should try it! .SH "PRODUCER ARGS" .IX Header "PRODUCER ARGS" .IP "* out_file" 4 .IX Item "out_file" the name of the file where the graphviz graphic is to be written .IP "* layout (\s-1DEFAULT:\s0 'dot')" 4 .IX Item "layout (DEFAULT: 'dot')" determines which layout algorithm GraphViz will use; possible values are 'dot' (the default GraphViz layout for directed graph layouts), 'neato' (for undirected graph layouts \- spring model) or 'twopi' (for undirected graph layouts \- circular) .IP "* node_shape (\s-1DEFAULT:\s0 'record')" 4 .IX Item "node_shape (DEFAULT: 'record')" sets the node shape of each table in the graph; this can be one of 'record', 'plaintext', 'ellipse', 'circle', 'egg', \&'triangle', 'box', 'diamond', 'trapezium', 'parallelogram', \&'house', 'hexagon', or 'octagon' .IP "* output_type (\s-1DEFAULT:\s0 'png')" 4 .IX Item "output_type (DEFAULT: 'png')" sets the file type of the output graphic; possible values are \&'ps', 'hpgl', 'pcl', 'mif', 'pic', 'gd', 'gd2', 'gif', 'jpeg', \&'png', 'wbmp', 'cmap', 'ismap', 'imap', 'vrml', 'vtx', 'mp', \&'fig', 'svg', 'canon', 'plain' or 'text' (see GraphViz for details on each of these) .IP "* width (\s-1DEFAULT:\s0 8.5)" 4 .IX Item "width (DEFAULT: 8.5)" width (in inches) of the output graphic .IP "* height (\s-1DEFAULT:\s0 11)" 4 .IX Item "height (DEFAULT: 11)" height (in inches) of the output grahic .IP "* show_fields (\s-1DEFAULT:\s0 true)" 4 .IX Item "show_fields (DEFAULT: true)" if set to a true value, the names of the colums in a table will be displayed in each table's node .IP "* show_fk_only" 4 .IX Item "show_fk_only" if set to a true value, only columns which are foreign keys will be displayed in each table's node .IP "* show_datatypes" 4 .IX Item "show_datatypes" if set to a true value, the datatype of each column will be displayed next to each column's name; this option will have no effect if the value of show_fields is set to false .IP "* show_col_sizes" 4 .IX Item "show_col_sizes" if set to a true value, the size (in bytes) of each \s-1CHAR\s0 and \&\s-1VARCHAR\s0 column will be displayed in parentheses next to the column's name; this option will have no effect if the value of show_fields is set to false .IP "* show_constraints" 4 .IX Item "show_constraints" if set to a true value, a field's constraints (i.e., its primary\-key\-ness, its foreign-key-ness and/or its uniqueness) will appear as a comma-separated list in brackets next to the field's name; this option will have no effect if the value of show_fields is set to false .IP "* add_color" 4 .IX Item "add_color" if set to a true value, the graphic will have a background color of 'lightgoldenrodyellow'; otherwise the background color will be white .IP "* natural_join" 4 .IX Item "natural_join" if set to a true value, the make_natural_join method of SQL::Translator::Schema will be called before generating the graph; a true value for join_pk_only (see below) implies a true value for this option .IP "* join_pk_only" 4 .IX Item "join_pk_only" the value of this option will be passed as the value of the like-named argument in the make_natural_join method (see natural_join above) of SQL::Translator::Schema, if either the value of this option or the natural_join option is set to true .IP "* skip_fields" 4 .IX Item "skip_fields" the value of this option will be passed as the value of the like-named argument in the make_natural_join method (see natural_join above) of SQL::Translator::Schema, if either the natural_join or join_pk_only options has a true value .SH "AUTHOR" .IX Header "AUTHOR" Ken Y. Clark .SH "SEE ALSO" .IX Header "SEE ALSO" SQL::Translator, GraphViz