QUERY_PLAN_AS_HTML_DIRECTORY Option

Allowed Values

String containing a directory path name

Default

'' (the empty string)

Scope

Can be set temporary for an individual connection or for the PUBLIC group. DBA authority is required to set the option. Takes effect immediately.

Description

When the QUERY_PLAN_AS_HTML option is turned ON and a directory is specified with the QUERY_PLAN_AS_HTML_DIRECTORY option, Sybase IQ writes the HTML query plans in the specified directory. This option provides additional security by allowing HTML query plans to be produced outside of the server directory. When the QUERY_PLAN_AS_HTML_DIRECTORY option is not used, the query plans are sent to the default directory (the .iqmsg file directory).

If the QUERY_PLAN_AS_HTML option is ON and QUERY_PLAN_AS_HTML_DIRECTORY is set to a directory that does not exist, Sybase IQ does not save the HTML query plan and no error is generated. In this case, the query continues to run and a message is logged to the IQ message file, so the DBA knows that the HTML query plan was not written. If the specified directory path or permissions on the directory are not correct, the message Error opening HTML Query plan: file-name is written in the .iqmsg file.

Example

Create the example directory /system1/users/DBA/html_plans and set the correct permissions on the directory. Then set the options and run the query:

SET TEMPORARY OPTION QUERY_PLAN_AS_HTML = ‘ON’;
SET TEMPORARY OPTION QUERY_PLAN_AS_HTML_DIRECTORY = ‘/system1/users/DBA/html_plans’;
SELECT col1 FROM tab1;

The HTML query plan is written to a file in the specified directory /system1/users/DBA/html_plans.