Suggestions on documenting a database?
Posted: Mon Jun 02, 2003 12:11 pm
I have an application that uses two databases (each with about 100 tables) and each with a number of distinct web-user accounts with different permissions in addition to one-two console user-accounts. I'ld like to generate some good documentation for use by other developers.
I'ld like a Doxygen/phpDoc style tool where I can comment up the SQL DDL file that creates the database and prepopulates some "pseudo-domains". The tool should generate both html and pdf(or other print-format) and should be able to understand SQL for most of its work. (Doxygen can't parse SQL, so while I could use it I'ld have to retype all the SQL DDL into doxygen comments.)
Things that I'ld specificly like the tool to document:
tables, views, rules/triggers/stored procedures, users, domains/user-defined-types
Specifically for tables, it should pull out the table name, the fields and their type/domain with possible comments, the primary key, any foreign key with (web) hyperlinks to the linked table, user permissions as well as pulling description type comments out.
Does anyone know of any such tool? (SQL in general or PostGreSQL in paticular)
I'ld like a Doxygen/phpDoc style tool where I can comment up the SQL DDL file that creates the database and prepopulates some "pseudo-domains". The tool should generate both html and pdf(or other print-format) and should be able to understand SQL for most of its work. (Doxygen can't parse SQL, so while I could use it I'ld have to retype all the SQL DDL into doxygen comments.)
Things that I'ld specificly like the tool to document:
tables, views, rules/triggers/stored procedures, users, domains/user-defined-types
Specifically for tables, it should pull out the table name, the fields and their type/domain with possible comments, the primary key, any foreign key with (web) hyperlinks to the linked table, user permissions as well as pulling description type comments out.
Does anyone know of any such tool? (SQL in general or PostGreSQL in paticular)