Documenting relational databases (tables, views, functions, triggers)

Question

I'm trying to improve the knowledge management of MySQL structures available on a project. By structure, I mean tables, views, functions, procedures, triggers.

All these structures are extracted in .sql files.

I'm looking for a way to document these structures, presenting results à la doxygen in HTML files. For example, I want this tool to group functions in a section, with documentation tags extracted and reformatted to be human-readable added to each function.

I tried looking at doxygen, but it seems it does not support sql yet.

I need tools that can be run in batchs, using a linux environment.

What tools do you know ? Do you have advices on how to achieve good knowledge management of databases ?

Thanks !

Answer 1

DBExplorer is close to what you seem to be looking for.

Answer 2

There is an interesting article on this topic called "Towards the Self-Documenting SQL Server Database" over @ http://www.simple-talk.com/sql/sql-tools/towards-the-self-documenting-sql-server-database/

In the meantime, there is at least this tool that will do what you describe: http://www.elsasoft.org/

It isn't free though, it looks like it's $150.

I'd be interested in finding an opensource tool...

Answer 3

I found pldoc. I will try it to see if it fits my needs.