Formatting Code through the Command Line

You can automate code formatting 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 page.

  1. Click Start.
  2. Type cmd in the Search programs and files text box and press the ENTER button.

    Note

    To run the Command Line in Windows 8:

    From the Desktop Mode

    • Move the mouse cursor to the exact lower left corner until the desktop shortcuts menu appears.
    • Right-click to see the shortcut menu and than click Run.

    From the Charms Bar

    • Move your mouse to the upper right corner until the Charms Bar appears.
    • Select Apps from the list and type ‘run’ in the search box.
    • Click Run from the search results.

    Use Windows + R Shortcut Keys

    • In desktop mode, press the Windows + R keys, to show the Run command line.
  3. Type a path to the dbforgesql.com file located in the dbForge Studio for SQL Server installation folder on your PC, and then press the SPACE key.
    C:\Program Files\Devart\dbForge Studio for SQL Server\dbforgesql.com
    
  4. Specify the operation you want to perform (code formatting) and the required parameters and arguments:
    dbforgesql.com /formatsql [/switch1[:value | [parameter1:value parameter2:value ..]] /switch2 ..]
    

    Tip: To see a quick help on the arguments available in the command line, type the following:

     /formatsql /?
    
  5. Press ENTER to run the process.

Note
You can set the unlimited quantity of the required extensions:

dbforgesql.com /formatsql /sourcefolder:"c:\" /filextention:*.sql /filextention:*.prg /filextention:*.db1	

Arguments Used in Command Line

Select corresponding command line switches to perform the required operations:

Argument Action and Usage
/connection This switch is used to specify a connection string. Command usage looks like:
/connection:<connection_string>
/filextention This switch is used to specify the extension of the source folder files that will be formatted. The .sql extension is selected by default. Command usage looks like:
/filextention:*.<sql|prc|txt|...>
/log This switch is used to generate a formatting log file in the specified directory. Command usage looks like:
/log:<filepath>
/outputfile This switch is used to specify the path to an output file where formatting results of the source file will be saved (in this case, the source file is saved without changing). If the parameter is not specified, the formatting results will be saved in the source file. Command usage looks like:
/outputfile:<path>
/outputfolder This switch is used to specify the patch to an output folder where the source folder files with formatting results will be saved (files form the source folder will no be changed). If the parameter is not specified, the formatting results will be saved in the source folder. Command usage looks like:
/outputfolder:<path>
/password This switch is used to specify a server password. It overrides the password specified in the connection string. Command usage looks like:
/password:<pw>
/profile This switch is used to specify the path to a file that contains settings for formatting options. If the parameter is not specified, the default settings will be applied to the formatting options. Command usage looks like:
/profile:<path>
/sourcefile This switch is used to specify the source SQL file to be formatted. Command usage looks like:
/sourcefile:<path>
/soucefolder This switch is used to specify the path to a folder where the files for formatting are located. Command usage looks like:
/sourcefolder:<path>
/includesubfolders This switch is used to include the current directory and all subdirectories in search operation. Command usage looks like:
/includesubfolders