ISQL Options

From RapidSQL
Jump to: navigation, search

Go Up to Configuring Feature Options

The ISQL options are available on the following Options Editor tabs:

ISQL Options - Main Tab

The Options Editor’s ISQL tab and its sub-tabs control the appearance and behavior of the SQL Editor.

Note: For information on opening the Options Editor, see Specifying Application Preferences and Feature Options.
Note: For information on using the SQL Editor, see Coding Environments/Editors.

Use the following table as a guide to modifying settings on this tab:

Max Errors Before Aborting Execution

Sets the maximum number of errors allowed before aborting the execution of a script. A zero indicates that the option is inactive and that you recognize no limit to the number of errors allowed. This value is used when step executing SQL scripts.

Execute Selected Text

Executes a portion of a selected SQL script.

Check Syntax When Executing

For DB2, required to execute DB2 call statements in the ISQL Window.

Automatically lock connection

When disabled, a prompt to commit or rollback the transaction is displayed when you close the ISQL editor window. Enabling this options disables the prompts and locks the connection automatically.

Prompt to lock database connection

Locks the database connection on execution.

Tabs

Sets the appearance of the ISQL Window tabs to either the top or bottom of the ISQL Window.

File Association

Specifies whether the application should open an unknown file type automatically into an ISQL Window or prompt you with a message that the file type is not recognized.

Query Plan Layout

Sets the default orientation of a graphical query plan. For more information, see Setting up the Execution Environment with Query options.

ISQL Options - Oracle Tab

The Options Editor’s ISQL > Oracle tab controls the appearance and behavior of the SQL Editor when executing against an Oracle environment.

Note: For information on opening the Options Editor, see Specifying Application Preferences and Feature Options.
Note: For information on using the SQL Editor, see Coding Environments/Editors.

Use the following table as a guide to modifying settings on this tab:

Option Description

Enable DBMS Output

Lets you specify Buffer size. 0 is the default.

Auto-Commit changes

Applies auto commit status changes to all open windows.

View xmltype as clob

When enabled, xmltype columns are displayed as CLOBs in the Results grid and the Data editor. Without this option selected, SELECT statements that qualify xmltype columns produce an OciTypeBinder conversion error. With the option selected, the SELECT submitted is modified to include a getclobval() method call.

Retain connection in pool after use

This option determines what happens to a connection after it is unlocked by the ISQL window. If selected, the connection will be returned to the application connection pool. If unselected, the unlocked connection will be disconnected.

Load Query Options

If this option is not enabled, a set of default query options is loaded that customize your execution environment, and periodically sends those settings to the server. Enabling this option and specifying an XML file, forces load of a previously saved query options file each time an ISQL windows opens against this DBMS platform. This lets you override default query options. You can also enable this option when saving a query options file. For information on other load and save options, specific query options offered, manually updating query options, and conditions for which query options are sent to the server, see Setting up the Execution Environment with Query options.

Default Query Plan

Lets you select the default display, whether graphical, tree-based, or DBMS_XPLAN, when you generate a query plan. For more information, see Viewing a Tree-based, Graphical, or DBMS_XPLAN Query Plan (Oracle).

ISQL Options - DB2 Tab

The Options Editor’s ISQL > DB2 tab controls the appearance and behavior of the SQL Editor when executing against aDB2 LUW environment.

Note: For information on opening the Options Editor, see Specifying Application Preferences and Feature Options.
Note: For information on using the SQL Editor, see Coding Environments/Editors.

Use the following table as a guide to modifying settings on this tab:

Option Description

Set Isolation Level

Sets the default for the value of the Isolation Level option on the Query Options dialog. For details, see Setting up the Execution Environment with Query options.

Auto-Commit changes

Applies auto commit status changes to all open windows.

Create Explain plan tables if required

If set to TRUE, Explain Plan tables are created, as necessary. If set to FALSE and you don’t manually create tables, Explain Plan operations will fail.

Create explain plan tables on the SYSTOOLS schema

