sqlt-diagram(1p)

sqlt-diagram1p

Automatically create a diagram from a database schema

Usage

Options: {-o | --output Output file name (default STDOUT) -i | --image Output image type ("png" or "jpeg," default "png") -t | --title Title to give schema -c | --cols Number of columns -n | --no-lines Don't draw lines --font-size Font size ("small," "medium," "large," or "huge,"}

default "medium") --gutter Gutter size between tables --color Add colors --show-fk-only Only show fields that act as primary

or {foreign keys --natural-join Perform natural joins --natural-join-pk Perform natural joins from primary keys only -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}

Overview

This script will create a picture 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 "REFERENCES" 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.

Releases

10 releases since Debian 4.0 (Etch); the text changed 9 times.

  1. 4.0
  2. 5.0
  3. 6.0
  4. 7
  5. 8
  6. 9
  7. 10
  8. 11
  9. 12
  10. 13

Author

Ken Youens-Clark <[email protected]>.

From libsql-translator-perl 1.66-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.