SQL::T...raphViz(3pm)

✨ NAME ✨

okay so bestie, this is the manual page for SQL::Translator::Producer::GraphViz — it's the GraphViz producer for SQL::Translator, and it's literally the plug that turns your database schema into an actual picture 🎀

---

🌸 SYNOPSIS 🌸

use SQL::Translator;

my $trans = SQL::Translator->new(
    from => 'MySQL',            # or your db of choice
    to   => 'GraphViz',
    producer_args => {
        out_file         => 'schema.png',
        bgcolor          => 'lightgoldenrodyellow',
        show_constraints => 1,
        show_datatypes   => 1,
        show_sizes       => 1
    }
) or die SQL::Translator->error;

$trans->translate or die $trans->error;

---

💅 DESCRIPTION 💅

It creates a graph of a schema using the amazing graphviz application (peep it at http://www.graphviz.org/), and it does it via the GraphViz module 🦋

It's nifty — you should try it! fr fr ✨

---

👑 PRODUCER ARGS 👑

Every single GraphViz constructor attribute is accepted and passed straight through to "new" in GraphViz. And for a few of those attributes, these defaults are just assumed:

layout => 'dot',
overlap => 'false',

node => {
  shape => 'record',
  style => 'filled',
  fillcolor => 'white',
},

# in inches
width => 8.5,
height => 11,

Wanna know more about these and other attributes? Go read the docs for "new" in GraphViz 💜

And in addition, this producer also accepts the following arguments:

• skip_tables — an arrayref or a comma-separated list of table names that should be skipped. ⚠️ heads up though: a skipped table node may still show up if another table has foreign key constraints pointing at the skipped table. And if that happens, no table field/index information will be included. so like. keep that in mind bestie 😭
• skip_tables_like — an arrayref or a comma-separated list of regular expressions matching table names that should be skipped 🧚
• cluster — clustering of tables lets you group and box tables according to function or domain or whatever criteria you choose 💖 The syntax for clustering tables is:

cluster => 'cluster1=table1,table2;cluster2=table3,table4'

Or pass it as an arrayref like so:

cluster => [ 'cluster1=table1,table2', 'cluster2=table3,table4' ]

Or like so:

cluster => [
  { name => 'cluster1', tables => [ 'table1', 'table2' ] },
  { name => 'cluster2', tables => [ 'table3', 'table4' ] },
]

• out_file — the name of the file where the resulting GraphViz output will be written ✍️ Alternatively an open filehandle can be supplied. If it's undefined (which is the default) — the result is returned as a string 🎀
• output_type (DEFAULT: 'png') — this decides which output method gets invoked to generate the graph: "png" translates to "as_png", "ps" to "as_ps" and so on 🌈
• fontname — sets the global font name (or the full path to a font file) for node, edge, and graph labels 🔤
• fontsize — sets the global font size for node and edge labels (note that arbitrarily large sizes may be ignored due to page size or graph size constraints 👀)
• show_fields (DEFAULT: true) — if set to a true value, the names of the columns in a table will be displayed in each table's node 💫
• show_fk_only — if set to a true value, only columns which are foreign keys will be displayed in each table's node 🔑
• 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 🚫
• friendly_ints — if set to a true value, each integer type field will be displayed as a tinyint, smallint, integer or bigint depending on the field's associated size parameter. This only applies for the "integer" type (and not the "int" type, which is always assumed to be a 32-bit integer); this option will have no effect if the value of "show_fields" is set to false 🍓
• friendly_ints_extended — if set to a true value, the friendly ints displayed will take into account the non-standard types, 'tinyint' and 'mediumint' (which, as far as I am aware, is only implemented in MySQL) 🙈
• show_sizes — if set to a true value, the size (in bytes) of each CHAR and VARCHAR 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 📏
• 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 🧷
• show_indexes — if set to a true value, each record will also show the indexes set on each table. It describes the index types along with which columns are included in the index 📇
• show_index_names (DEFAULT: true) — if "show_indexes" is set to a true value, then the value of this parameter determines whether or not to print names of indexes. if "show_index_names" is false, then a list of indexed columns will appear below the field list. Otherwise, it will be a list prefixed with the name of each index 🏷️
• natural_join — if set to a true value, "make_natural_joins" in SQL::Translator::Schema will be called before generating the graph 💞
• join_pk_only — the value of this option will be passed as the value of the like-named argument to "make_natural_joins" in SQL::Translator::Schema; implies "natural_join => 1" 🔗
• skip_fields — the value of this option will be passed as the value of the like-named argument to "make_natural_joins" in SQL::Translator::Schema; implies "natural_join => 1" 🙅

💀 DEPRECATED ARGS 💀

bestie these are giving old news — they still exist but like, use the new ones okay? 🫶

• node_shape — Deprecated, use node => { shape => ... } instead 😭
• add_color — Deprecated, use bgcolor => 'lightgoldenrodyellow' instead 😭

If set to a true value, the graphic will have a background color of 'lightgoldenrodyellow'; otherwise the default white background will be used 🤍

• nodeattrs — Deprecated, use node => { ... } instead 😭
• edgeattrs — Deprecated, use edge => { ... } instead 😭
• graphattrs — Deprecated, use graph => { ... } instead 😭

---

💖 AUTHOR 💖

Ken Youens-Clark <kclark@cpan.org>

Jonathan Yu <frequency@cpan.org>

---

🦋 SEE ALSO 🦋

SQL::Translator, GraphViz

---

and that's the whole page bestie, no cap 💅 this was perl v5.40.0, dated 2024-11-23, and it served SQL::Translator::Producer::GraphViz(3pm) realness 👑 periodt ✨