Features
Take a look at What's New in the download section.
These are the main features of dbdesc:
- Table dependency matrix
- Full extended property editor
- Include / exclude individual objects
- Wizard based interface
- Extensive database info extraction
- Multidatabase support (currently SQL Server, Ms Access, Oracle and Firebird)
- XML output
- 2 report engines: a XSL parser and a built-in report engine
- XSL templates included to generate HTML, RTF and Word 2003 documents
- Report viewer with integrated search, database index, PDF export.
- Syntax highlighting
- Command line support for scheduled runs, continuous intregration, etc
- Autodiscover SQL Server instances on the network and databases list
- Select which database objects you want to document
Databases support
At the moment dbdesc supports:
- Microsoft SQL Server 2000 and MSDE
- SQL Server 2005/2008/2012/2014/2016 including Express editions
- MySQL 5.0 or above
- Microsoft Access 97 or above
- Firebird
- Oracle 9+
Support for additional databases are in development.
Data extraction
We are improving dbdesc to get more and more info from the databases. At this moment dbdesc allows you to document the following info:
Database info | SQL Server | MySQL | Access | Firebird |
Table names | ||||
Table descriptions | ||||
Table dependencies |
1 |
|||
Table definitions | ||||
Field names | ||||
Field descriptions | ||||
Field types | ||||
Field size / precision | ||||
Field default values | ||||
Field allow null | ||||
Primary keys | ||||
Indexed fields | ||||
Index details | ||||
Foreign keys | ||||
Foreign keys details | ||||
Check constraints | ||||
Views names | ||||
View descriptions | ||||
Views creation/update dates | ||||
View fields | ||||
View definitions | ||||
Views dependencies |
1 |
|||
Stored procedures names | ||||
Stored procedure descriptions | ||||
Stored procedures creation/update dates | ||||
Stored procedures definitions | ||||
Stored procedures dependencies |
1 |
|||
Trigger names | ||||
Trigger descriptions | ||||
Trigger creation dates | ||||
Trigger types | ||||
Trigger active/inactive | ||||
Trigger definitions | ||||
UDF names | ||||
UDF definitions | ||||
UDF descriptions | ||||
UDF creation/update dates | ||||
UDF dependencies | ||||
User-defined data types | ||||
Database users | ||||
Object permissions | ||||
Extended properties | ||||
Generators |
(1): READ permision flag must be enabled on tables MSysObjects and MSysQueries for user Admin.
Supported | Currently not supported | Info not available in the database |
Data output
dbdesc can generate database documentation in different formats. Currently dbdesc supports PDF, RTF, HTML and Word 2003 output formats.
Take a look at some output samples.