DUMP

Extract the full content of a table in a local file

Arguments

table name (mandatory). By default the files are located in the c:\temp directory. Format is chosen by parameter DefaultFileFormat (XLSX, ODS, CSV or TXT; defaults to ODS), except beyond MaxRowXLSX rows where a tab-separated .txt is always used.

Examples

DUMP customer
Extracts the content of table CUSTOMER in file customer.ods (or another extension, depending on DefaultFileFormat)

Notes

Extracts the full content of a table to a local file: DUMP <tableName>.

tableName is mandatory and may be schema-qualified (e.g. DUMP PUBLIC.CUSTOMER). The command fails with an error if the table does not exist, or if no table name is given.

The output file is written to the configured export folder (DefaultFolder in BroadSQL.ini, c:\temp\ by default), named after the table as typed (schema included, if given). The file extension is chosen automatically from the table's row count: tab-separated .txt beyond the configured threshold (MaxRowXLSX in BroadSQL.ini), or the extension matching DefaultFileFormat (XLSX/ODS/CSV/TXT, defaults to ODS) at or below it - including when the row count itself could not be determined, in which case that same default format is used as a fallback.

On success, the console reports the number of records extracted and the destination file path. There is currently no option to choose the destination, the file name, or the format explicitly.

Recommended alternative: PULL <tableName> TO <name> AS CSV/TXT/XLSX/ODS (see CommandPull, docs/PULL_TO_TEXT.md, docs/PULL_TO_SPREADSHEET.md) lets you choose the format and destination name explicitly, instead of DUMP's automatic row-count-based choice. Not a drop-in replacement for every existing script: PULL ... AS CSV uses the separate CsvSeparator INI setting (semicolon if absent), not DefaultFileFormat/row-count-based selection, and rejects BLOB/CLOB/binary columns outright rather than writing whatever ResultSet.getString() returns for them. This command is unaffected by that addition and keeps working exactly as documented above.

Last modified in release 5.0.7.