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.
Relations From this Component
The following components have a direct AGGREGATION relation FROM Global Indexes :
Specifies the path to the filesystem directory that is used to hold the Berkeley DB Java Edition database files containing the data for this Global Index. The path may be either an absolute path or a path relative to the directory containing the base of the Server installation. The path may be any valid directory path in which the server has appropriate permissions to read and write files and has sufficient space to hold the database contents.
Default Value
catalogs
Allowed Values
A String
Multi-valued
No
Required
Yes
Admin Action Required
The Global Index must be disabled and re-enabled for changes to this setting to take effect
Advanced Property
No
Read-only
No
global-index-attribute
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
Advanced Properties
db-checkpointer-bytes-interval
Description
Specifies the maximum number of bytes that may be written to the database before it is forced to perform a checkpoint. This can be used to bound the recovery time that may be required if the database environment is opened without having been properly closed. If this property is set to a non-zero value, the checkpointer wakeup interval is not used. To use time-based checkpointing, set this property to zero.
Default Value
20mb
Allowed Values
A positive integer representing a size. Upper value is 9223372036854775807 .
Multi-valued
No
Required
No
Admin Action Required
Restart the server
Advanced Property
Yes
Read-only
No
db-checkpointer-wakeup-interval
Description
Specifies the maximum length of time that may pass between checkpoints. Note that this is only used if the value of the checkpointer bytes interval is zero.
Default Value
30s
Allowed Values
A duration Syntax. Lower limit is 1 seconds. Upper limit is 4294 seconds.
Multi-valued
No
Required
No
Admin Action Required
The Global Index must be disabled and re-enabled for changes to this setting to take effect
Advanced Property
Yes
Read-only
No
db-cleaner-min-utilization
Description
Specifies the minimum percentage of "live" data that the database cleaner attempts to keep in database log files. If the amount of live data in any database log file drops below this percentage, then the cleaner moves the remaining live data in that file to the end of the database and deletes the original file in order to keep the database relatively compact.
Default Value
50
Allowed Values
An integer value. Lower value is 0. Upper value is 90 .
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
db-directory-permissions
Description
Specifies the permissions that should be applied to the directory containing the Global Index database files. They should be expressed as three-digit octal values, which is the traditional representation for UNIX file permissions. The three digits represent the permissions that are available for the directory's owner, group members, and other users (in that order), and each digit is the octal representation of the read, write, and execute bits. Note that this only impacts permissions on the database directory and not on the files written into that directory. On UNIX systems, the user's umask controls permissions given to the database files.
Default Value
700
Allowed Values
Any octal value between 700 and 777 (the owner must always have read, write, and execute permissions on the directory).
Multi-valued
No
Required
No
Admin Action Required
Restart the server
Advanced Property
Yes
Read-only
No
db-log-file-max
Description
Specifies the maximum size for a database log file.
Default Value
10mb
Allowed Values
A positive integer representing a size. Lower value is 1000000. Upper value is 4294967296 .
Multi-valued
No
Required
No
Admin Action Required
The Global Index must be disabled and re-enabled for changes to this setting to take effect
Advanced Property
Yes
Read-only
No
db-num-cleaner-threads
Description
Specifies the number of threads that the backend should maintain to keep the database log files at or near the desired utilization. In environments with high write throughput, multiple cleaner threads may be required to maintain the desired utilization.
Default Value
Let the server decide.
Allowed Values
An integer value. Lower value is 1.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
db-num-lock-tables
Description
Specifies the number of lock tables that are used by the underlying database. This can be particularly important to help improve scalability by avoiding contention on systems with large numbers of CPUs. The value of this configuration property should be set to a prime number that is less than or equal to the number of worker threads configured for use in the server.
Default Value
Let the server decide.
Allowed Values
An integer value. Lower value is 1. Upper value is 32767 .
Multi-valued
No
Required
No
Admin Action Required
The Global Index must be disabled and re-enabled for changes to this setting to take effect
Advanced Property
Yes
Read-only
No
db-txn-no-sync
Description
Indicates whether database writes should be primarily written to an internal buffer but not immediately written to disk. Setting the value of this configuration attribute to "true" may improve write performance but could cause the most recent changes to be lost if the server or the underlying JVM exits abnormally, or if an OS or hardware failure occurs.
Default Value
false
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
db-txn-write-no-sync
Description
Indicates whether the database should synchronously flush data as it is written to disk. If this value is set to "false", then all data written to disk is synchronously flushed to persistent storage and thereby providing full durability. If it is set to "true", then data may be cached for a period of time by the underlying operating system before actually being written to disk. This may improve performance, but could cause the most recent changes to be lost in the event of an underlying OS or hardware failure (but not in the case that the server or the JVM exits abnormally).
Default Value
true
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
global-index-catalogs-shared-cache
Description
The cache used by all of the global indexes in that JVM instance.
Default Value
global-index-catalogs-shared-cache
Allowed Values
The DN of any Extension. The referenced global index catalogs shared cache must be enabled.
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
Yes
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 the remote 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
500ms
Allowed Values
A duration Syntax. Lower limit is 0 milliseconds. Upper limit is 600000 milliseconds.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
je-property
Description
Specifies the database and environment properties for the Berkeley DB Java Edition database serving the data for this backend. Any Berkeley DB Java Edition property can be specified using the following form: property-name=property-value. Refer to Oracle Unified Directory documentation for further information on related properties, their implications, and range values. The definitive identification of all the property parameters is available in the example.properties file of Berkeley DB Java Edition distribution.