Specifies the base DN(s) for the data that the backend handles. A single backend may be responsible for one or more base DNs. Note that no two backends may have the same base DN although one backend may have a base DN that is below a base DN provided by another backend. If any of the base DNs is subordinate to a base DN for another backend, then all base DNs for that backend must be subordinate to that same base DN.
Default Value
None
Allowed Values
A valid DN.
Multi-valued
Yes
Required
Yes
Admin Action Required
None. No administrative action is required by default although some action may be required on a per-backend basis before the new base DN may be used.
Advanced Property
No
Read-only
No
compact-encoding
Description
Indicates whether the backend should use a compact form when encoding entries by compressing the attribute descriptions and object class sets. Note that this property applies only to the entries themselves and does not impact the index data.
Default Value
true
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None. Changes to this setting take effect only for writes that occur after the change is made. It is not retroactively applied to existing data.
Advanced Property
No
Read-only
No
db-cache-percent
Description
Specifies the percentage of JVM memory to allocate to the database cache. Specifies the percentage of memory available to the JVM that should be used for caching database contents. Note that this is only used if the value of the db-cache-size property is set to "0 MB". Otherwise, the value of that property is used instead to control the cache size configuration.
Default Value
10
Allowed Values
An integer value. Lower value is 1. Upper value is 90 .
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No
db-cache-size
Description
The amount of JVM memory to allocate to the database cache. Specifies the amount of memory that should be used for caching database contents. A value of "0 MB" indicates that the db-cache-percent property should be used instead to specify the cache size.
Default Value
0 MB
Allowed Values
A positive integer representing a size.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No
db-directory
Description
Specifies the path to the filesystem directory that is used to hold the Berkeley DB Java Edition database files containing the data for this backend. The path may be either an absolute path or a path relative to the directory containing the base of the OpenDS Directory 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
db
Allowed Values
A String
Multi-valued
No
Required
Yes
Admin Action Required
The DB Local Backend Workflow Element must be disabled and re-enabled for changes to this setting to take effect
Advanced Property
No
Read-only
No
enabled
Description
Indicates whether the Workflow Element is enabled for use in the server. If a Workflow Element is not enabled, then its contents are not accessible when processing operations.
Default Value
None
Allowed Values
true
false
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No
index-entry-limit
Description
Specifies the maximum number of entries that is allowed to match a given index key before that particular index key is no longer maintained. This property is analogous to the ALL IDs threshold in the Oracle Directory Server Enterprise Edition. Note that this is the default limit for the backend, and it may be overridden on a per-attribute basis.A value of 0 means there is no limit.
Default Value
4000
Allowed Values
An integer value. Lower value is 0. Upper value is 2147483647 .
Multi-valued
No
Required
No
Admin Action Required
None. If any index keys have already reached this limit, indexes need to be rebuilt before they are allowed to use the new limit.
Advanced Property
No
Read-only
No
maintenance
Description
Indicates whether the server DB Local Backend Workflow Element is in maintenance mode. If a DB Local Backend Workflow Element is in maintenance mode, required by administrative action, it means the server is not able to fulfill the requests and will return referrals.
Default Value
false
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No
referrals-url
Description
The URLs that should be returned when the server is not able to fulfill the requests set of LDAP URLs providing a reference to an alternate location in which an operation may be processed. If not defined, URLs provided by the replication service will be used.
Default Value
None
Allowed Values
A LDAP URL compliant with RFC 2255.
Multi-valued
Yes
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No
writability-mode
Description
Specifies the behavior that the backend should use when processing write operations.
Default Value
enabled
Allowed Values
disabled - Causes all write attempts to fail.
enabled - Allows write operations to be performed in that backend (if the requested operation is valid, the user has permission to perform the operation, the backend supports that type of write operation, and the global writability-mode property is also enabled).
internal-only - Causes external write attempts to fail but allows writes by replication and internal operations.
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No
Advanced Properties
db-cache-mode
Description
Specifies the in-memory cache mode used for operations performed. Modes that can be specified for control over caching of records in the in-memory cache. When a record is stored or retrieved, the cache mode determines how long the record is subsequently retained in the in-memory cache, relative to other records in the cache.
Default Value
default
Allowed Values
default - The record's hotness is changed to "most recently used" by the operation where this cache mode is specified.
evict-bin - The record leaf node and its parent bottom internal node are evicted as soon as possible after the operation where this cache mode is specified.
evict-ln - The record leaf node is evicted as soon as possible after the operation where this cache mode is specified.
keep-hot - The record is assigned "maximum hotness" by the operation where this cache mode is specified.
make-cold - The record is assigned "maximum coldness" by the operation where this cache mode is specified.
unchanged - The record's hotness or coldness is unchanged by the operation where this cache mode is specified.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
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 DB Local Backend Workflow Element 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 server 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-evictor-lru-only
Description
Indicates whether the database should evict existing data from the cache based on an LRU policy (where the least recently used information will be evicted first). If set to "false", then the eviction keeps internal nodes of the underlying Btree in the cache over leaf nodes, even if the leaf nodes have been accessed more recently. This may be a better configuration for databases in which only a very small portion of the data is cached.
Default Value
true
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
The DB Local Backend Workflow Element must be disabled and re-enabled for changes to this setting to take effect
Advanced Property
Yes
Read-only
No
db-evictor-nodes-per-scan
Description
Specifies the number of Btree nodes that should be evicted from the cache in a single pass if it is determined that it is necessary to free existing data in order to make room for new information. Changes to this property do not take effect until the backend is restarted. It is recommended that you also change this property when you set db-evictor-lru-only to false. This setting controls the number of Btree nodes that are considered, or sampled, each time a node is evicted. A setting of 100 often produces good results, but this may vary from application to application. The larger the nodes per scan, the more accurate the algorithm. However, setting it too high is detrimental; the need to consider larger numbers of nodes for each eviction may delay the completion of a given database operation, which will impact the response time of the application thread.
Default Value
10
Allowed Values
An integer value. Lower value is 1. Upper value is 1000 .
Multi-valued
No
Required
No
Admin Action Required
The DB Local Backend Workflow Element must be disabled and re-enabled for changes to this setting to take effect
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 DB Local Backend Workflow Element must be disabled and re-enabled for changes to this setting to take effect
Advanced Property
Yes
Read-only
No
db-logging-file-handler-on
Description
Indicates whether the database should maintain a je.info file in the same directory as the database log directory. This file contains information about the internal processing performed by the underlying database.
Default Value
true
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
The DB Local Backend Workflow Element must be disabled and re-enabled for changes to this setting to take effect
Advanced Property
Yes
Read-only
No
db-logging-level
Description
Specifies the log level that should be used by the database when it is writing information into the je.info file. The database trace logging level is (in increasing order of verbosity) chosen from: OFF, SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST, ALL.
Default Value
CONFIG
Allowed Values
A String
Multi-valued
No
Required
No
Admin Action Required
The DB Local Backend Workflow Element 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 DB Local Backend Workflow Element must be disabled and re-enabled for changes to this setting to take effect
Advanced Property
Yes
Read-only
No
db-run-cleaner
Description
Indicates whether the database cleaner threads should be enabled. The cleaner threads are used to periodically compact the database by identifying database files with a low (that is, less than the amount specified by the db-cleaner-min-utilization property) percentage of live data, moving the remaining live data to the end of the log and deleting that file.
Default Value
true
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
db-txn-durability
Description
Specifies the durability of database transactions. Indicates whether the database should synchronously flush data as it is written to disk.
Default Value
write-to-filesystem
Allowed Values
write-to-cache - Database writes should be primarily written to an internal buffer but not immediately written to disk. This may improve write performance but could cause the most recent changes to be lost if the OpenDS Directory Server or the underlying JVM exits abnormally, or if an OS or hardware failure occurs (a behavior similar to running with transaction durability disabled in the Oracle Directory Server Enterprise Edition).
write-to-disk - All data written to disk is synchronously flushed to persistent storage and thereby providing full durability.
write-to-filesystem - 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 OpenDS Directory Server or the JVM exits abnormally).
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
disk-full-threshold
Description
Full disk threshold to limit database updates When the available free space on the disk used by this database instance falls below the value specified, no updates are permitted and the server returns an UNWILLING_TO_PERFORM error. Updates are allowed again as soon as free space rises above the threshold.
Default Value
20 megabytes
Allowed Values
A positive integer representing a size.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
disk-low-threshold
Description
Low disk threshold to limit database updates Specifies the "low" free space on the disk. When the available free space on the disk used by this database instance falls below the value specified, protocol updates on this database are permitted only by a user with the BYPASS_LOCKDOWN privilege.
Default Value
100 megabytes
Allowed Values
A positive integer representing a size.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
entries-compressed
Description
Indicates whether the backend should attempt to compress entries before storing them in the database. Note that this property applies only to the entries themselves and does not impact the index data. Further, the effectiveness of the compression is based on the type of data contained in the entry.
Default Value
false
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None. Changes to this setting take effect only for writes that occur after the change is made. It is not retroactively applied to existing data.
Advanced Property
Yes
Read-only
No
index-filter-analyzer-enabled
Description
Indicates whether to gather statistical information about the search filters processed by the Directory Server while evaluating the usage of indexes. Analyzing indexes requires gathering search filter usage patterns from user requests, especially for values as specified in the filters and subsequently looking the status of those values into the index files. When a search requests is processed, internal or user generated, a first phase uses indexes to find potential entries to be returned. Depending on the search filter, if the index of one of the specified attributes matches too many entries (exceeds the index entry limit), the search becomes non-indexed. In any case, all entries thus gathered (or the entire DIT) are matched against the filter for actually returning the search result.
Default Value
false
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
java-class
Description
Specifies the fully-qualified name of the Java class that provides the DB Local Backend Workflow Element implementation.
A java class that implements or extends the class(es) :
org.opends.server.workflowelement.WorkflowElement
Multi-valued
No
Required
Yes
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 OpenDS 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.
Default Value
None
Allowed Values
A String
Multi-valued
Yes
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
max-entries
Description
The maximum number of search filter statistics to keep. When the maximum number of search filter is reached, the least used one will be deleted.
Default Value
25
Allowed Values
An integer value. Lower value is 1.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
preload-time-limit
Description
Specifies the length of time that the backend is allowed to spend "pre-loading" data when it is initialized. The pre-load process is used to pre-populate the database cache, so that it can be more quickly available when the server is processing requests. A duration of zero means there is no pre-load.
Default Value
0s
Allowed Values
A duration Syntax. Lower limit is 0 milliseconds. Upper limit is 2147483647 milliseconds.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
tombstone-creation-enabled
Description
Indicates whether the backend should create a tombstone when an entry is deleted. Deleting an entry will not immediatly remove it but instead create a tombstone entry with a specific objectclass.
Default Value
true
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None. Changes to this setting take effect only for deletes that occur after the change is made. It is not retroactively applied to existing data.
Advanced Property
Yes
Read-only
No
tombstone-lifetime
Description
Specifies the life time of a tombstone after the entry has been deleted.
Default Value
1w
Allowed Values
A duration Syntax. A value of "-1" or "unlimited" for no limit. Lower limit is 1 minutes.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
tombstone-purge-interval
Description
Specifies the time interval that the tombstone purging is started again.
Default Value
5m
Allowed Values
A duration Syntax. A value of "-1" or "unlimited" for no limit. Lower limit is 1 minutes.