If set to TRUE, Explain Plan tables are created on the SYSTOOLS schema. If the tables already exist in the user’s default schema, those tables continue to be used. Refer to DB2 documentation for a listing of Explain Plan tables that must be deleted in order to use the SYSTOOLS option. If set to FALSE, Explain Plan tables are created under the user’s default schema.

Retain connection in pool after use

This option determines what happens to a connection after it is unlocked by the ISQL window. If selected, the connection will be returned to the application connection pool. If unselected, the unlocked connection will be disconnected.

Load Query Options

If this option is not enabled, a set of default query options is loaded that customize your execution environment, and periodically sends those settings to the server. Enabling this option and specifying an XML file, forces load of a previously saved query options file each time an ISQL windows opens against this DBMS platform. This lets you override the default query options. You can also enable this option when saving a query options file. For information on other load and save options, specific query options offered, manually updating query options, and conditions for which query options are sent to the server, see Setting up the Execution Environment with Query options.

ISQL Options - Sybase Tab

The Options Editor’s ISQL > Sybase tab controls the appearance and behavior of the SQL Editor when executing against a Sybase ASE environment.

Note: For information on opening the Options Editor, see Specifying Application Preferences and Feature Options.
Note: For information on using the SQL Editor, see Coding Environments/Editors.

Use the following table as a guide to modifying settings on this tab:

Option Description

Auto-Commit changes

Applies auto commit status changes to all open windows.

Retain connection in pool after use

This option determines what happens to a connection after it is unlocked by the ISQL window. If selected, the connection will be returned to the application connection pool. If unselected, the unlocked connection will be disconnected.

Load Query Options

If this option is not enabled, a set of default query options is loaded. That set of query options customize your execution environment, and periodically sends those settings to the server. Enabling this option and specifying an XML file, forces load of a previously saved query options file each time an ISQL windows opens against this DBMS platform. This lets you override the default query options. You can also enable this option when saving a query options file. For information on other load and save options, specific query options offered, manually updating query options, and conditions for which query options are sent to the server, see Setting up the Execution Environment with Query options.

ISQL Options - Sybase IQ Tab

The Options Editor’s ISQL > Sybase IQ tab controls the appearance and behavior of the SQL Editor when executing against a Sybase IQ environment.

Note: For information on opening the Options Editor, see Specifying Application Preferences and Feature Options.
Note: For information on using the SQL Editor, see Coding Environments/Editors.

Use the following table as a guide to modifying settings on this tab:

Option Description

Enable Set Query Options

Sets the default value of the Send Set Options setting on the Query Options dialog. For details, see Setting up the Execution Environment with Query options. Changing this value does not affect ISQL sessions currently open.

Auto-Commit changes

Applies auto commit status changes to all open windows.

Retain connection in pool after use

This option determines what happens to a connection after it is unlocked by the ISQL window. If selected, the connection will be returned to the application connection pool. If unselected, the unlocked connection will be disconnected.

Load Query Options

If this option is not enabled, a set of default query options is loaded. That set of options customize your execution environment, and periodically sends those settings to the server. Enabling this option and specifying an XML file, forces load of a previously saved query options file each time an ISQL windows opens against this DBMS platform. This lets you override the default query options. You can also enable this option when saving a query options file. For information on other load and save options, specific query options offered, manually updating query options, and conditions for which query options are sent to the server, see Setting up the Execution Environment with Query options.

ISQL Options - SQL Server Tab

The Options Editor’s ISQL > SQL Server tab controls the appearance and behavior of the SQL Editor when executing against a SQL Server environment.

Note: For information on opening the Options Editor, see Specifying Application Preferences and Feature Options.
Note: For information on using the SQL Editor, see Coding Environments/Editors.

Use the following table as a guide to modifying settings on this tab:

Option Description

Enable Set Query Options

Sets the default value of the Send Set Options setting on the Query Options dialog. For details, see Setting up the Execution Environment with Query options. Changing this value does not affect ISQL sessions currently open.

Auto-Commit changes

Applies auto commit status changes to all open windows.

Retain connection in pool after use

This option determines what happens to a connection after it is unlocked by the ISQL window. If selected, the connection will be returned to the application connection pool. If unselected, the unlocked connection will be disconnected.

Load Query Options

