Skip to content
The latest version of DbVisualizer was released 2024-03-11DOWNLOAD HERE ->

Exporting Query Results

Only in DbVisualizer Pro

This feature is only available in the DbVisualizer Pro edition.

Instead of viewing query results in Result Set grids, you can export the result of one or more queries to a file. For very large results, this may be the preferred choice due to memory constraints.

To export a query result, create a script with

  1. an @export on command,
  2. an @export set command,
  3. one or more queries,
  4. an @export off command.

Here is a basic example:

@export on;
@export set filename="c:\Backups\Orders.csv";
select * from Orders;
@export off;

The @export set command takes a parameter name followed by an equal sign and a value. You can use the following parameters, where only filename is required and all names are case-insensitive:

ParameterDefaultValid Values
AppendFilefalsetrue, false, clear
BinaryFileDirDirectory path for data files when BinaryFormat is set to File
BinaryFormatDon't ExportDon't Export, Size, Value, Hex, Base64, File
BooleanFalseFormatfalsefalse, no, 0, off
BooleanTrueFormattruetrue, yes, 1, on
CLOBFileDirDirectory path for data files when CLOBFormat is set to File
CLOBFormatValueDon't Export, Size, Value, File
CsvColumnDelimiter\t (TAB)
CsvIncludeColumnHeadertruetrue, false
CsvColumnHeaderIsColumnAliastruetrue, false
CsvIncludeSQLCommandDon't IncludeDon't Include, Top, Bottom
CsvRemoveNewlinesfalsetrue, false
CsvRowCommentIdentifier
CsvRowDelimiter\n\n (UNIX/Linux/macOS), \r\n (Windows)
DateFormatyyyy-MM-ddSee valid formats in Changing the Data Display Format document
DecimalNumberFormatUnformattedSee valid formats in Changing the Data Display Format document
DestinationFileFile
EncodingUTF-8
ExcelColumnHeaderIsColumnAliasfalsetrue, false
ExcelFileFormatBinaryTwo formats are supported - Binary Excel (xls) supporting export of max 65 535 rows. Specified as "Binary Excel (xls)", "Binary" or "xls" - OOXML, Excel 2007 (xlsx). Specified as "OOXML, Excel 2007 (xlsx)", "OOXML" or "xlsx**"
ExcelIncludeColumnHeadertruetrue, false
ExcelIncludeSQLCommandfalsetrue, false
ExcelIntroTextAny description
ExcelSheetNameUsed when exporting to excel. Sets the name of exported excel sheet.
ExcelTextOnlyfalsetrue, false
ExcelTitleAny title
FilenameREQUIRED
FormatCSVCSV, HTML, XML, SQL, XLS, JSON
HtmlIncludeSQLCommandfalsetrue, false
HtmlIntroTextAny description
HtmlTitleAny title
JSONStyleArrayArray, Rows
NumberFormatUnformattedSee valid formats in Changing the Data Display Format document
QuoteDuplicateEmbeddedtruetrue, false (quote char is the same as QuoteTextData)
QuoteTextDataNoneNone, Single, Double
SettingsThe path to an XML file containing all settings
ShowNullAs(null)
SqlBeginIdentifierCharacter to use to begin a quoted identifier. Note! To specify a double-quote, you must duplicate it since double-quote is also used to enclose the parameter value.
SqlBlockBeginDelimString to use to begin an SQL block when exporting complex DDL statements using the @ddl command.
SqlBlockEndDelimString to use to end an SQL block
SqlDelimitedIdentifierstruetrue, false
SqlEndIdentifierCharacter to use to end a quoted identifier. Note! To specify a double-quote, you must duplicate it since double-quote is also used to enclose the parameter value.
SqlIncludeCreateDDLfalsetrue, false
SqlIncludeSQLCommandDon't IncludeDon't Include, Top, Bottom
SqlQualifierQualifier to use when qualifying table names. If not set, DbVisualizer tries to determine the schema and use it as the qualifier.
SqlQualifyColumnNamefalsetrue, false
SqlQualifyObjectNametruetrue, false
SqlRowCommentIdentifier--
SqlSeparator;Statement separator character.
TableNameCan be set if DbVisualizer cannot determine the value for the ${dbvis-object}$ variable
TimeFormatHH:mm:ssSee valid formats in Changing the Data Display Format document
TimeStampFormatyyyy-MM-dd HH:mm:ss.SSSSSSSee valid formats in Changing the Data Display Format document
XmlIncludeSQLCommandfalsetrue, false
XmlIntroTextAny description
XmlStyleDbVisualizerDbVisualizer, XmlDataSet, FlatXmlDataSet

Here are a few examples using some of these settings.

Automatic table name to file mapping

This example shows how to make the filename the same as the table name in the select statement. The example also shows several select statements. Each will be exported in the SQL format. Since the filename is defined to be automatically set, this means that there will be one file per result set and each file is named by the name of its table.

@export on;
@export set filename="c:\Backups\${dbvis-object}$" format="sql";
select * from Orders;
select * from Products;
select * from Transactions;
@export off;

There must be only one table name in a select statement in order to automatically set the filename with the ${dbvis-object}$ variable, i.e if the select joins from several tables or pseudo tables are used, you must explicitly name the file.

The ${dbvis-object}$ variable is not substituted with a table name if using the AppendFile="true/clear" parameter.

Multiple results to a single file

This example shows how all result sets can be exported to a single file. The AppendFile parameter supports the following values.

  • true The following result sets will all be exported to a single file
  • false Turn off the append processing
  • clear Same as the true value but this will in addition clear the file before the first result set is exported
@export on;
@export set filename="c:\Backups\alltables.sql" appendfile="clear" format="sql";
select * from Orders;
select * from Products;
select * from Transactions;
@export off;

Using predefined settings

If you save settings when exporting a table or a schema, you can use the Settings parameter to reference the settings file.

@export on;
@export set settings="c:\tmp\htmlsettings.xml" filename="c:\Backups\${dbvis-object}$";
select * from Orders;
select * from Products;
select * from Transactions;
@export off;

Limit the number of exported rows

You can use the @set maxrows command in combination with the @export command to override the Max Rows field value in the SQL Commander tab toolbar.

@set maxrows 10;
@export on;
@export set filename="c:\Backups\alltables.sql" format="sql";
select * from Orders;
select * from Products;
select * from Transactions;
@export off;

If Max Rows is set to a positive number, you can use the @set maxrows command to set it to -1 to export all rows.