com.ibm.pdq.runtime.datasource
Interface EnhancedDataSource
public interface EnhancedDataSourceImplemented by pureQuery data sources. This interface provides methods that enable and control pureQuery functionality.
Method Summary
Modifier and Type | Method and Description |
---|---|
getPdqProperties()
Returns the string of pureQuery properties that was set by using the method
setPdqProperties(String pdqProperties) .
|
|
|
setPdqProperties(String pdqProperties)
Sets the pureQuery properties for this data source.
|
Method Detail
getPdqProperties
String getPdqProperties()
setPdqProperties(String pdqProperties)
. Returns null
if
setPdqProperties(String pdqProperties)
is not invoked. setPdqProperties
void setPdqProperties(String pdqProperties)
pdqProperties
must be a string of the pureQuery properties. The string must be in this format:
property1Key(property1Value),property2Key(property2Value),property3Key(property3Value)
...
Each property must be listed as the property name, followed by the value in parentheses. Properties must be
separated by commas.
The following properties are supported:
- capturedOnly (true|false)
- captureMode (ON|OFF)
- captureStatementBatchSQL (ON|OFF)
- enableDynamicSQLReplacement (true|false)
- maxNonParmSQL (maxNonParameterized-SQL-Integer)
- maxStackTracesCaptured (maxStackTracesCapture-Integer)
- outputPureQueryXml (outputPureQueryXmlFilePath)
- packagePrefixExclusions (multiplePrefixesSeparatedBy|)
- pureQueryXml (pureQueryXmlFilePath)
- stackTraceDepth (maxStackTraceDepth-Integer)
- sqlLiteralSubstitution (NOT_SET|ENABLE|DISABLE)
This example properties string directs pureQuery to capture SQL that is executed by connections that are created by
the data source. The SQL is captured in the capture file C:\directory\captureFile.pdqxml
:
captureMode(ON),pureQueryXml(C:\directory\captureFile.pdqxml)
pureQuery properties can also be specified in a properties file. For each property, pureQuery looks in the following places in the order listed. pureQuery uses the first value that it finds.
- A file named
pdq.appwide.properties
in the classpath of the application - A file named
pdq.
dataSourceName.properties
in the classpath of the application - The string of properties specified to
setPdqProperties(String pdqProperties)
- A file named
pdq.properties
in the classpath that is used to loadpdq.jar
pdqProperties
- A string that contains the pureQuery properties to set for this data source. Each property
must be listed as the property name, followed by the value in parentheses. Properties must separated by
commas.
setPdqProperties(String pdqProperties)
. IfsetPdqProperties(String pdqProperties)
is not invoked, returnsnull
.