pureQuery Runtime property support in application environments

Summary of supported properties when pureQuery Runtime is used by applications that incorporate the pureQuery API, pureQuery client optimization, or call level interface (CLI).
The following table lists the pureQuery Runtime properties and the supported application environments.
Table 1. The pureQuery properties and supported application environments
Property Description Java applications with the pureQuery API4 Java applications with pureQuery client optimization CLI applications with pureQuery client optimization
allowDynamicSQL1 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.   X X
capturedOnly2 Specifies whether to run only the SQL statements that are in the pureQueryXML file. X X X
captureMode Specifies whether to capture information about SQL statements and the type of information to capture. X X X
captureStatementBatchSQL Specifies whether to capture SQL DML statements that the application passes to a Statement.addBatch() method, up to the number of SQL statements (not including SELECT statements) that is specified by the maxNonParmSQL property. X X  
com.ibm.pdq (pureQuery component log properties) Specifies the log level setting for various pureQuery components. X X  
dumpLogsOnSqlCodes If log records are being stored in memory, this property specifies the SQL error codes that trigger writing the records to the log file. X X  
dumpLogsExcludingSqlCodes If log records are being stored in memory, this property specifies the SQL error codes that do not trigger writing the records to the log. This property is used with the property dumpLogsOnSqlCodes. X X  
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. X X X
executionMode Specifies whether to run statically the SQL statements that have been previously captured and stored by pureQuery Runtime. X X X
finalRepositoryProperties Specifies the location of the pureQuery properties used with a pureQuery-enabled application.   X  
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. X X X
maxResultRow Specifies the maximum number of rows that a statement returns in query results. X    
maxStackTracesCaptured Specifies the maximum number of stack traces that are recorded for the definition point and the execution point for each SQL statement that you capture. X X  
outputPureQueryXml Specifies a fully-qualified or relative path to and name of the file or files that the process of capturing SQL statements creates. X X  
outputXmlRepository Specifies a database that contains a repository. The repository stores captured SQL data from an application enabled for pureQuery client optimization.   X  
packagePrefixExclusions Specifies a pipe-separated list of domains and subdomains of the Java packages that you do not want to include in stack traces. X X  
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 either store SQL data captured from an application, or to retrieve pureQuery runtime configuration and pureQueryXML file information.   X X
propertiesRefreshInterval Specifies the duration, in minutes, to wait before pureQuery client optimization checks the location of stored pureQuery data for changes to pureQuery properties or pureQueryXML data. When updates have been detected, pureQuery client optimization retrieves the updated pureQuery runtime properties and pureQueryXML data and uses the updated information.   X  
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. X X X
pureQueryXmlRepository Specifies the repository that contains the pureQueryXML file data that is used with a CLI application enabled with pureQuery client optimization.     X
queryTimeoutInSeconds The number of seconds to wait for the SQL statement to run. X    
repositoryRequired Specifies the pureQuery client optimization behavior if errors occur during retrieving or writing pureQuery data. If the pureQuery runtime properties and pureQueryXML data cannot be retrieved from the location specified by the finalRepositoryProperties property, or if the repository that stores captured SQL is not accessible.   X X
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. X X X
stackTraceDepth Specifies the maximum number of stack trace entries that are recorded for each SQL statement. These entries are recorded in the pureQueryXML file. X X  
traceBufferRowCount Specifies the number of trace information log records that are buffered in memory. X X  
traceFile3 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. X X X
traceLevel3 Specifies the level of detail to write to the log file. X X X
Note:
  1. Property applies only when the value of the executionMode property is STATIC.
  2. The value of the capturedOnly property cannot be set to TRUE when you are capturing SQL statements.
  3. The pureQuery Runtime properties traceFile and traceLevel can only be specified in a global pdq.properties file. For information about global properties files, see Scope of pureQuery Runtime properties in a WebSphere Application Server environment.
  4. pureQuery properties can be used with the pureQuery EnhancedDataSource interface or the DataFactory class.
    com.ibm.pdq.runtime.datasource Interface EnhancedDataSource
    capturedOnly
    captureMode
    captureStatementBatchSQL
    enableDynamicSQLReplacement
    maxNonParmSQL
    maxStackTracesCaptured
    outputPureQueryXml
    packagePrefixExclusions
    pureQueryXml
    stackTraceDepth
    sqlLiteralSubstitution
    com.ibm.pdq.runtime.factory.DataFactory
    executionMode
    queryTimeoutInSeconds
    maxResultRows

Feedback