SQL Doc - 2.1
Using the command line - SQL Doc
SQL Doc provides a command line interface so that you can generate database documentation from the command line or in script or batch files.
Before you can use the command line to generate documentation, you must set up a documentation project, generate the documentation at least once, and then save the project. This creates a project file that contains information such as the connection details and objects to document.
To generate documentation, enter a command in the form:
sqldoc /project:project_file
To generate documentation to a different file type, use the /filetype switch to specify the file type. For example:
sqldoc /project:project_file /filetype:doc
The available file types are as follows:
doc |
document (.doc) |
html |
web pages (.html), no frames |
html-frames |
web pages (.html), using frames |
chm |
help file (.chm) |
For more information about the file types, see About documentation formats.
If the SQL Server for the database has SQL Server authentication and you have not saved the password, use the /password switch to specify the password:
sqldoc /project:project_file /password:password
Getting help from the command line
To display help from the command line, enter:
sqldoc /help
This displays basic help on all the command line switches. For more detailed help, enter:
sqldoc /help /verbose
This displays a detailed description of each switch and the values it can accept (where applicable), and all exit codes. To output the help in HTML format, enter:
sqldoc /help /verbose /html > filename.html
Entering a command
When you enter a command line, the order of switches is unimportant. Separate a switch from its values using a colon as shown below.
/project:MyProject.sqldoc
Note that the colon must not be followed by a space; values that include spaces must be delimited by double-quotes. For example:
/project:"c:\My Project.sqldoc"
Aliases
Many of the switches have an alias. The alias provides a convenient short-hand way to specify the switch. For example, /? is the alias for the /help switch, and /v is the alias for the /verbose switch. Note that switches and aliases are not case-sensitive.
See also |
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
