SQL Doc - 2.0
Learning SQL Doc - 2.0
What's in the documentation?
The preview and the generated documentation show almost identical information. For details of differences between these views, and other restrictions on the content of generated documentation, see What's not in the documentation?
Documentation overview
Formatting of generated documentation depends on which file type you choose when you generate the documentation and settings in the application you use to view the documentation. The following examples show formatting with the web page (HTML) file type.
Object type summaries
To see a summary for an object type, click its name. For example, click Tables to see a summary of all the tables in the database.
The Description column shows the text that has been added to the database using the MS_Description extended property.
Object documentation
To see information about a particular object, click the object name. The documentation shows the object's properties and SQL creation script.
For tables, the documentation also includes details of columns, indexes, triggers, constraints, permissions, and other extended properties such as input masks. The following icons are used in documentation for tables:
|
primary key (nonclustered) |
|
clustered index |
|
primary key (clustered) |
|
foreign key |
|
index |
|
check constraint |
The following example shows the documentation for the WidgetPrices table.
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
