Global Attribute Indexes are used to store information that makes it possible for the entry balancing request processor to locate entries very quickly.
Indexing is performed on a per-attribute level. Each indexed attribute is expected to have mostly unique values, but if the values are guaranteed to be unique then the guaranteed-unique property should be enabled.
↓Relations From this Component
↓Properties
↓dsconfig Usage
The following components have a direct composition relation to Global Attribute Indexes:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ attribute | ↓ index-size |
| ↓ prime-index | |
| ↓ guaranteed-unique |
| Description | Specifies the name of the attribute for which the index is to be maintained. |
| Default Value | None |
| Allowed Values | The name or OID of an attribute type defined in the server schema. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | If this option is enabled then this index will be loaded at startup from data provided by a remote server. |
| Default Value | false |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | If this option is enabled, the Directory Proxy Server can assume that the values of the indexed attribute are unique. In some cases this allows for more efficient processing of operations involving the indexed attribute. |
| Default Value | false |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
index-size (Advanced Property)
| Description | The maximum number of values the index is expected to hold. If the property is not set, its value will be estimated from the memory given to the global index and the number of indexes configured. This property is used to size the index for best performance. However, it does not set a limit on the number of values that may be in the index. If the size is set too high, there will be less efficient use of available memory (lower density of index values in memory). If the size is set too low, memory will be used efficiently but operations on the index will have lower performance. |
| Default Value | The default size is estimated from the memory given to the global index and the number of indexes configured. |
| Allowed Values | An integer value. Lower limit is 1. Upper limit is 2147483647 . |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | The Global Attribute Index must be disabled and re-enabled for changes to this setting to take effect. Modification requires that this component be disabled and then re-enabled |
To list the configured Global Attribute Indexes:
dsconfig list-global-attribute-indexes
[--property {propertyName}] ...
To view the configuration for an existing Global Attribute Index:
dsconfig get-global-attribute-index-prop
--index-name {name}
--processor-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Global Attribute Index:
dsconfig set-global-attribute-index-prop
--index-name {name}
--processor-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Global Attribute Index:
dsconfig create-global-attribute-index
--index-name {name}
--processor-name {name}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Global Attribute Index:
dsconfig delete-global-attribute-index
--index-name {name}
--processor-name {name}