Configuration Reference Home
Oracle Unified Directory - Local DB Index

Local DB Index

Local DB Indexes are used to store information that makes it possible to locate entries very quickly when processing search operations.

Indexing is performed on a per-attribute level and different types of indexing may be performed for different kinds of attributes, based on how they are expected to be accessed during search operations.

Relations To this Component

The following components have a direct COMPOSITION relation TO Local DB Indexes :

Properties

A description of each property follows.


Basic Properties: Advanced Properties:
↓ attribute ↓ substring-length
↓ index-entry-limit
↓ index-extensible-matching-rule
↓ index-type

Basic Properties

attribute

Description
Specifies the name of the attribute for which the index is to be maintained.
Default Value
None
Allowed Values
The name of an attribute type defined in the server schema.
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
Yes

index-entry-limit

Description
Specifies the maximum number of entries that are allowed to match a given index key before that particular index key is no longer maintained. This is analogous to the ALL IDs threshold in the Oracle Directory Server Enterprise Edition. If this is specified, its value overrides the JE backend-wide configuration. For no limit, use 0 for the value.
Default Value
4000
Allowed Values
An integer value. Lower value is 0. Upper value is 2147483647 .
Multi-valued
No
Required
No
Admin Action Required
If any index keys have already reached this limit, indexes must be rebuilt before they will be allowed to use the new limit.
Advanced Property
No
Read-only
No

index-extensible-matching-rule

Description
The extensible matching rule in an extensible index. An extensible matching rule must be specified using either LOCALE or OID of the matching rule.
Default Value
No extensible matching rules will be indexed.
Allowed Values
A Locale or an OID.
Multi-valued
Yes
Required
No
Admin Action Required
The index must be rebuilt before it will reflect the new value.
Advanced Property
No
Read-only
No

index-type

Description
Specifies the type(s) of indexing that should be performed for the associated attribute. For equality, presence, and substring index types, the associated attribute type must have a corresponding matching rule.
Default Value
None
Allowed Values
approximate - This index type is used to improve the efficiency of searches using approximate matching search filters.

equality - This index type is used to improve the efficiency of searches using equality search filters.

extensible - This index type is used to improve the efficiency of searches using extensible matching search filters.

ordering - This index type is used to improve the efficiency of searches using "greater than or equal to" or "less then or equal to" search filters.

presence - This index type is used to improve the efficiency of searches using the presence search filters.

substring - This index type is used to improve the efficiency of searches using substring search filters.


Multi-valued
Yes
Required
Yes
Admin Action Required
If any new index types are added for an attribute, and values for that attribute already exist in the database, the index must be rebuilt before it will be accurate.
Advanced Property
No
Read-only
No


Advanced Properties

substring-length

Description
The length of substrings in a substring index.
Default Value
6
Allowed Values
An integer value. Lower value is 3.
Multi-valued
No
Required
No
Admin Action Required
The index must be rebuilt before it will reflect the new value.
Advanced Property
Yes
Read-only
No


Copyright © 2011,2012, Oracle and/or its affiliates. All rights reserved.