QUERY_PLAN_AS_HTML option

Function

Generates graphical query plans in HTML format for viewing in a Web browser.

Allowed values

ON, OFF

Default

OFF

Scope

DBA permissions are not required to set this option. Can be set temporary for an individual connection or for the PUBLIC group. Takes effect immediately.

Description

QUERY_PLAN_AS_HTML causes graphical query plans to be generated in HTML format.

When you set this option, also set the QUERY_NAME option for each query, so you know which query is associated with the query plan.

Sybase IQ writes the plans in the same directory as the .iqmsg file, in a file named:

user-name_query-name_YYYYMMDD_HHMMSS_query-number.html

For example, if the user DBA sets the temporary option QUERY_NAME to 'Query_1123', a file created on May 18, 2009 at exactly 8:30 a.m. is called DBA_Query_1123_20090518_083000_1.html. The date, time, and unique number are appended to the file name automatically to ensure that existing files are not overwritten.

NoteIf you use this feature, monitor your disk space usage so you leave enough room for your .iqmsg and log files to grow. Enable IQ message log wrapping or message log archiving to avoid filling up your message log file. For details, see “Message log wrapping” in Chapter 1, “Overview of Sybase IQ System Administration” of the System Administration Guide: Volume 1.

QUERY_PLAN_AS_HTML acts independently of the setting for the QUERY_PLAN option. In other words, if QUERY_PLAN_AS_HTML is ON, you get an HTML format query plan whether or not QUERY_PLAN is ON.

This feature is supported with newer versions of many commonly used browsers. Some browsers might experience problems with plans generated for very complicated queries.

See also

“QUERY_PLAN_AFTER_RUN option”

“GRAPHICAL_PLAN function [String]” and “HTML_PLAN function [String]” in Chapter 4, “SQL Functions” in Reference: Building Blocks, Tables, and Procedures