pureQuery keywords supported by CLI applications

When you enable a CLI application with pureQuery client optimization, you configure the pureQuery client optimization by specifying keywords and values in the application configuration file.
The following table lists the pureQuery Runtime properties that can be used with CLI applications as CLI keywords. Not all pureQuery Runtime properties are supported by CLI application that are enabled with pureQuery client optimization.
Table 1. pureQuery properties supported by CLI enabled with pureQuery client optimization
Property Description
allowDynamicSQL Specifies whether to allow an application to run dynamically any SQL statements that are not captured in a pureQueryXML file or that are captured but not bound.
capturedOnly Specifies whether to run only the SQL statements that are in the pureQueryXML file.
captureMode Specifies whether to capture information about SQL statements.
enableDynamicSQLReplacement Specifies whether to run alternative SQL statements that were added to a pureQueryXML file and both the original statements and the alternative statements were not bound.
executionMode Specifies whether to run statically the SQL statements that have been previously captured and stored by pureQuery Runtime.
maxNonParmSQL Specifies the maximum number of non-parameterized SQL statements to capture. This option applies only when the value of captureMode is ON. When captureMode is OFF, pureQuery ignores this parameter.
propertiesGroupId Specifies a runtime group ID in a repository that is created in a database. pureQuery Runtime uses the runtime group ID and the connection information that specifies the repository to retrieve pureQuery runtime configuration and pureQueryXML file information.
pureQueryXml Specifies the fully-qualified or relative path to and name of a file that is to be created by the process of capturing SQL statements or that already exists as a result of that process.
pureQueryXmlRepository Specifies the repository that contains the pureQueryXML file data that is used with a CLI application enabled with pureQuery client optimization.
repositoryRequired Specifies the pureQuery client optimization behavior if errors occur during retrieving pureQuery data. If the pureQuery runtime properties and pureQueryXML data cannot be retrieved from the location specified by the pureQueryXmlRepository property.
sqlLiteralSubstitution Specifies whether to perform literal substitution. pureQuery Runtime attempts to replace literal values in SQL statements with parameter markers and run the parameterized versions of the statements.
traceFile Specifies the file to write the log into. You can use an absolute path or a path that is relative to the directory in which the pureQuery Log utility runs.
traceLevel Specifies the level of detail to write to the log file.

Usage notes

  • pureQuery Runtime keywords can be specified as an application connection property, in db2cli.ini file, or in a dsdriver.cfg file. If a keyword is specified in multiple locations, the order of precedence from highest to lowest is as follows:
    • Application connection property
    • db2cli.ini file
    • dsdriver.cfg file
  • pureQuery Runtime checks for a valid pureQuery license if any of the pureQuery Runtime keywords are specified in a configuration file. If the valid pureQuery license is not found, pureQuery Runtime ends and returns the error code SQL8029N.
  • pureQuery Runtime checks the following keywords in a CLI application environment. If the keywords are not set to their default values and pureQuery Runtime determines that a pureQueryXML file is required:
    • capturedOnly
    • captureMode
    • enableDynamicSQLReplacement
    • executionMode
  • If a pureQueryXML file is required but not specified, pureQuery Runtime throws the error CLI0124E Invalid argument value. SQLSTATE=S1009

Feedback