If this option is not enabled, a set of default query options is loaded. That set of options customize your execution environment, and periodically sends those settings to the server. Enabling this option and specifying an XML file, forces load of a previously saved query options file each time an ISQL windows opens against this DBMS platform. This lets you override the default query options. You can also enable this option when saving a query options file. For information on other load and save options, specific query options offered, manually updating query options, and conditions for which query options are sent to the server, see Setting up the Execution Environment with Query options.

ISQL Options - MySQL Tab

The Options Editor’s ISQL > MySQL tab controls the appearance and behavior of the SQL Editor when executing against a MySQL environment.

Note: For information on opening the Options Editor, see Specifying Application Preferences and Feature Options.
Note: For information on using the SQL Editor, see Coding Environments/Editors.

Use the following table as a guide to modifying settings on this tab:

Option Description

Retain connection in pool after use

This option determines what happens to a connection after it is unlocked by the ISQL window. If selected, the connection will be returned to the application connection pool. If unselected, the unlocked connection will be disconnected.

Load Query Options

If this option is not enabled, a set of default query options is loaded. That set of options customizes your execution environment, and periodically sends those settings to the server. Enabling this option and specifying an XML file, forces load of a previously saved query options file each time an ISQL windows opens against this DBMS platform. This lets you override the default query options. You can also enable this option when saving a query options file. For information on other load and save options, specific query options offered, manually updating query options, and conditions for which query options are sent to the server, see Setting up the Execution Environment with Query options.

ISQL Options - DB2 OS390 Tab

The Options Editor’s ISQL > DB2 OS390 tab controls the appearance and behavior of the SQL Editor when executing against a DB2 z/OS environment.

Note: For information on opening the Options Editor, see Specifying Application Preferences and Feature Options.
Note: For information on using the SQL Editor, see Coding Environments/Editors.

Use the following table as a guide to modifying settings on this tab:

Option Description

Retain connection in pool after use

This option determines what happens to a connection after it is unlocked by the ISQL window. If selected, the connection will be returned to the application connection pool. If unselected, the unlocked connection will be disconnected.

Load Query Options

If this option is not enabled, a set of default query options is loaded. That set of options customizes your execution environment, and periodically sends those settings to the server. Enabling this option and specifying an XML file, forces load of a previously saved query options file each time an ISQL windows opens against this DBMS platform. This lets you override the default query options. You can also enable this option when saving a query options file. For information on other load and save options, specific query options offered, manually updating query options, and conditions for which query options are sent to the server, see Setting up the Execution Environment with Query options.

ISQL Options - InterBase Tab (Rapid SQL)

The Options Editor’s ISQL > InterBase tab controls the appearance and behavior of the SQL Editor when executing against an InterBase/Firebird environment.

Note: For information on opening the Options Editor, see Specifying Application Preferences and Feature Options.
Note: For information on using the SQL Editor, see Coding Environments/Editors.

Use the following table as a guide to modifying settings on this tab:

Option Description

Retain connection in pool after use

This option determines what happens to a connection after it is unlocked by the ISQL window. If selected, the connection will be returned to the application connection pool. If unselected, the unlocked connection will be disconnected.

Load Query Options

If this option is not enabled, a set of default query optionsis loaded. That set of options customizes your execution environment, and periodically sends those settings to the server. Enabling this option and specifying an XML file, forces load of a previously saved query options file each time an ISQL windows opens against this DBMS platform. This lets you override the default query options. You can also enable this option when saving a query options file. For information on other load and save options, specific query options offered, manually updating query options, and conditions for which query options are sent to the server, see Setting up the Execution Environment with Query options.

ISQL Options - Teradata Tab

The Options Editor’s ISQL > Teradata tab controls the appearance and behavior of the SQL Editor when executing against a Teradata environment.

Note: Teradata datasources support is intended as a technical preview. Minimal functionality is provided. For information on technical previews, see the Read Me at http://docs.embarcadero.com.
Note: For information on opening the Options Editor, see Specifying Application Preferences and Feature Options.
Note: For information on using the SQL Editor, see Coding Environments/Editors.

