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. Show hints for INSERT statements
6.5. Customizing keyword highlighting
6.6. Reformat SQL
6.7. Create SQL value lists
6.8. 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. Macros and text clips
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. DBMS specific features
8.1. PostgreSQL specific features
8.2. Oracle specific features
9. Variable substitution in SQL statements
9.1. Defining variables
9.2. Populate a variable from a SELECT statement
9.3. Populate a variable from a file
9.4. Editing variables
9.5. Using variables in SQL statements
9.6. Prompting for values during execution
10. Using SQL Workbench/J in batch files
10.1. Specifying the connection
10.2. Specifying the script file(s)
10.3. Specifying a SQL command directly
10.4. Specifying a delimiter
10.5. Specifying an encoding for the file(s)
10.6. Specifying a logfile
10.7. Handling errors
10.8. Specify a script to be executed on successful completion
10.9. Specify a script to be executed after an error
10.10. Ignoring errors from DROP statements
10.11. Changing the connection
10.12. Controlling console output during batch execution
10.13. Running batch scripts interactively
10.14. Defining variables
10.15. Setting configuration properties
10.16. Examples
11. Using SQL Workbench/J in console mode
11.1. Entering statements
11.2. Exiting console mode
11.3. Setting or changing the connection
11.4. Displaying result sets
11.5. Running SQL scripts that produce a result
11.6. Controlling the number of rows displayed
11.7. Controlling the query timeout
11.8. Managing connection profiles
12. Export data using WbExport
12.1. Memory usage and WbExport
12.2. Exporting Excel files
12.3. General WbExport parameters
12.4. Parameters for text export
12.5. Parameters for XML export
12.6. Parameters for type SQLUPDATE, SQLINSERT or SQLDELETEINSERT
12.7. Parameters for Spreadsheet types (ods, xslm, xls, xlsx)
12.8. Parameters for HTML export
12.9. Compressing export files
12.10. Examples
13. Import data using WbImport
13.1. General parameters
13.2. Parameters for the type TEXT
13.3. Text Import Examples
13.4. Parameters for the type XML
13.5. Update mode
14. Copy data across databases
14.1. General parameters for the WbCopy command.
14.2. Copying data from one or more tables
14.3. Copying data based on a SQL query
14.4. Update mode
14.5. Synchronizing tables
14.6. Examples
15. Comparing databases
15.1. Compare two database schemas - WbSchemaDiff
15.2. Compare data across databases - WbDataDiff
16. Other SQL Workbench/J specific commands
16.1. Create a report of the database objects - WbSchemaReport
16.2. Search source of database objects - WbGrepSource
16.3. Search data in multiple tables - WbGrepData
16.4. Define a script variable - WbVarDef
16.5. Delete a script variable - WbVarDelete
16.6. Show defined script variables - WbVarList
16.7. Confirm script execution - WbConfirm
16.8. Run a stored procedure with OUT parameters - WbCall
16.9. Execute a SQL script - WbInclude (@)
16.10. Extract and run SQL from a Liquibase ChangeLog - WbRunLB
16.11. Handling tables or updateable views without primary keys
16.12. Change the default fetch size - WbFetchSize
16.13. Run statements as a single batch - WbStartBatch, WbEndBatch
16.14. Extracting BLOB content - WbSelectBlob
16.15. Control feedback messages - WbFeedback
16.16. Setting connection properties - SET
16.17. Changing Oracle session behaviour - SET
16.18. Changing read only mode - WbMode
16.19. Generate DROP statement with dependencies - WbGenerateDrop
16.20. Generate SQL script for database objects - WbGenerateScript
16.21. Show table structure - DESCRIBE
16.22. List tables - WbList
16.23. List stored procedures - WbListProcs
16.24. List triggers - WbListTriggers
16.25. Show the source of a stored procedures - WbProcSource
16.26. List catalogs - WbListCat
16.27. List schemas - WbListSchemas
16.28. Change the connection for a script - WbConnect
16.29. Run an XSLT transformation - WbXslt
16.30. Running operating system commands - WbSysExec
16.31. Using Oracle's DBMS_OUTPUT package
17. DataPumper
17.1. Overview
17.2. Selecting source and target connection
17.3. Copying a complete table
17.4. Advanced copy tasks
18. Database Object Explorer
18.1. Objects tab
18.2. Table details
18.3. Modifying the definition of database objects
18.4. Table data
18.5. Changing the display order of table columns
18.6. Customize data retrieval
18.7. Customizing the generation of the table source
18.8. View details
18.9. Procedure tab
18.10. Search table data
19. Common problems
19.1. The driver class was not found
19.2. Syntax error when creating stored procedures
19.3. Timestamps with timezone information are not displayed correctly
19.4. Excel export not available
19.5. Out of memory errors
19.6. High CPU usage when executing statements
19.7. Oracle Problems
19.8. MySQL Problems
19.9. Microsoft SQL Server Problems
19.10. DB2 Problems
19.11. PostgreSQL Problems
19.12. Sybase SQL Anywhere Problems
20. Options dialog
20.1. General options
20.2. Editor options
20.3. Editor colors
20.4. Font settings
20.5. Auto-completion options
20.6. Workspace options
20.7. Options for displaying data
20.8. Options for formatting data
20.9. Options for data editing
20.10. DbExplorer options
20.11. Window Title
20.12. SQL Formatting
20.13. SQL Generation
20.14. External tools
20.15. Look and Feel
21. Configuring keyboard shortcuts
21.1. Assign a shortcut to an action
21.2. Removing a shortcut from an action
21.3. Reset to defaults
22. Advanced configuration options
22.1. Database Identifier
22.2. DBID
22.3. GUI related settings
22.4. Editor related settings
22.5. DbExplorer Settings
22.6. Database related settings
22.7. SQL Execution related settings
22.8. Default settings for Export/Import
22.9. Controlling the log file
22.10. Configure Log4J logging
22.11. Settings related to SQL statement generation
22.12. Customize table source retrieval
22.13. Filter settings
Index