Substring Index Configuration Properties
The following table describes the configuration properties available for optimizing substring indexes. Many of these properties can be specified as attributes on either the configuration element or an individual subStringIndex element. Unless a property is explicitly specified on a subStringIndex element, the property value on the configuration element is automatically inherited.
|
Property
|
Description
|
Default
|
Attribute On Element
|
||
|---|---|---|---|---|---|
|
attributeName
|
Specifies the source attribute name as found in the Javadoc.
|
subStringIndex
|
|||
|
caseSensitive
|
Indicates if the substring index is case-sensitive. If true, then the substring index storage preserves case. If false, then the data is stored for better efficiency with case insensitive searches. If false, case-sensitive searches still use the substring index, but they may not perform as well. This property should be set based on the most common usage at your site.
|
true
|
subStringIndex and configuration
|
||
|
className
|
Specifies the fully qualified class name of the source attribute as found in the Javadoc.
|
subStringIndex
|
|||
|
configurationReloadInterval
|
Specifies the schedule interval in number of periods for reloading the substring index configuration.
|
3
|
configuration
|
||
|
enabled
|
Indicates if this substring index is enabled.
|
true
|
subStringIndex
|
||
|
indexLength
|
Specifies the number of substring columns that should be indexed.
|
4
|
subStringIndex and configuration
|
||
|
indexStorageSize
|
Specifies the size storage for index schema objects. If blank, then no index storage clause is used.
This property only applies to Oracle databases.
|
1M
|
subStringIndex and configuration
|
||
|
indexTableName
|
Specifies the index schema object table name. If blank, then a name is derived from the source attribute.
|
subStringIndex
|
|||
|
indexTableSpaceName
|
Specifies the tablespace (or filegroup) name for index schema objects. If blank, then no tablespace clause is used.
|
INDX
|
subStringIndex and configuration
|
||
|
joinLimit
|
Specifies a limit on the number of joins that are included for expressions that use the substring index.
As the number of joins increases, both the performance and potential optimization benefits decrease. Therefore, a limit on the number of joins can be enforced.
|
4
|
subStringIndex and configuration
|
||
|
preQueryLimit
|
Specifies a limit on the number of substring index rows that are processed if a pre-query is used. This property only applies if usePreQuery is set to true.
|
900
|
subStringIndex and configuration
|
||
|
scheduleSynchronizeFullInsertInterval
|
Specifies a scheduling interval in number of periods for synchronizing data from a source attribute to a substring index.
The full source table is queried to find newly inserted objects that do not yet exist in the substring index. Data is added to the substring index as necessary.
Used for scheduled background queue processing synchronization.
|
50
|
subStringIndex and configuration
|
||
|
scheduleSynchronizeFullRemoveInterval
|
Specifies a scheduling interval in number of periods for synchronizing data from a source attribute to a substring index.
The full substring index is queried to find orphaned data that no longer exists in the source table. Any orphaned rows are deleted from the substring index.
Used for scheduled background queue processing synchronization.
|
40
|
subStringIndex and configuration
|
||
|
scheduleSynchronizeFullUpdateInterval
|
Specifies a scheduling interval in number of periods for synchronizing data from a source attribute to a substring index.
The full source table is queried to find updated objects that exist in the substring index where the source attribute and substring index values are different. Data is updated in the substring index as necessary.
Used for scheduled background queue processing synchronization.
|
50
|
subStringIndex and configuration
|
||
|
scheduleSynchronizeRecentInsertInterval
|
Specifies a scheduling interval in number of periods for synchronizing data from a source attribute to a substring index.
Recent data from the source table is queried to find newly inserted objects that do not yet exist in the substring index. Data is added to the substring index as necessary. The filtering to find only recent data is based on the last time that this processing occurred.
Used for scheduled background queue processing synchronization.
|
2
|
subStringIndex and configuration
|
||
|
scheduleSynchronizeRecentUpdateInterval
|
Specifies a scheduling interval in number of periods for synchronizing data from a source attribute to a substring index.
Recent data from the source table is queried to find updated objects existing in the substring index where the source attribute and substring index values are different. Data is updated in the substring index as necessary. The filtering to find only recent data is based on the last time that this processing occurred.
Used for scheduled background queue processing synchronization.
|
1
|
subStringIndex and configuration
|
||
|
synchronizationSchedulePeriod
|
Specifies a scheduling period in seconds for synchronizing data from a source attribute to a substring index.
Used for scheduled background queue processing synchronization.
|
300
|
configuration
|
||
|
synchronizeOnInsert
|
Indicates that the source data should be synchronized with the substring index when the source object is inserted.
Used for event-driven synchronization.
|
false
|
subStringIndex and configuration
|
||
|
synchronizeOnRemove
|
Indicates that the source data should be synchronized with the substring index when the source object is removed.
Used for event-driven synchronization.
|
false
|
subStringIndex and configuration
|
||
|
synchronizeOnUpdate
|
Indicates that the source data should be synchronized with the substring index when the source object is updated.
Used for event-driven synchronization.
|
false
|
subStringIndex and configuration
|
||
|
tableStorageSize
|
Specifies the size storage for table schema objects. If blank, then no table storage clause is used.
This property only applies to Oracle databases.
|
1M
|
subStringIndex and configuration
|
||
|
tableTableSpaceName
|
Specifies the tablespace (or filegroup) name for table schema objects. If blank, then no tablespace clause is used.
|
subStringIndex and configuration
|
