Skip to content
The latest version of DbVisualizer was released 2024-12-04DOWNLOAD HERE ->

Using Client-Side Commands

You can use these DbVisualizer client-side commands in your SQL scripts. (These commands are processed by DbVisualizer and never sent to the database as-is).

CommandDescription
@cd <directory>@run <file> [ <variables> ]Use these command to execute an external script.
@exportUse this command to export the result of a query or procedure call to a file.
@delimiter <new_delimiter>Use this command to temporarily change the statement delimiter for a complex statement.
@call <function_or_proc>Use this command to execute a function or procedure.
@beepUse this command to emit a beep sound, e.g. to indicate a significant point in a script.
@sleep <milliseconds>Use this command to halt the processing the specified number of milliseconds.
@echo <text>Use this command to write to the Log tab.
@window iconify@window restoreUse these commands to lower (iconify) or raise (restore) the DbVisualizer main window.
@desc <table>Use this command to show column information for a table. The table name may be qualified with a schema and/or database name.
@ddl <params>Use this command to get the DDL for a database object.
@log <file_name> [spool|close]Use this command to write log messages to a named file. Examples 
@log /tmp/myLog.txt;
@log /tmp/myLog.txt close;
@log /tmp/allLog.txt spool;

1. Logs subsequent commands to the file /tmp/myLog.txt. If we are already logging to another file as the result of a previous @log command that log is closed 2. Stops logging to the file 3. Writes all log messages up to this @log command to the named file
@spool log <file_name>This command is not supported any more. Please use the @log command instead.
@stop on error@stop on sqlwarning@stop on norows@continue on error@continue on sqlwarning@continue on norowsUse these commands to control what to do when a statement results in a warning or an error.
@set autocommit on@set autocommit offUse these commands to control the Auto Commit state.
@commit@rollbackUse these commands to explicitly commit or rollback updates.
@set serveroutput on@set serveroutput offUse these commands to enable or disable output to the DBMS Output tab for Oracle databases.
@set maxrows <number>@set maxchars <number>Use these commands to adjust the Max Rows and Max Chars limits for specific queries.
@set resultset name <name>Use this command to name any following result set. When executed with a following SQL statement that produces a result set the tab showing this result set will be named using the <name> supplied as a parameter to the command. Example: 
@set resultset name MyEmployees;
select * from EMPLOYEE;

DbVisualizer will for the example above show the result of the select in a tab named MyEmployees