The Global Index contains the information required by the Global Index to index an attribute when using the distribution feature.
The Global Index is the object representing an attribute indexed by a Global Index Catalog. The Global Index Attribute can be configured to store the data in a specific implementation of a Hashmap, and for better performance predictability, it is also recommended to set an initial capacity to the global index. The initial capacity should be set to a maximum value that should never be exceeded, to avoid the rebalancing of all of the entries in the Hashmap.
The following components have a direct COMPOSITION relation TO Global Indexes :
This page describes the Global Index:
A description of each property follows.
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ global-index-attribute | ↓ global-index-deleted-entry-retention-timeout |
| ↓ global-index-hashmap-implementation-java-class | |
| ↓ global-index-hashmap-initial-capacity |
| Description | Specifies the attribute to index. Provides an attribute name that will be indexed. This is the attribute name as defined in the schema loaded in the Global Index server instance. |
| Default Value | None |
| Allowed Values | A String |
| Multi-valued | No |
| Required | Yes |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | Yes |
global-index-deleted-entry-retention-timeout
| Description | Specifies how long a deleted entry is kept in the system. The deleted entry retention timeout is to ensure that, when the global index receives a delete operation before the add operation for the same entry, the entry will effectively be deleted. This property is particularly important for deployments where replication is configured between directory servers. The property value is expressed in milliseconds and cannot exceed 10 minutes. It should be configured to be greater than the effective replication latency. |
| Default Value | 500 |
| Allowed Values | An integer value. Lower value is 0. Upper value is 600000 . |
| Multi-valued | No |
| Required | No |
| Admin Action Required | Restart the server |
| Advanced Property | Yes |
| Read-only | No |
global-index-hashmap-implementation-java-class
| Description | Specifies the fully-qualified name of the Java class that provides a HashMap implementation used by the Global Index. |
| Default Value | java.util.concurrent.ConcurrentHashMap |
| Allowed Values | A java class that implements or extends the class(es) : java.util.Map |
| Multi-valued | No |
| Required | No |
| Admin Action Required | Restart the server |
| Advanced Property | Yes |
| Read-only | No |
global-index-hashmap-initial-capacity
| Description | The initial capacity of the hashmap that will store the indexed attributes. The value must be above the expected number of entries stored in the Global Index in order to avoid internal rebalancing of the hashmap. |
| Default Value | 10000 |
| Allowed Values | An integer value. Lower value is 1024. |
| Multi-valued | No |
| Required | No |
| Admin Action Required | Restart the server |
| Advanced Property | Yes |
| Read-only | No |
Each configuration property can be mapped to a specific LDAP attribute under the "cn=config" entry. The mappings that follow are provided for information only. In general, you should avoid changing the server configuration by manipulating the LDAP attributes directly.
| Base DN | cn=gi-attr-name |
| objectclass name | ds-cfg-global-index |
| objectclass superior | top |
| Property | LDAP attribute |
| global-index-attribute | ds-cfg-global-index-attribute |
| global-index-deleted-entry-retention-timeout | ds-cfg-global-index-deleted-entry-retention-timeout |
| global-index-hashmap-implementation-java-class | ds-cfg-global-index-hashmap-implementation-java-class |
| global-index-hashmap-initial-capacity | ds-cfg-global-index-hashmap-initial-capacity |