Schemaball is an SQL database schema viewer. It requires Perl and a few modules, such as GD and optionally Math::Bezier and SQL::Translator. Schemaball creates flexible visualizations of database schemas. Schemas may be read from an SQL schema dump, flat file or live database.

schemaball

home about screenshots requirements

documentation

tour tutorials README CHANGES man page

download

Perl code

Tour

overview

Schemaball is a Perl script which uses GD to generate static, circularly formatted SQL database schema views. Schemaball is well-suited for use in publications, online or print, presentations or schema development. Schemaball is suitable for visualizing schemas of all sizes.

Figure |

features

To illustrate the features of schemaball, I'll use our ugene MySQL database (middle schema in the above figure). In the schema view below, the tables can be seen organized around a circle in alphabetical order. Tables which are linked by foreign key relationships - I'll get to how this is done in MySQL in a moment - are linked using bezier curves. In the view below, neighbours and next-neighbours of the Clone table are highlighted.

Figure | A view of the ugene schema. The ugene database has 35 tables.

The simplest schema ball is one in which the table glyphs are shown without links. I find this view to be useful as a design template. I can print a few copies out and draw possible table relationships as I work on a schema.

Figure | A blank schema ball of the ugene database. Tables without relationships are shown.

Tables can be hidden from the schema ball using regular expressions that are applied to the table names. In this case I've removed all tables which have the letter "a" in them.

Figure | The blank schema ball without any tables which have 'a' in their name.

One of the main features of schemaball is the ability to visualize links between tables. Schemaball can parse these links from the schema structure itself (CONSTRAINT table options), using field names (if you've named your foreign keys using some convention), or from a file listing the table pairs.

Figure | Table relationships can be visualized using straight line connectors.
Figure | The straight lines can be replaced by Bezier curves to make the schema ball more attractive.

The curvature of the Bezier lines can be adjusted using a parameter which controls the distance from the center of the schema ball of the middle point on the Bezier curve.

Figure | The straight lines can be replaced by Bezier curves to make the schema ball more attractive.

Schemaball is very flexible. You can turn off the table glyphs and labels and have your schema turned into Bezier art.

Figure | Only Bezier links are shown.

If you are paranoid about your intellectual property but would like to show the complexity of your schema to impress your competitors, you can anonymize the labels.

Figure | Table names become 'Table IDX' to thward the reverse-engineers while you patent your masterpiece.

You can specify the colour characteristics of the features in the schema ball. Let's switch to a soothing blue theme. The table glyphs can be stroked and the link lines made thicker.

Figure | Rainy Monday colour theme with thicker link lines and stroked table glyphs.

Tables can be highlighted using regular expressions, which are applied to the table names. Below, I show how three different table groups can be highlighted.

Figure | Regular expressions are used as filters to determine which tables are highlighted. (left) the rx "^Clone" is used to highlight all tables whose names start with the string "Clone" (middle) three regular expressions: "^Clone , "^Gene ," "^Sequence are used to highlight specific tables (right) tables with names longer than 11 characters are highlighted using "^(.){12,}". The colour and stroke of the highlighted table can be adjusted.

Tables can be hidden from the schema ball. This feature is useful if you have a lot of tables and would like to focus on the relationships between a subset of tables. Hiding is implemented in two ways: making tables in the schema ball invisible, but retaining a gap in the schema ball where the invisible table glyph is, or removing the table from the schema ball altogether and rearranging the other tables to fill the ball. Hiding is controlled using regular expression, in the same way as highlighting.

Figure | The tables are highlighted using "^Clone". All tables are shown (left) and tables matching the regular expression "_" are invisible (middle). Tables matching the regular expression "_" are removed from the schema ball (right).

If you hide tables by making them invisible, you can choose to still have links to these tables kept in the schema ball. I don't know why you'd want to do this, but you can.

Figure | All the tables with "_" in their name are invisible (left). By default links do not connect to invisible tables, unless you set the "link_to_invisible" option (right).

In addition to hiding and highlighting tables, you can also hide and highlight links. The hiding and highlighting process is controlled by regular expressions, like for tables. A link that joins two tables TABLE1 and TABLE2 together is named TABLE1___TABLE2 and the regular expressions controlling link visibility are applied to this compound name. For example, "^TABLE1___" selects all links which point from TABLE1 and "___TABLE2$" selects all links which point to TABLE2.

Figure | Hiding and highlighting links is accomplished using regular expressions. Links matching "Clone", "Build" and "Sequence" are hidden. These are all links coming to/from tables which have these strings in their name (left). The same links as hidden in the left panel are highlighted (middle). Links matching "Build" are hidden, while links matching "Clone" and "Sequence" are highlighted.
Figure | The fact that the schema is a directed graph can be illustrated by adjusting the link highlight regular expression to match to the source or sink table in the link. All links coming from the table "Build" are highlighted using the regular expression "^Build___" (left). All links arriving at the "Build" table are highlighted with "___Build (right). The highlight colour can be adjusted.

Tracing the table dependency through foreign key relationships can be tedious in a large schema. Schemaball supports a chain hilighting scheme which follows links from highlighted tables and highlights connected tables. You can adjust the number of iterations of this scheme to highlight linked neighbours of a table to varying degrees of separation. A number of different parameters controls how the highlighting is inherited.

The "highlight_by_link" property is used to highlight tables which connect to highlighted links. This is useful if you would like to highlight all tables which, for example, are referenced by a specific table.

Figure | First I highlight all links pointing from the "Build" table using the regular expression "^Build___". I also highlight the Build table itself, but this is not strictly necessary for the second step (left). By setting "highlight_by_link", schemaball automatically highlights any tables participating in the highlighted links (right). Thus I answer the question: what tables are referenced by the Build table?

The highlight_by_iterations specifies the number of cycles of highlight inheritance that Schemaball should follow. You can follow links in the forward or reverse direction, or both.

Figure | All links from the Contig table are highlighted using "^Contig___" (left). By using highlight_by_link, all tables associated with the highlighted links are highlighted (middle). Setting highlight_by_iterations to 1 and highlight_by_table_forward causes Schemaball to travel from all highlighted tables along links in the forward direction and highlight new links and new tables which are pointed to by highlighted tables. In this case, 4 new tables are highlighted (right). Thus I answer the question: which tables are 1 or 2 lookups away from the Contig table?
Figure | In the same manner as above, links can be followed backwards. In this process, tables which refer to highlighted tables are highlighted. I use the "Build" table, and highlight all links (1) and then tables (2) which point to it using "___Build to highlight the links. By setting highlight_by_table_reverse and turning off highlight_by_table_forward and incrementally increasing highlight_by_iterations from 1 to 4 I get panels (3) - (6).

If a large value for highlight_by_iterations is used and the schema is large, you can wind up with many highlighted elements. In order to retain information about the inheritance depth of a highlighted element, the "fade_factor_table" and "fade_factor_link" parameters are used. When these parameters are used, the highlight colour is progressively diluted with each iteration.

Figure | This is one of our latest schemas, the sequencing LIMS system. Tables with names bigger than 14 characters are hidden and all links and tables upstream from the Equipment table are highlighted. With each iteration, the colour of the table and link highlight is closer to the colour of the un-hilighted corresponding element. Bezier curves are used (left) and straight lines (right). I find the Bezier curves guide the eye to the associated table much better than lines, which tend to diverge immediately from the table.