Use the following table as a guide to modifying settings on this tab:

Option Description

Retain connection in pool after use

This option determines what happens to a connection after it is unlocked by the ISQL window. If selected, the connection will be returned to the application connection pool. If unselected, the unlocked connection will be disconnected.

Load Query Options

If this option is not enabled, a set of default query options is loaded. That set of options customizes your execution environment, and periodically sends those settings to the server. Enabling this option and specifying an XML file, forces load of a previously saved query options file each time an ISQL windows opens against this DBMS platform. This lets you override the default query options. You can also enable this option when saving a query options file. For information on other load and save options, specific query options offered, manually updating query options, and conditions for which query options are sent to the server, see Setting up the Execution Environment with Query options.

ISQL Options - Editor Tab

The Options Editor’s ISQL > Editor tab controls the appearance and behavior of the SQL Editor window.

Note: For information on opening the Options Editor, see Specifying Application Preferences and Feature Options.
Note: For information on using the SQL Editor, see Coding Environments/Editors.

The table below describes the options and functionality on the Editor tab:

Group Option Description Default

Window

Show Toolbar and Show Status Bar

Enables/disables these ISQL Window user interface elements.

Selected

Maximize on new or open

Indicates that the ISQL Editor window should be maximized on opening. If you already have an active MDI Window that is maximized, the default behavior is to maximize a new child window. To deactivate this option, ensure you do not have any active MDI Windows.

Selected

File Tracking

Indicates that the ISQL Editor should use the File Tracking Facility to monitor the status of a file. If a file has been modified and saved outside the application, the application loads the most current version of the file into the IISQL Editor based on the options set for Auto-Reload File (see above.)

Selected

Auto-Reload File

If File Tracking is enabled, indicates that the application should automatically reload a file that has been externally modified without prompting you. If you turn this option off, you are prompted before reloading your file if external changes have been saved.

Not selected

Auto-Save File

Indicates that files in the ISQL Editor should automatically be saved at the indicated time interval. Backup files are saved to:

In Rapid SQL, %APPDATA%\RapidSQL\Backup\.

Backup files use a naming convention of the form ~ETxxxx.tmp.. For a listing of backup file names and the path of the file to which they correspond, see the registry key:


In Rapid SQL, HKEY_CURRENT_USER\Software\IDERA\RapidSQL\version\Backup

Selected (5 minutes)

Command History

Save File Before Overwriting

Specifies the action you want the application to take when selecting a command from the Command History box. You have the option to be reminded to save a file before overwriting (Ask First), to automatically save a file before overwriting (Always), or to automatically overwrite the file with the command (Never).

Ask First

Save Most Recent

Specifies the number of commands you want to save in the Command History list in the top of the ISQL Window toolbar. The maximum value is 99.

15

Printing

Lets you select common printer options.

Appearance

Enable Syntax Highlighting

Sets syntax highlighting on so that all keywords and comments are colored for easier reading and debugging.

Selected

Show Line Numbers

Places line numbers in the left column of an ISQL Window.

Selected

Enable Outlining

Enables and disables outlining.

Selected

Enable Text Wrapping

Enables and disables a typical text wrap feature.

Selected

Editor Font

Sets the font face, style, and size displayed in the editor.

Available

Syntax Colors

Sets syntax coloring for keywords, comments, quotes, and default text for various file types and scripts from the Syntax Coloring dialog.

Available

Formatting

Auto Indent

Sets automatic indentation for each carriage return, new line in your SQL script.

Selected

Expand Tabs and Tab Size

Sets tabs as the specified number of spaces in result sets.

Selected (4)

Clipboard Line Endings

None

When copying text from the editor, no substitution is made for end-of-line characters. This provides the fastest cut and paste operation.

Selected

Line Endings

When copying text from the editor, end-of-line characters are replaced with platform-specific equivalents (Windows - CR LF, UNIX - LF, Macintosh - CR). This lets you copy text into environments such as Notepad, that require platform-specific end-of-line characters. This option avoids unnecessary characters and incorrect display, but cut-and-paste operations take more time to complete.

ISQL Options - Auto format Tab

