Property: workbench.gui.showmnemonics

Possible values: true, false

Usually the mnemonic (aka. Accelerator) for a menu item is not shown under Windows 2000 or later. It will only be shown, when you press the ALT key. With this settings, this JDK behaviour can be controlled.

Default: true

Property: workbench.print.nativepagedialog

Possible values: true, false

When printing the contents of a table, this settings controls the type of print dialog to be used. The default setting will open the native print dialog of the operating system. If you experience problems when trying to print, set this property to false. SQL Workbench/J will then open a cross-platform print dialog.

Default value: true

Property: workbench.gui.tabs.defaultlabel

When adding a new editor tab, the value of this property will be used to set the new tab's title.

Property: workbench.editor.autocompletion.oracle.public_synonyms

Possible values: true, false

When using auto completion for table columns and table names, Oracle's public synonyms are not included by default. This has two reasons: first, the author believes that public synonyms shouldn't be used (it's just as bad as global variables in programming) and second, Oracle defines a huge number of public synonyms that would make the popup with all available tables very long and hard to use. Setting this property to true, will include public synonyms in the popup. Please refer to filtering synonyms for details on how to filter out unwanted synonyms from this list.

Default value: false

Property: workbench.editor.rectselection.modifier

These properties control the modifier key that needs to be pressed to enable rectangular selections in the editor. Possible values are alt for setting the Alt key as the modifier, or ctrl for setting the Ctrl key as the modifier.

Default value: alt

Property: workbench.file.encoding

Several internal commands use an encoding when writing external text files (e.g. WbExport). If no encoding is specified for those commands, the default platform encoding as reported by the Java runtime system is used. You can overwrite the default encoding that Java assumes by setting this property.

Default value: empty, the Java runtime default is used

Property: workbench.sql.history.maxtextlength

When you execute a SQL statement in the editor, the current content of the editor is put into the history buffer. If you are editing large scripts, this can lead to memory problems. This property controls the max. size of the editor text that is put into the history.

If the current editor text is bigger than the size defined in this property the text is not put into the history.

Default value: 10485760 (10MB)

Property: workbench.clipcreate.includenewline

Possible values: true, false

When creating a Copy code snippet, the newlines inside the editor are preserved by putting a \n character into the String declaration. Setting this property to false, will tell SQL Workbench/J to not put any \n characters into the Java string.

Default: true

Property: workbench.clipcreate.concat

When creating a Copy code snippet, each line is concatenated using the standard + operator. If your programming language uses a different concatenation character (e.g. &), this can be changed with this property.

Default: +

Property: workbench.clipcreate.codeprefix

When creating a Copy code snippet, this is prefixed with String sql = . With this property you can adjust this prefix.

Default: String sql =

Property: workbench.clipcreate.codeend

When creating a Copy code snippet, this character will be appended to the end of the generated code.

Default: ;

Property: workbench.dbexplorer.switchcatalog

When connected to a DBMS that supports multiple databases (catalogs) for the same connection, the DbExplorer displays a dropdown list with the available databases. Switching the selected catalog in the dropdown will trigger a switch of the current catalog/database if the DbExplorer uses its own connection. If you do not want to switch the database, but merely apply the new selection as a filter (which is always done, if the DbExplorer shares the connection with the other SQL panels) set this property to false.

Default: true

Property: workbench.db.objecttype.selectable.[dbid]=value1,value2,...

The DbExplorer makes the "data" tab available based on the type of the selected object in the object list (second column). If the type returned by the JDBC driver is one of the types listed in this property, SQL Workbench/J assumes that it can issue a SELECT * FROM to retrieve data from that object.

Default values:

The values in this property are not case-sensitive (TABLE is the same as table)

You can customize the generated SELECT that is used to display the table data depending on the column type. Please refer to the DbExplorer chapter for details.

Property: workbench.db.[dbid].datatypes.searchable

DbExplorer's "Search table data" feature only includes columns with the datatypes CHAR and VARCHAR into the WHERE clause for searching.

Some database systems allow CLOB columns to be searched using a LIKE expression as well. This property can be used to list all datatypes that can be used in a LIKE condition.

Default values:

Property: workbench.db.[dbid].dbexplorer.use.read_uncommitted

To avoid blocking of the table list retrieval, the isolation level used in the DbExplorer can be switched to READ_UNCOMMITTED for DBMS that support this. This is e.g. necessary for Microsoft SQL Server as an uncommitted DDL statement from a different connection can block the SELECT statement that retrieves the table information.

The isolation level will only be changed if Separate connection per tab is enabled.

For Microsoft SQL Server the timeout waiting for such a lock can be configured as an alternative.

Default values:

Property: workbench.libdir

A directory that contains the .jar files for the JDBC drivers. The value of this property can be referenced using %LibDir% in the driver's definition. The value for this can also be specified on the command line.

No default

If Object info is invoked, this setting controls if dependent objects (indexes, triggers) are also displayed for tables. This setting serves as a default for all DBMS. Displaying dependent objects can also be controlled on per DBMS by adding the DBID to the property key. The value without the DBID serves as a default setting for all DBMS.

Default: false

If Object info is invoked, this setting controls if foreign key constraints are also displayed when dependent objects are displayed for tables. This setting serves as a default for all DBMS. When adding the DBID to the property key this is controlled on a per DBMS level.

Default: false

Property: workbench.datapumper.autoconnect

When opening the DataPumper as a separate window it will connect to the current profile as the source connection. If you do not want the DataPumper to connect automatically set this property to false

Default: true

Property workbench.db.[dbid].ddlneedscommit

Possible values: true, false

Defines if the DBMS supports transactional DDL (CREATE TABLE, DROP TABLE, ...)

Default: false

Property: workbench.db.[dbid].usejdbccommit

Possible values: true, false

Some DBMS return an error when COMMIT or ROLLBACK is sent as a regular command through the JDBC interface. If the DBMS is listed here, the JDBC functions commit() or rollback() will be used instead.

Default: false

Property: workbench.db.[dbid].inlineconstraints

Possible values: true, false

This setting controls the generation of the CREATE TABLE source in the DbExplorer. If a DBMS only supports defining primary and foreign keys inside the CREATE TABLE statement, then this property should be set to true.

Property workbench.db.[dbid].casesensitive

Possible values: true, false

The search panel of the DbExplorer highlights matching values in the result tables. When using the "Server Side Search", the highlighter needs to know whether string comparisons in the database are case sensitive in order to highlight the correct values.

Default: false

Property: workbench.db.updatingcommands for general SQL statements

Property: workbench.db.[dbid].updatingcommands for DBMS specific update statements

When enabling the read only or confirm update option in a connection profile, SQL Workbench/J assumes a default set of SQL commands that will change the database. With this property you can add additional keywords that should be considered as "updating commands". This is a comma separated list of keywords. The keywords may not contain whitespace.

No default

Property: workbench.db.drivers.opentransaction.check

A list of JDBC driver class names that map to databases that support checking for uncommitted changes. If one of these drivers is selected in a connection profile, the option Check for uncomitted changes will be visible in the connection dialog.

To make this option work, a query that counts the number of uncommitted changes needs to be configured as well.

Default: oracle.jdbc.driver.OracleDriver,oracle.jdbc.OracleDriver,org.postgresql.Driver,org.hsqldb.jdbc.JDBCDriver

Property: workbench.db.[dbid].opentransaction.query

A query that can be used to check if the current connection has any uncommitted transactions. The query is expected to return a single row with a single numeric column. If the value is zero, no uncommitted changes are detected. Any number greater than zero means that there is an uncommitted change.

Default: For Oracle, PostgreSQL and HSQLDB, the corresponding queries are configured

Property: workbench.db.[dbid].manual

This defines the URL of the online manual for that DBMS. This URL is shown in the browser when using the menu item: Help → DBMS Manual will display the

You can append a version number after the DBID in the property key, to define different URLs for different DBMS versions. The key workbench.db.microsoft_sql_server.8.manual defines the URL for SQL Server 2000, whereas workbench.db.microsoft_sql_server.10.5.manual defines the URL for SQL Server 2008 R2. The numbers have to be majorversion.minorversion as shown in the "Connection Info" dialog

If the online manuals always have the version information at the same place of the URL, placeholders can be used, and only a single URL is necessary. For PostgreSQL, the following URL is used: workbench.db.postgresql.manual=http://www.postgresql.org/docs/{0}.{1}/static/index.html

Where {0} is replaced with the major version number and the {0} is replaced with the minor version number.

Property: workbench.db.[dbid].exclude.synonyms

The database explorer and the auto completion can display (Oracle public) synonyms. Some of these are usually not of interest to the end user. Therefor the list of displayed synonyms can be controlled. This property defines a regular expression. Each synonym that matches this regular expression, will be excluded from the list presented in the GUI.

Default value (for Oracle): ^AQ\\$.*|^MGMT\\$.*|^GV\\$.*|^EXF\\$.*|^KU\\$_.*|^WM\\$.*|^MRV_.*|^CWM_.*|^CWM2_.*|^WK\\$_.*|^CTX_.*

Note that you need to use two backslashes in the RegeEx.

Property: workbench.db.keyword.current_date

The "literals" that are accepted for DATE columns to identify the current date. Default values are current_date, today

Property: workbench.db.keyword.current_timestamp

The "literals" that are accepted for TIMESTAMP columns to identify the current date/time. Default values are current_timestamp,sysdate,systimestamp

Property: workbench.db.keyword.current_time

The "literals" that are accepted for TIME columns to identify the current time. Default values are current_time, now

Property: workbench.db.[dbid].sql.usesavepoint

Possible values: true, false

Some DBMS (such as PostgreSQL) cannot continue inside a transaction when an error occurs. A script with multiple DML statements can therefor not run completely if one statement fails, even if you choose to ignore the error. If this property is set to true, SQL Workbench/J will set a savepoint before executing a DML statement (SELECT, INSERT. In case of an error the savepoint will be rolled back and the transaction can continue.

Default value: false

Property: workbench.db.[dbid].ddl.usesavepoint

Possible values: true, false

Some DBMS (such as PostgreSQL) cannot continue inside a transaction when an error occurs. A script with multiple DDL statements can therefor not run completely if one statement fails, even if you choose to ignore the error. If this property is set to true, SQL Workbench/J will set a savepoint before executing a DDL statement. In case of an error the savepoint will be rolled back and the transaction can continue.

Default value: false

Property: workbench.db.[dbid].import.usesavepoint

Possible values: true, false

Some DBMS (such as PostgreSQL) cannot continue inside a transaction when an error occurs. When running WbImport in update,insert or insert,update mode, the first of the two statements needs to be rolled back in order to be able to continue the import. If this property is set to true, SQL Workbench/J will set a savepoint before executing the first (insert or update) statement. In case of an error the savepoint will be rolledback and WbImport will try to execute the second statement.

Note that enabling savepoints can drastically reduce the performance of the import.

Default value: false

Property: workbench.db.ignore.readerror

Possible values: true, false

When retrieving data (e.g. using a SELECT statement) errors that are reported by the driver will be displayed to the user. The retrieval will be terminated. If you want to ignore errors and replace the data that could not be retrieved with a NULL value, set this property to true.

Using this parameter is not recommended as it might produce results that do not reflect the data as it is stored in the database.

Default value: false

Property: workbench.db.[dbid].resultset.columns.check.readonly

Possible values: true, false

If this property is enabled, columns in result sets will be checked whether they are marked as read only by the JDBC driver. Read-only columns will not be included in generated DML statements when editing data. If the driver incorrectly reports columns that can be changed as read-only, setting this property to false will enable editing those columns.

Default value: true

Property: workbench.db.[dbid].typemap

When using the -createTarget parameter for WbCopy, the type mapping from the JDBC driver might not be sufficient or correct. With this setting you can define your own type mapping for a specific dbms. The entry is a list of mappings that map the numeric value of a JDBC datatype (as defined in java.sql.Types) to a real data type name for the target DBMS. The numeric JDBC datatype value and the DBMS specific datatype name are separated with a colon. Each pair is separated by a semicolon.

The following entry maps the JDBC datatype with the value 3 (DECIMAL) to the target datatype double and the value 2 (BIGINT) to the target type NUMBER. The NUMBER datatypes needs uses two parameter placeholders $size and $digits. The last mapping maps the JDBC value -1 (LONGVARCHAR) to the DBMS type VARCHAR using only the $size parameter

workbench.db.some_dbid.typemap=3:DOUBLE;2:NUMBER($size,$digits);-1:VARCHAR($size)

JDBC 4.0 defines the following constants:

Property: workbench.db.updatetable.check.pkonly (for all DBMS)

Property: workbench.db.[dbid].updatetable.check.pkonly (will overwrite the DBMS independent configuration)

Possible values: true, false

When changing values directly in the result set, SQL Workbench/J needs to find out which table is being edited. As this process requires multiple requests to the database server in order to support different features during editing this can be time consuming depending on the DBMS being used and the size of the database.

If this property is set to true, only the PK definition will be retrieved, otherwise the full definition of all columns of the table.

When this is enabled, editing results based on statements with multiple tables might not work properly. The option Highlight required fields will also have no effect as no column information will be retrieved for the table. It is also recommended to enable the option Highlight required fields to make sure the correct SQL statements are generated when only the PK information is checked.

Property: workbench.db.pk.retrieval.checkunique (for all DBMS)

Property: workbench.db.[dbid].pk.retrieval.checkunique (will overwrite the DBMS independent configuration)

Possible values: true, false

This property controls the behaviour when no primary key is found when checking the update table. If this is set to true, SQL Workbench/J will use a unique index instead if available. Note that the check for the PK is still done during hte detection of the update table. Using a unique key is only a fallback.

Property: workbench.db.updatetable.check.use.cache (for all DBMS)

Property: workbench.db.[dbid].updatetable.check.use.cache (will overwrite the DBMS independent configuration)

Possible values: true, false

If this is set to true, retrieval of the table's columns, primary key (or unique index) information will be done using the completion cache. This can speed up repeated lookups for the same table(s).

The disadvantage is that when the table definitions are changed this would not be reflected in the cache and thus the PK information used or the generated SQL statements to save the changes might be wrong. It is recommend to enable Confirm result set updates to make sure the generated SQL statements are correct.

Property: workbench.sql.script.inmemory.maxsize

This setting controls the size up to which files that are executed in batch mode or via the WbInclude command are read into memory. Files exceeding this size are not read into memory but processed statement by statement. When a file is not read into memory the automatic detection of the alternate delimiter does not work any longer. The size is given in bytes.

Default: 1048576

Property: workbench.db.ignore.[dbid]

For a DBMS identifier you can define a list of commands that are simply ignored by SQL Workbench/J. This is useful e.g. for Oracle, when you want to run scripts that are intended for SQL*Plus. If those scripts contain special SQL*Plus commands (that are not understood by the Oracle server as SQL*Plus executes these commands directly) they would fail in SQL Workbench/J. If those commands are simply ignored and not send to the server, the scripts can run without modification.

Default: workbench.db.ignore.oracle=quit,exit,whenever,spool,rem,clear,break,btitle,column,change,repheader,repfooter,run,save,store,timing,ttitle

Property: workbench.db.supportshortinclude

By default the WbInclude command can be shortened using the @ sign. This behaviour is disabled for MS SQL to avoid conflicts with parameter definitions in stored procedures. This property contains a list of DBIDs for which this should be enabled. To enable this for all DBMS, simply use * as the value for this property.

Default: oracle, rdb, hsqldb, postgresql, mysql, adaptive_server_anywhere, cloudscape, apache_derby

Property: workbench.db.checksinglelinecmd

When parsing a SQL script, SQL Workbench/J supports statements that are put into a single line without a delimiter. This is primarily intended for compatibility with Oracle's SQL*Plus and is not enabled for other database systems.

Default: oracle

Property: workbench.export.text.default.header

Possible values: true, false

This property controls whether default value for the -header parameter of the WbExport command.

Default: false

Property: workbench.export.xml.default.verbose

Possible values: true, false

This property controls whether XML exports are done using verbose XML or short tags and only basic formatting. This property sets the default value of the -verboseXML parameter for the WbExport command.

Default: true

Property: workbench.import.default.continue

Possible values: true, false

This property controls the default value for the parameter -continueOnError of the WbImport command.

Default: false

Property: workbench.import.default.header

Possible values: true, false

This property controls the default value for the parameter -header of the WbImport command.

Default: true

Property: workbench.import.default.multilinerecord

Possible values: true, false

This property controls the default value for the parameter -multiLine of the WbImport command.

Default: false

Property: workbench.import.default.trimvalues

Possible values: true, false

This property controls the default value for the parameter -trimValues of the WbImport command.

Default: false

Property: workbench.sql.ignoreschema.[dbid]=schema1,...

Define a list of schemas that should be ignored for the DB ID When SQL Workbench/J creates DML statements and the current table is reported to belong to any of the schemas listed in this property, the schema will not be used to qualify the table. To ignore all schemas use a *, e.g. workbench.sql.ignoreschema.rdb=*. In this case, table names will never be prefixed with the schema name reported by the JDBC driver. The values specified in this property are case sensitive.

Note that for Oracle, tables that are owned by the current user will never be prefixed with the owner.

Default values:

Property: workbench.db.[dbid].create.table.[typename]

This defines a complete CREATE TABLE statement that is used by WbCopy to create the target table. The typename value is the value that has to be used for the -tableType parameter of the WbCopy command.

The following placeholders are supported in the template

The placeholder %pk_definition% can be used if the DBMS does not support defining a primary key using an ALTER TABLE on the created table. If this placeholder is present in the template and the table has a primary key, the placeholder will replaced with an appropriate PRIMARY KEY (col1, ...) expression. Note that the template must not contain the needed comma for the PRIMARY KEY. The comma will be added by SQL Workbench/J if a primary key is defined. If the table has no primary key, the placeholder will automatically be removed.

Default values:

Property: workbench.db.[dbid].constraints.systemname

Defines a regular expression to identify system generated constraint names. If a constraint name is identified as being system generated, it is treated as if no name was defined, when e.g. creating the SQL for a table. Whether or not SQL Workbench/J then generates a name for the constraint can be controlled in the options for the DbExplorer.

Default values:

Property: workbench.sql.sync.chunksize

Controls the number of rows that are retrieved from the target table when running WbDataDiff or WbCopy with the -syncDelete=true parameter.

Default value: 25

Property: workbench.db.[dbid].retrieve.create.table.query

This property defines the SQL query that retrieves the DDL for the table. It must be a statement that returns a result set. The statement may contain the following placeholders:

If the SQL returned by the DBMS includes the indexes defined for the table, the property: workbench.db.[dbid].retrieve.create.table.index_included has to be set to true.

Property: workbench.db.[dbid].retrieve.create.table.sourcecol

By default the source code is assumed to be in the first column of the result. If that is not the case this property can be used to define the column index of the result in which the table's source is available. The first column has the index 1.

Property: workbench.db.[dbid].retrieve.create.index.query

This property defines the SQL query that should be executed to retrieve the DDL to re-create the index. It must be a statement that returns a result set. The statement may contain the following placeholders:

Property: workbench.db.[dbid].retrieve.create.index.sourcecol

By default the source code is assumed to be in the first column of the result. If that is not the case this property can be used to define the column index of the result in which the table's source is available. The first column has the index 1.

Property: workbench.gui.filter.mru.maxsize

When saving a filter to an external file, the pick list next to the filter icon will offer a drop down that contains the most recently used filter definitions. This setting will control the maximum size of that drop down.

Default value: 15