Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

What tools are available to document a legacy database schema (PDF, DOC, HTML, RTF) [closed]

I need to document a legacy database schema for a new employee and as there's no design document I'd like to generate one from the existing schema. As the tables are MyISAM the foreign key relationships won't produce a nice graph. I'm interested in producing a document showing the important tables, their columns, types and remarks.

Are there any tools available to produce a nice document (PDF, DOC, HTML or RTF say) from the database schemas meta data? Or am I better writing a utility to export this myself (I was thinking dump it to XML and then transform it using XSLT)? The schema is running on MySQL 5.

like image 233
BenM Avatar asked May 13 '09 17:05

BenM


People also ask

How do you write a documentation for a database?

Documentation overviewTable and column descriptions imported from extended properties (MS_Description property set by SSMS). Table and column relationships (foreign keys) Table triggers. Object dependencies.

What is used to Document data model?

A data structure diagram (DSD) is a diagram and data model used to describe conceptual data models by providing graphical notations which document entities and their relationships, and the constraints that bind them.

What is database design documentation?

The document describes, how the database that will support the [Application] Data Model with details of the logical and physical definitions. The document provides the functional and non-functional usage of the tables, considerations and requirements.


2 Answers

After some research and looking at the options available I've decided to use schema spy which does pretty much want I wanted.

It produced the results in a reasonable format, but also provided an XML dump of the meta data which I was able to use to write an XSLT transformation to match what I wanted in the first place.

Tip came from answer to question 1869.

like image 157
BenM Avatar answered Sep 21 '22 22:09

BenM


You can use MySQL Workbench or his ancestor DBdesigner 4 (open source):

  1. Capture all the database diagram graphically with the "reverse engineering" tool.
  2. Adjust and comment anything you need.
  3. Use the HTML report plugin included in the plugins menu.

Done!

like image 41
backslash17 Avatar answered Sep 19 '22 22:09

backslash17