sql::translator::producer::diagram(3pm) [debian man page]

SQL::Translator::Producer::Diagram(3pm) 		User Contributed Perl Documentation		   SQL::Translator::Producer::Diagram(3pm)

NAME

       SQL::Translator::Producer::Diagram - ER diagram producer for SQL::Translator

SYNOPSIS

       Use via SQL::Translator:

	 use SQL::Translator;

	 my $t = SQL::Translator->new(
	     from	   => 'MySQL',
	     to 	   => 'Diagram',
	     producer_args => {
		 # All args are optional
		 out_file	  => 'schema.png',# if not provided will return from translate()
		 output_type	  => 'png',	  # is default or 'jpeg'
		 title		  => 'My Schema', # default is filename
		 font_size	  => 'medium',	  # is default or 'small,' 'large'
		 imap_file	  => '',	  # filename to write image map coords
		 imap_url	  => '',	  # base URL for image map
		 gutter 	  => 30 	  # is default, px distance b/w cols
		 num_columns	  => 5, 	  # the number of columns
		 no_lines	  => 1, 	  # do not draw lines to show FKs
		 add_color	  => 1, 	  # give it some color
		 show_fk_only	  => 1, 	  # show only fields used in FKs
		 join_pk_only	  => 1, 	  # use only primary keys to figure PKs
		 natural_join	  => 1, 	  # intuit FKs if not defined
		 skip_fields	  => [...],	  # list* of field names to exclude
		 skip_tables	  => [...],	  # list* of table names to exclude
		 skip_tables_like => [...],	  # list* of regexen to exclude tables
	     }
	 ) or die SQL::Translator->error;
	 $t->translate;

       * "list" can be either an array-ref or a comma-separated string

AUTHOR

       Ken Youens-Clark <kclark@cpan.org>.

perl v5.14.2							    2012-01-18				   SQL::Translator::Producer::Diagram(3pm)