After opening the Options editor, you can make changes to the Auto Format tab. of the ISQL pane.

The Options Editor’s ISQL > Auto Format tab lets you specify the style and spacing of SQL statements in an ISQL window when you choose to auto format SQL in the ISQL editor.

Note: For information on opening the Options Editor, see Specifying Application Preferences and Feature Options.
Note: For information on using the SQL Editor, see Coding Environments/Editors.

On opening, the Preview area shows an SQL statement formatted according to the current Auto Format settings. Click Edit to open the Auto Format Options dialog. Use the following table as a guide to understanding and modifying the settings in this dialog:

Setting Description

Keywords

Lets you select a character case (UPPERCASE, LOWERCASE, INITIALCAPS, or NOCHANGE) formatting treatment for SQL keywords.

Right Margin

Specifies the maximum number of characters per line.

New line before keyword

If enabled, a new line is forced before every SQL keyword. If disabled, lines are only forced for statement type and clause type keywords.

BEGIN..END block

If enabled, empty BEGIN..END blocks occupy a single line.

Stack lists

If enabled, a new line and indenting is forced for each item in comma-separated list such as argument lists.

List indent size

If Stack lists is enabled, this control lets you specify the number of spaces each list item will be indented from the current offset.

Parenthesis indent size

Lets you specify the number of indenting spaces for forced lines following an open parenthesis.

Conditions format style

Specifies how conditions in clauses are formatted: CONDITIONS_WRAPPED - lines are not forced before conditions. CONDITIONS_STACKED_WITH_LEADING_OPERATORS - a new line is forced for each condition in a clause, with logical operators, if present for a line, displayed at the start of the line. CONDITIONS_STACKED_WITH_TRAILING_OPERATORS - a new line is forced for each condition in a clause, with logical operators, if present for a line, displayed at the end of the line.

Conditions stack threshold

For Conditions format style selections that specify stacking, this value specifies the minimum number of conditions that must appear in a clause before conditions are stacked.

THEN statements

If enabled, simple THEN clauses are kept to a single line.

ISQL Options - Code Assist Tab

Code assist options are available on the following tabs:

ISQL Options - Code Assist - Main Tab

The Options Editor’s ISQL > Code Assist tab lets you activate and select options for coding assistance and error-detection features available from the ISQL editor:

  • Code Complete : lets you insert or replace object names, selected from suggestion lists, as you edit a script. For more information, see Code Complete.
  • Semantic validation: detects object name references to objects not present in the datasource index. For more information, see Semantic Validation.
  • Real-time syntax checking: on-the-fly syntax checking is performed as you type. For more information, see Syntax Checking.
  • Hyperlinks: lets you invoke object actions against objects referenced in a script. For more information, see Hyperlink Object Actions.
  • Object metadata display: lets you view Connect server metadata for referenced objects. For details, see Viewing IDERA Team Server 2016 Model Metadata in the SQL Editor.

The ISQL - Code Assist tab has the following settings:

Group/Option Description

Code Complete

Enable Code Complete

Lets you enable or disable the Code Complete feature. When disabled, Code Complete cannot be invoked automatically or manually.

Because of the overhead in maintaining internal resources used in implementing this feature, a slight performance increase can result from disabling the feature.

Enable auto-activation and Auto-activation delay

When auto-activation is disabled, the Code Complete feature must be invoked manually. When auto-activation is enabled, the Code Complete feature is invoked automatically each time the interval between keystrokes exceeds the specified Auto-activation delay.

Insert single proposals automatically

Specifies that if a Code Complete suggestion list would contain only a single suggestion, that suggestion is inserted automatically.

Fully qualify completions automatically

Specifies that Code Complete results are returned fully qualified, rather than the minimum required to identify the object.

Code Validation

Enable Real-time syntax checking

If enabled, syntax-checking is performed as you type. If disabled, syntax checks must be initiated manually.

Severity levels for semantic validation problems

Lets you select the severity level (ERROR, WARNING, or IGNORE) associated with detected semantic errors. The WARNING option provides a contrast to syntax errors, which are always flagged with a severity level of ERROR.The IGNORE setting disables the feature. For more information, see Semantic Validation.

