(Deprecated) A (Deprecated) PDB Backend stores application data in a Persistit database.
The PDB Backend has been deprecated in OpenDJ 4.0.0 and will be removed in a future release. Please use the JE Backend instead.
The (Deprecated) PDB Backend object inherits from Pluggable Backend.
Use the --advanced option to access advanced properties.
Basic Properties
Advanced Properties
| Synopsis | Specifies a name to identify the associated backend. |
| Description | The name must be unique among all backends in the server. The backend ID may not be altered after the backend is created in the server. |
| Default Value | None |
| Allowed Values | A string. |
| Multi-valued | No |
| Required | Yes |
| Admin Action Required | None |
| Advanced | No |
| Read-Only | Yes |
| Synopsis | Specifies the base DN(s) for the data that the backend handles. |
| Description | 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 (similar to the use of sub-suffixes in the Sun Java System Directory Server). 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 | No |
| Read-Only | No |
| Synopsis | Specifies the key length in bits for the preferred cipher. |
| Default Value | 128 |
| Allowed Values | An integer. Lower limit: 0. |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None Changes to this property take effect immediately but only affect cryptographic operations performed after the change. |
| Advanced | No |
| Read-Only | No |
| Synopsis | Specifies the cipher for the directory server. The syntax is "algorithm/mode/padding". |
| Description | The full transformation is required: specifying only an algorithm and allowing the cipher provider to supply the default mode and padding is not supported, because there is no guarantee these default values are the same among different implementations. Some cipher algorithms, including RC4 and ARCFOUR, do not have a mode or padding, and hence must be specified using NONE for the mode field and NoPadding for the padding field. For example, RC4/NONE/NoPadding. |
| Default Value | AES/CBC/PKCS5Padding |
| Allowed Values | A string. |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None Changes to this property take effect immediately but only affect cryptographic operations performed after the change. |
| Advanced | No |
| Read-Only | No |
| Synopsis | Indicates whether the backend should use a compact form when encoding entries by compressing the attribute descriptions and object class sets. |
| Description | 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 | No |
| Read-Only | No |
| Synopsis | Indicates whether the backend should make entries in database files readable only by Directory Server. |
| Description | Confidentiality is achieved by enrypting entries before writing them to the underlying storage. Entry encryption will protect data on disk from unauthorised parties reading the files; for complete protection, also set confidentiality for sensitive attributes indexes. The property cannot be set to false if some of the indexes have confidentiality set to true. |
| Default Value | false |
| Allowed Values | true false |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None |
| Advanced | No |
| Read-Only | No |
| Synopsis | Specifies the percentage of JVM memory to allocate to the database cache. |
| Description | 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 | 50 |
| Allowed Values | An integer. Lower limit: 1. Upper limit: 90. |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None |
| Advanced | No |
| Read-Only | No |
| Synopsis | The amount of JVM memory to allocate to the database cache. |
| Description | 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 | No |
| Read-Only | No |
| Synopsis | Specifies the path to the filesystem directory that is used to hold the Persistit database files containing the data for this backend. |
| Description | The path may be either an absolute path or a path relative to the directory containing the base of the OpenDJ 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 object must be disabled and re-enabled for changes to take effect. |
| Advanced | No |
| Read-Only | No |
| Synopsis | Indicates whether the backend is enabled in the server. |
| Description | If a backend 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 | No |
| Read-Only | No |
| Synopsis | 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 | No |
| Read-Only | No |
db-checkpointer-wakeup-interval
| Synopsis | Specifies the maximum length of time that may pass between checkpoints. |
| Description | This setting controls the elapsed time between attempts to write a checkpoint to the journal. A longer interval allows more updates to accumulate in buffers before they are required to be written to disk, but also potentially causes recovery from an abrupt termination (crash) to take more time. |
| Default Value | 15s |
| Allowed Values | A duration. Lower limit: 10 seconds. Upper limit: 3600 seconds. |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None |
| Advanced | Yes |
| Read-Only | No |
| Synopsis | Specifies the permissions that should be applied to the directory containing the server database files. |
| Description | 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 for changes to take effect. |
| Advanced | Yes |
| Read-Only | No |
| Synopsis | Indicates whether database writes should be primarily written to an internal buffer but not immediately written to disk. |
| Description | 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 OpenDJ 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 Sun Java System Directory Server). |
| Default Value | true |
| Allowed Values | true false |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None |
| Advanced | Yes |
| Read-Only | No |
| Synopsis | Full disk threshold to limit database updates |
| Description | 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 | 100 megabytes |
| Allowed Values | A positive integer representing a size. |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None |
| Advanced | Yes |
| Read-Only | No |
| Synopsis | Low disk threshold to limit database updates |
| Description | 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 | 200 megabytes |
| Allowed Values | A positive integer representing a size. |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None |
| Advanced | Yes |
| Read-Only | No |
| Synopsis | Indicates whether the backend should attempt to compress entries before storing them in the database. |
| Description | 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 | Yes |
| Read-Only | No |
| Synopsis | Specifies the amount of off-heap memory dedicated to the online operation (import-ldif, rebuild-index). |
| Default Value | Use only heap memory. |
| Allowed Values | A positive integer representing a size. |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None |
| Advanced | Yes |
| Read-Only | No |
| Synopsis | Specifies the maximum number of entries that is allowed to match a given index key before that particular index key is no longer maintained. |
| Description | This property is analogous to the ALL IDs threshold in the Sun Java System Directory Server. 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. Changing the index entry limit significantly can result in serious performance degradation. Please read the documentation before changing this setting. |
| Default Value | 4000 |
| Allowed Values | An integer. Lower limit: 0. Upper limit: 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 | Yes |
| Read-Only | No |
| Synopsis | Indicates whether to gather statistical information about the search filters processed by the directory server while evaluating the usage of indexes. |
| Description | 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 | Yes |
| Read-Only | No |
index-filter-analyzer-max-filters
| Synopsis | The maximum number of search filter statistics to keep. |
| Description | When the maximum number of search filter is reached, the least used one will be deleted. |
| Default Value | 25 |
| Allowed Values | An integer. Lower limit: 1. |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None |
| Advanced | Yes |
| Read-Only | No |
| Synopsis | Specifies the fully-qualified name of the Java class that provides the backend implementation. |
| Default Value | org.opends.server.backends.pdb.PDBBackend |
| Allowed Values | A Java class that extends or implements: org.opends.server.api.Backend |
| Multi-valued | No |
| Required | Yes |
| Admin Action Required | The object must be disabled and re-enabled for changes to take effect. |
| Advanced | Yes |
| Read-Only | No |
| Synopsis | Specifies the length of time that the backend is allowed to spend "pre-loading" data when it is initialized. |
| Description | 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. Lower limit: 0 milliseconds. Upper limit: 2147483647 milliseconds. |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None |
| Advanced | Yes |
| Read-Only | No |