Holds the information for an index.
indexDefinition
None
Each value of this attribute contains the information for a single index in the following format:
<version>$<indexName>$<state>$<rule>$<type>$1$<attributeName>
Version contains the version value for an index. Set this value to 0 for eDirectory 8.5.
IndexName is the descriptive name of the index.
State is a read-only value that defines the current state of the index. It must be one of the following:
|
State Value |
Description |
|---|---|
|
0 |
Online |
|
1 |
Suspend. When an index is in this state it is not used in queries nor is it updated. |
|
2 |
Bringing Online (Low). Indicates an index is waiting to be created the next time the background process runs. |
|
3 |
Bringing Online (High). Indicates an index is waiting to be created the next time the background process runs. Note that in the high priority mode the CPU load is increased dramatically while the index is being built. |
|
4 |
Creating. Indicates that the index is in an intermediate state during creation. |
When defining an index, the state value is almost always set to 2. Only set this value to 3 if you absolutely require the high priority index build and can handle the CPU load. The background process automatically changes the state once the process has begun.
The online and creating states are reserved for internal use. Attempts to set the state to these values are ignored.
Rule defines the matching rule to be used by the index and must be one of the following:
|
Value |
Description |
|---|---|
|
0 |
Value |
|
1 |
Presence |
|
2 |
Ends with or contains substring |
The type defines what type the index is, and can be one of the following values:
For help in understanding the attribute definition template, see Reading NDS Attribute Type Definitions.
|
Value |
Description |
|---|---|
|
0 |
User defined |
|
1 |
Added when an attribute was created |
|
2 |
Needed for system operation (system created) |
|
3 |
Other system created index |
When defining an index, set they type to 0.
This specifies the name of the attribute to be indexed.