DBDocumentor 4.40

DBDocumentor 4.40 is a powerful tool which easily produce database documentation for the SQL objects in your database project. The list of SQL objects documented varies with the SQL dialect chosen, and DBDocumentor currently supports; Microsoft SQL Server 2005 and below, Firebird 1.5, and Sybase SQL Anywhere (ASA) 10 and below. Generating reference documentation for a SQL database using DBDocumentor is as simple as selecting the SQL dialect, the object types to include and the source files to process. Within a few minutes DBDocumentor generates a fully cross referenced view of the SQL database, including where data is sourced from and what objects are modifying data in what other objects. The cross referencing extends to procedure and security usage, clearly showing which procedures are used where, and under what security context. These capabilities make DBDocumentor ideal for those wishing to learn the structure of a given database, or simply to document the database for future reference.

Extended capabilities include declarative object grouping, support for DBMS metadata based descriptions like those provided in SQL Server Enterprise Manager or SQL Server Management Studio, SQL dialect specific syntax color coding, control over the documentation of temporary objects and dynamic SQL, and the generation of XML output. All documentation is generated by reading the source SQL batch files and requires no active database connection, or any database connectivity tools.

DBDocumentor produced documentation is perfect as printed database application documentation for:

• Client documentation for software development consulting projects
• Online access for middle tier developers to develop against a documented database interface
• Determining the degree of data exposure and risk by specific database functions, procedures and Reporting Services reports
• Determining the degree of dynamic SQL used in the database, and what data sources are impacted by the use of dynamic SQL

Major Features:

1. Support for  multiple DBMS systems.  Currently the DBMS systems supported include all versions of Microsoft SQL Server (including SQL Server 2005), Firebird 1.5 and 2.0, and Sybase SQL Anywhere (ASA) 10 and below (including Watcom SQL objects)
2. Produce documentation of SQL Server Reporting Services RDL files
3. Output documentation in XML format
4. Output documentation in HTML Help format (Classic and Modern MSDN style)
5. Output documentation in pure HTML format (Modern MSDN layout only)
6. Document databases without requiring any connection to the database.
7. Determine object usage and dependencies and provide hyperlinks between all objects.
8. Determine if data is modified by an object, and report which objects are modifying data from a given data source (e.g. if a stored procedure deletes data from a table, in the summary listing for both the table and the stored procedure, data modification is listed)
9. Produce SQL dialect specific color syntax highlighted source code output in CHM documents
10. Provide persons writing documentation with the ability to supply their own example text
11. In both example and normal object descriptions, users can indicate sections of SQL to be color syntax highlighted.
12. In both example and normal object descriptions, users can indicate sections of XML to be color syntax highlighted
13. Describe object groupings for the purposes of table of contents entries
14. Define custom table of contents layouts
15. Supply custom content for inclusion in the table of contents
16. Document ad-hoc queries
17. Produce documentation of dynamic SQL
18. Control the inclusion of temporary objects
19. Optionally use DBMS specific metadata for object descriptions.  Depending upon the DBMS, the metadata may include Pikauba specific extensions.  For example, users of Microsoft SQL Server can use Microsoft extended properties and Pikauba extensions to define metadata descriptions for items not defined by default in the Microsoft SQL Server metadata, such as the intent behind stored procedure execution.
20. Document all user specified SQL objects of the DBMS, complete with the most significant attributes of those objects.
    

Enhancements:

• Added support for Firebird 2.0 and enhanced the RDL report reports
  

Requirements:

• Microsoft HTML Help Workshop