Perform syntax and semantic validation on files smaller than

Places an upper limit on the size of files for which automatic syntax checking and semantic validation are active.

DB Action Menu

Enable DBAction menu in the editor

Enables the Hyperlinks feature.

Show DB Actions in submenu

If unselected, Hyperlink menu actions are available as first level options in the context menu. If selected, Hyperlink menu actions are available as a DB Actions submenu.

Key used in conjunction with right-mouse

Lets you select the key (CTRL, SHIFT, or CTRL+SHIFT) used in conjunction with right-clicking, that activates the object action menu against a supported object type reference in a script. The default keystroke combination is CTRL+right-click.

Metadata

Enables display/use of metadata for referenced objects, obtained from a Connect server repository, in the following user interface elements: tooltips, window gutter, and code complete proposals. You can also have metadata added as comments when formatting code. For detailed information on setting up and using this feature, see Viewing IDERA Team Server 2016 Model Metadata in the SQL Editor.

Performance

Enables/disables the ISQL Performance feature. For more information see ISQL Performance.

Cache lifespan in minutes

Allows you to select the update timing for the ISQL Performance feature. ISQL performance updates the cache information with the sample rate selected. For more information, see ISQL Performance.

Restore defaults

Restores all settings on the tab to the original defaults.

Note: For information on opening the Options Editor, see Specifying Application Preferences and Feature Options.
Note: For information on using the SQL Editor, see Coding Environments/Editors.

ISQL Options - Code Assist - Advanced Tab

Coding assistance and error detection features such as Hyperlink object actions, Code Complete, and Semantic Validation rely on:

  • Parsing of SQL entered in the SQL Editor into keywords, object name references, data, and so on
  • A database object index generated for a connected datasource. On the first connection to a datasource, an index of specified object types is generated, with an imposed, configurable, upper limit on the number of objects contained in the index. On each subsequent connection, the index is updated to reflect any additions or changes on the datasource.
Note: The object index is stored in a persistent database with a database path of %TEMP%. With that in mind, the index may be deleted by the system administrator or automated administration-related processes.
When coding assistance and error detection features are enabled, the index is queried for the names of objects referenced in your scripts queries. This information is then used for tasks such as recognizing object types, detecting misspelled object names, and populating suggestion lists.

The Options Editor’s ISQL > Code Assist > Advanced tab lets you force parsing, if required, and customize how the index is generated. Since there is performance overhead associated with generation and usage of the index, you can control the properties and usage of the index.

Note: For information on opening the Options Editor, see Specifying Application Preferences and Feature Options.

The table below describes the options and functionality on the ISQL > Code Assist > Advanced Tab of the Options Editor:

Option Description

Scan entire file for context

This control is enabled only if the ISQL > Code Assist tab’s Enable Real-time syntax checking check box is deselected and the Severity levels for semantic validation problems is set to IGNORE. When this control is enabled, SQL Editor content continues to be parsed. That is, if you have disabled real-time syntax checking and effectively disabled semantic validation, you can still use the Hyperlinks feature.

Limit scanning to files smaller than

Lets you place an upper limit on the size of files parsed for Code Assist features.

Object types to be indexed

Lets you select specific object types (aliases, synonyms, functions, packages, procedures, tables, or views) that will be included in the object index. While this can be used to reduce the index size and therefore improve performance, Hyperlinks, Semantic Validation, and Code Complete functionality associated with object types not included in the index will not be available.

Recycle cache space when index size exceeds

This imposes a soft ceiling on the number of objects stored in the index. After updating the index on connection to a datasource, the total number of objects in the index is compared to this value. If the value is exceeded, the oldest definitions are deleted.

The maximum number of results to return when querying the object index

Specifies the number of results when querying against the cache databases, to improve performance when working with large databases. This limit is applied per object type.

Refresh

Each time you open an ISQL editor window, schema information for the object types supported is obtained for the Code Complete and Semantic Validation features. That information is updated with any modifications that you make and persists until the window is closed. The Refresh button ensures that the information is current in case other users or applications are modifying the schema while the current SQL editor session window is open.

Personal tools