SQL Doc - 2.0
Learning SQL Doc - 2.0
Getting started
SQL Doc enables you to document Microsoft® SQL Server™ databases in an easy to read web format (.html files), document format (.doc file), or compiled Microsoft® HTML Help (.chm) file.
This is useful, for example, to provide an overview for database administrators and developers who are unfamiliar with your database schemas, or to produce detailed reports for your customers.
You can use SQL Doc to document SQL Server 2008, SQL Server 2005, and SQL Server 2000 databases.
Find out more about what the documentation includes
SQL Doc step-by-step
- Create a documentation project, and specify project settings, such as project name and author.
- Specify objects to document, from one or more databases.
- Generate the documentation.
Worked example
Learn more about SQL Doc by following a detailed example: Producing documentation for two related databases.
Getting more information
Was this article helpful?
Using SQL DocSQL Doc
- Logging and log files
- Database description runs off page (Version 1.x)
- Changing the project save location (Version 1.x)
- Assertion failure outputting in CHM format
- No database objects are visible for databases using compatibility level 70
- Can't see database objects
- SQL Doc fails with 'Object reference not set to an instance of an object'
- Retaining CHM documentation source files
- Unhandled exception: input string was not in a correct format
- Minimum database permissions required for the user running SQL Doc
- SQL Doc database object description persistence
- Installing HTML Help Workshop fails silently
- Unable to cast object of type 'bn' to type 'bh'
- Logging and log files
all SQL products
- Compatibility of Red Gate tools in 64-bit environments
- Application has encountered an error and needs to close
- Error message after installing SQL Toolbelt - The description for Event ID ( 1 ) in Source ( nview_info ) cannot be found.
- Changing the temporary directory used by the installer
- Toolbelt Installer "hanging" while "scanning volumes"
- Login failing with "trusted SQL Server connection" error when using RunAs
all products
- Some Red Gate products identified as containing a trojan by Anti-Virus software
- Activation may fail with Unknown Error -1
- Product uses web help although a CHM file is available locally
- Argument exception resulting from missing environment variable
- Check for updates may fail when used through proxies
- 'Unidentified Publisher' error when repairing or uninstalling
- Licensing activates product as standard edition
- Moving Red Gate software products to another machine
- Red Gate tools log locations
- The application UI opening slowly when there is no internet access
SQL Doc
- Activating your products
- Activating your products
- Getting help offline
- SQL Doc release notes - version 2.xx
all SQL products
all products
- Red Gate product acknowledgements
- Activating your products
- Activating your products
- Red Gate bundle history
- Check for updates
- Troubleshooting Check for Updates errors
- Current versions
- Deactivating your products
- Installing Red Gate products from the .msi file
- Requesting additional activations
- Serial numbers for bundles
- Reactivating using a different serial number
- Extending your trial
- Finding your serial numbers
- Moving a serial number from one computer to another
- No response received for manual activation
- Licensing and activation resources
- Licensing and activation resources
- Troubleshooting licensing and activation errors
- Licensing and activation FAQs
- Red Gate tools log file locations
- Download old versions of products
- Download product prerequisites & utilities
- Support & upgrades
- Upgrading your software
- Upgrading FAQs
