SQL Workbench/J User's Manual


Table of Contents

1. General Information
1.1. Software license
1.2. Program version
1.3. Feedback and support
1.4. Credits and thanks
1.5. Third party components
2. Change log
3. Installing and starting SQL Workbench/J
3.1. Pre-requisites
3.2. First time installation
3.3. Upgrade installation
3.4. Starting the program from the commandline
3.5. Starting the program using the shell script
3.6. Starting the program using the Windows launcher
3.7. Configuration directory
3.8. Increasing the memory available to the application
3.9. Command line parameters
4. JDBC Drivers
4.1. Configuring JDBC drivers
4.2. Connecting through ODBC
4.3. Specifying a library directory
4.4. Popular JDBC drivers
5. Connecting to the database
5.1. Connection profiles
5.2. Managing profile groups
5.3. JDBC related profile settings
5.4. Extended properties for the JDBC driver
5.5. SQL Workbench/J specific settings
5.6. Connect to Oracle with SYSDBA privilege
5.7. ODBC connections without a data source
6. Editing SQL Statements
6.1. Editing files
6.2. Command completion
6.3. JOIN completion
6.4. Customizing keyword highlighting
6.5. Reformat SQL
6.6. Create SQL value lists
6.7. Programming related editor functions
7. Using SQL Workbench/J
7.1. Displaying help
7.2. Resizing windows
7.3. Executing SQL statements
7.4. Displaying results
7.5. Creating stored procedures and triggers
7.6. Dealing with BLOB and CLOB columns
7.7. Performance tuning when executing SQL
7.8. SQL Macros
7.9. Using workspaces
7.10. Saving and loading SQL scripts
7.11. Viewing server messages
7.12. Editing data
7.13. Deleting rows from the result
7.14. Deleting rows with foreign keys
7.15. Navigating referenced rows
7.16. Sorting the result
7.17. Filtering the result
7.18. Running stored procedures
7.19. Export result data
7.20. Copy data to the clipboard
7.21. Import data into the result set
8. Variable substitution in SQL statements
8.1. Defining variables
8.2. Editing variables
8.3. Using variables in SQL statements
8.4. Prompting for values during execution
9. Using SQL Workbench/J in batch files
9.1. Specifying the connection
9.2. Specifying the script file(s)
9.3. Specifying a SQL command directly
9.4. Specifying a delimiter
9.5. Specifying an encoding for the file(s)
9.6. Specifying a logfile
9.7. Handling errors
9.8. Specify a script to be executed on successful completion
9.9. Specify a script to be executed after an error
9.10. Ignoring errors from DROP statements
9.11. Changing the connection
9.12. Controlling console output during batch execution
9.13. Running batch scripts interactively
9.14. Setting configuration properties
9.15. Examples
10. Using SQL Workbench/J in console mode
10.1. Entering statements
10.2. Exiting console mode
10.3. Setting or changing the connection
10.4. Displaying result sets
10.5. Running SQL scripts that produce a result
10.6. Controlling the number of rows displayed
10.7. Controlling the query timeout
10.8. Managing connection profiles
11. Export data using WbExport
11.1. Memory usage and WbExport
11.2. Exporting Excel files
11.3. General WbExport parameters
11.4. Parameters for text export
11.5. Parameters for XML export
11.6. Parameters for type SQLUPDATE, SQLINSERT or SQLDELETEINSERT
11.7. Parameters for Spreadsheet types (ods, xslm, xls, xlsx)
11.8. Parameters for HTML export
11.9. Compressing export files
11.10. Examples
12. Import data using WbImport
12.1. General parameters
12.2. Parameters for the type TEXT
12.3. Text Import Examples
12.4. Parameters for the type XML
12.5. Update mode
13. Copy data across databases
13.1. General parameters for the WbCopy command.
13.2. Copying data from one or more tables
13.3. Copying data based on a SQL query
13.4. Update mode
13.5. Synchronizing tables
13.6. Examples
14. Other SQL Workbench/J specific commands
14.1. Create a report of the database objects - WbSchemaReport
14.2. Compare two database schemas - WbSchemaDiff
14.3. Compare data across databases - WbDataDiff
14.4. Search source of database objects - WbGrepSource
14.5. Search data in multiple tables - WbGrepData
14.6. Define a script variable - WbVarDef
14.7. Delete a script variable - WbVarDelete
14.8. Show defined script variables - WbVarList
14.9. Confirm script execution - WbConfirm
14.10. Run a stored procedure with OUT parameters - WbCall
14.11. Execute a SQL script - WbInclude (@)
14.12. Extract and run SQL from a Liquibase ChangeLog - WbRunLB
14.13. Handling tables or updateable views without primary keys
14.14. Change the default fetch size - WbFetchSize
14.15. Run statements as a single batch - WbStartBatch, WbEndBatch
14.16. Extracting BLOB content - WbSelectBlob
14.17. Control feedback messages - WbFeedback
14.18. Setting connection properties - SET
14.19. Changing read only mode - WbMode
14.20. Show table structure - DESCRIBE
14.21. List tables - WbList
14.22. List stored procedures - WbListProcs
14.23. List triggers - WbListTriggers
14.24. Show the source of a stored procedures - WbProcSource
14.25. List catalogs - WbListCat
14.26. List schemas - WbListSchemas
14.27. Change the connection for a script - WbConnect
14.28. Run an XSLT transformation - WbXslt
14.29. Using Oracle's DBMS_OUTPUT package
15. DataPumper
15.1. Overview
15.2. Selecting source and target connection
15.3. Copying a complete table
15.4. Advanced copy tasks
16. Database Object Explorer
16.1. Objects tab
16.2. Table details
16.3. Modifying the definition of database objects
16.4. Table data
16.5. Changing the display order of table columns
16.6. Customize data retrieval
16.7. Customizing the generation of the table source
16.8. View details
16.9. Procedure tab
16.10. Search table data
17. Common problems
17.1. The driver class was not found
17.2. Syntax error when creating stored procedures
17.3. Timestamps with timezone information are not displayed correctly
17.4. Excel export not available
17.5. Out of memory errors
17.6. Display problems when running under Windows®
17.7. High CPU usage when executing statements
17.8. Oracle Problems
17.9. MySQL Problems
17.10. Microsoft SQL Server Problems
17.11. DB2 Problems
17.12. PostgreSQL Problems
17.13. Sybase SQL Anywhere Problems
18. Options dialog
18.1. General options
18.2. Editor options
18.3. Editor colors
18.4. Font settings
18.5. Auto-completion options
18.6. Workspace options
18.7. Options for displaying data
18.8. Options for formatting data
18.9. Options for data editing
18.10. DbExplorer options
18.11. Window Title
18.12. SQL Formatting
18.13. SQL Generation
18.14. External tools
18.15. Look and Feel
19. Configuring keyboard shortcuts
19.1. Assign a shortcut to an action
19.2. Removing a shortcut from an action
19.3. Reset to defaults
20. Advanced configuration options
20.1. Database Identifier
20.2. DBID
20.3. GUI related settings
20.4. Editor related settings
20.5. DbExplorer Settings
20.6. Database related settings
20.7. SQL Execution related settings
20.8. Default settings for Export/Import
20.9. Controlling the log file
20.10. Configure Log4J logging
20.11. Settings related to SQL statement generation
20.12. Customize table source retrieval
20.13. Filter settings
Index