Command-line switches

This topic provides a detailed description of command-line switches and examples of how to use them.

Command-line usage

To view the list of switches for /dataexport, type the following command:

dbforgesql.com /dataexport /?

Note

To run dbForge Studio CLI commands, open Command Prompt and navigate to the folder that contains dbforgesql.com. The default path to this executable depends on where dbForge Studio for SQL Server is installed. If you installed dbForge Studio:

  • As a standalone tool
"C:\Program Files\Devart\dbForge Studio for SQL Server"
  • As part of the dbForge Edge bundle
"C:\Program Files\Devart\dbForge Edge\dbForge Studio for SQL Server"

Available command-line switches

Name Description
/connection Specifies the connection string.
Usage: /connection:<connection_string>
/errormode Specifies the application behavior when encountering an error.
  • Ignore – Ignores all errors and continues execution.
  • Abort – Cancels execution if an error occurs.

      • Usage: /errormode:<ignore|abort>
/exitcodes Displays the list of exit codes returned by the command-line operation.
Usage: /exitcodes
/outputfile (Unavailable for the ODBC format) Specifies the path to the folder to store the export.
When you export multiple tables, a separate file is created for each table.
Usage: /outputfile:<file_path>
/outputtable (Available for SQL, ODBC and MS Access formats) Specifies a destination table name.
When exporting to a server, the option value is automatically set to the table name and used in the generated INSERT statements. When exporting to a SQL format, the INSERT statements are written to the file specified by the /singlefile parameter.
Note: You cannot use this option to export multiple tables at once.
Usage: /outputtable:<table_name>
/password Specifies the server password and overrides the value from the /connection parameter.
Usage: /password:<pw>
/range Specifies the range of exported rows.
  • all – Exports all rows.
  • start:<startfrom> – Specifies the 1-based number of the row to start the data export from.
  • length:<count> – Specifies the number of rows for export.

      • Usage: /range all|<start:<startfrom> length:<count>>
/singlefile Specifies the full path to a single file to store the data export.
When you export multiple tables, they are all included in a single file.
Usage: /singlefile:<file_name>
/table Specifies one or more source table names.
Usage: /table:<table_name> [<table_name>]
/templatefile Specifies a data export template file (.det).
Usage: /templatefile:<filepath>
/treatwarningaserror Specifies the behavior for treating warnings.
  • Yes – Treats all warnings as errors, and the subsequent behavior is determined by the errormode option.
  • No – Ignores warnings and continues executing the command-line script.

      • Usage: /treatWarningAsError:[Yes|No]