SqlSpec generates documentation in two formats: HTML or CHM. HTML is useful for publishing your documents on the web or an intranet site. CHM is useful if you want a single, compact file containing all your documentation about one or more databases. The CHM is indexed so it is easily searchable for any keyword. This way you can easily determine which objects reference the "EmployeeID" column, for example.
SqlSpec supports every major DBMS on the market today. See the pages below for a detailed list of the items documented by SqlSpec for all supported platforms.
- Microsoft SQL Server
- Microsoft Analysis Server
- Microsoft Report Server
- Microsoft Integration Server
- Microsoft Access
- Sybase ASE
- Sybase SQL Anywhere
- ENEA Polyhedra
SqlSpec is supported by a very responsive development team. If you have an idea for a feature that SqlSpec is missing, let us know.
Besides excellent technical support and compatibility with every major DBMS on the market, there are several features that make SqlSpec stand out from the crowded field of database documentation tools available today:
- Extended property/comment editor supporting SQL Server, Oracle, and more!
- Show scripts for all objects documented.
- Ability to add your own branding logo (headers and footers) to each page in the documentation.
- Run as a console application, useful for automating SqlSpec to generate documentation for your databases on a schedule, or integrating SqlSpec into your development process.
- Supports XML comments added to your stored procedures, user defined funtions, views, and triggers, similar to XML comments in C# code. These comments are parsed by SqlSpec and the content is placed in your documentation.
- Include external objects (such as web services, web pages, and other components) in the documentation. Specify dependencies of external objects on database objects and they will be included in the dependency graphs.
- Creates data model diagrams where any database object (or external object) can be represented.
- Specify an exclusion list so that certain objects (or just the SQL code for them) can be excluded from the documentation.
- Specify a custom navigation hierarchy to include arbitrary HTML files in the generated CHM.
- Generate dependency and primary/foreign key graphs. Such diagrams are much easier to understand at a glance than a flat list of dependent objects.
- Generate a call graph for sprocs and udfs that call other sprocs and udfs.
- Fine control over what object types are documented.
- Support for every major DBMS in a single affordable tool.