Generating Database Document

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. The Command Prompt opens.

  2. Specify the operation you want to perform and the required parameters and arguments (actions you want to run) in the Command Prompt, for example as follows:

dbforgesql.com /document [/switch1[:value | [parameter1:value parameter2:value ..]] /switch2 ..]
  1. Press ENTER to run the process.

Select corresponding command line switches to perform the required operations:

Argument Action and Usage
/author This switch is used to override authorship information. The command line looks like: /author:<author>
/breadcrumbs This switch is used to generate breadcrumbs. Available values are: Y and N. Y is the default value. The command line looks like: /breadcrumbs:<Y|N>
/connection This switch is used to specify a connection string. The command line looks like: /connection:<"Data Source=DBMSSQL\MSSQL2012;Integrated Security=False;User ID=sa">
/copyright This switch is used to specify copyright information.
/created This switch is used to override generation date format. The default format is: MM/DD/YYYY.
/database This switch is used to specify the database name. The command line looks like: /database:<DB1>
/docdescription This switch is used to override the default document description on the cover page. The command line looks like: /docdescription:<description>
/doclogo This switch is used to override the document logo. The command line looks like: /doclogo:<"d:\mydoc\proj.png">
/doctitle This switch is used to override the document title on the cover page. The command line looks like: /doctitle:<title>
/documentformat This switch is used 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 This switch is used to specify the output path for generated documentation.
/password This switch is used to specify server password. Overrides password specified in the connection string. The command line looks like: /password:<pw>
/permissions This switch is used 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 This switch is used to sspecify a project file. The command line looks like: /projfile:<"D:\mydoc.doc">