How to generate a database document through the command line
You can automate document generation using the command line.
Note
The command-line interface is available only in certain editions of dbForge Studio. For detailed information on the features availability in the dbForge Studio editions, please refer to the Editions topic.
1. Click Start, type ‘cmd’ in the Search programs and files text box, and press ENTER.
2. In the Command Prompt that opens, specify the operation you want to perform and the required parameters and arguments (actions you want to run). For example:
dbforgesql.com /document [/switch1[:value | [parameter1:value parameter2:value ..]] /switch2 ..]
3. Press ENTER to run the process.
Use the following command line switches to perform the required operations:
| Argument | Action and Usage |
|---|---|
| /author | Use to override authorship information. The command line looks like: /author:<author> |
| /breadcrumbs | Use to generate breadcrumbs. Available values are: Y and N. Y is the default value. The command line looks like: /breadcrumbs:<Y|N> |
| /connection | Use to specify a connection string. The command line looks like: /connection:<"Data Source=DBMSSQL\MSSQL2012;Integrated Security=False;User ID=yourusername"> |
| /copyright | Use to specify copyright information. |
| /created | Use to override generation date format. The default format is: MM/DD/YYYY. |
| /database | Use to specify the database name. The command line looks like: /database:<DB1> |
| /docdescription | Use to override the default document description on the cover page. The command line looks like: /docdescription:<description> |
| /doclogo | Use to override the document logo. The command line looks like: /doclogo:<"d:\mydoc\proj.png"> |
| /doctitle | Use to override the document title on the cover page. The command line looks like: /doctitle:<title> |
| /documentformat | Use to specify the documentation format. Available formats are PDF and HTML. By default, the document format is HTML. The command line looks like: /documentformat:<PDF|HTML> |
| /outputfile | Use to specify the output path for generated documentation. |
| /password | Use to specify server password. Overrides password specified in the connection string. The command line looks like: /password:<yourpassword> |
| /permissions | Use to include permissions data into documentation. Available values are: Y|N. The default value is Y. The command line looks like: /permissions:<Y|N> |
| /projfile | Use to specify a project file. The command line looks like: /projfile:<"D:\mydoc.doc"> |
Want to Find out More?
Overview
Take a quick tour to learn all about the key benefits delivered by dbForge Studio for SQL Server.
All features
Get acquainted with the rich features and capabilities of the Studio in less than 5 minutes.
Request a demo
If you consider employing the Studio for your business, request a demo to see it in action.
Ready to start using dbForge Studio for SQL Server?