<?xml version="1.0" encoding="UTF-8"?>
|
<!--
|
! CDDL HEADER START
|
!
|
! The contents of this file are subject to the terms of the
|
! Common Development and Distribution License, Version 1.0 only
|
! (the "License"). You may not use this file except in compliance
|
! with the License.
|
!
|
! You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
|
! or http://forgerock.org/license/CDDLv1.0.html.
|
! See the License for the specific language governing permissions
|
! and limitations under the License.
|
!
|
! When distributing Covered Code, include this CDDL HEADER in each
|
! file and include the License file at legal-notices/CDDLv1_0.txt.
|
! If applicable, add the following below this CDDL HEADER, with the
|
! fields enclosed by brackets "[]" replaced with your own identifying
|
! information:
|
! Portions Copyright [yyyy] [name of copyright owner]
|
!
|
! CDDL HEADER END
|
!
|
!
|
! Copyright 2007-2010 Sun Microsystems, Inc.
|
! Portions Copyright 2010-2013 ForgeRock AS.
|
! -->
|
<adm:managed-object name="local-db-backend"
|
plural-name="local-db-backends" package="org.opends.server.admin.std"
|
extends="backend" xmlns:adm="http://www.opends.org/admin"
|
xmlns:ldap="http://www.opends.org/admin-ldap"
|
xmlns:cli="http://www.opends.org/admin-cli">
|
<adm:synopsis>
|
The
|
<adm:user-friendly-name />
|
uses the Berkeley DB Java Edition to store user-provided data in a local
|
repository.
|
</adm:synopsis>
|
<adm:description>
|
It is the traditional "directory server" backend and is similar to
|
the backends provided by the Sun Java System Directory Server. The
|
<adm:user-friendly-name />
|
stores the entries in an encoded form and also provides indexes that
|
can be used to quickly locate target entries based on different
|
kinds of criteria.
|
</adm:description>
|
<adm:profile name="ldap">
|
<ldap:object-class>
|
<ldap:name>ds-cfg-local-db-backend</ldap:name>
|
<ldap:superior>ds-cfg-backend</ldap:superior>
|
</ldap:object-class>
|
</adm:profile>
|
<adm:relation name="local-db-index">
|
<adm:one-to-many naming-property="attribute">
|
<adm:default-managed-object name="aci">
|
<adm:property name="index-type">
|
<adm:value>presence</adm:value>
|
</adm:property>
|
<adm:property name="attribute">
|
<adm:value>aci</adm:value>
|
</adm:property>
|
</adm:default-managed-object>
|
<adm:default-managed-object name="entryUUID">
|
<adm:property name="index-type">
|
<adm:value>equality</adm:value>
|
</adm:property>
|
<adm:property name="attribute">
|
<adm:value>entryUUID</adm:value>
|
</adm:property>
|
</adm:default-managed-object>
|
<adm:default-managed-object name="objectClass">
|
<adm:property name="index-type">
|
<adm:value>equality</adm:value>
|
</adm:property>
|
<adm:property name="attribute">
|
<adm:value>objectClass</adm:value>
|
</adm:property>
|
</adm:default-managed-object>
|
<adm:default-managed-object name="ds-sync-hist">
|
<adm:property name="index-type">
|
<adm:value>ordering</adm:value>
|
</adm:property>
|
<adm:property name="attribute">
|
<adm:value>ds-sync-hist</adm:value>
|
</adm:property>
|
</adm:default-managed-object>
|
<adm:default-managed-object name="ds-sync-conflict">
|
<adm:property name="index-type">
|
<adm:value>equality</adm:value>
|
</adm:property>
|
<adm:property name="attribute">
|
<adm:value>ds-sync-conflict</adm:value>
|
</adm:property>
|
</adm:default-managed-object>
|
</adm:one-to-many>
|
<adm:profile name="ldap">
|
<ldap:rdn-sequence>cn=Index</ldap:rdn-sequence>
|
</adm:profile>
|
<adm:profile name="cli">
|
<cli:relation>
|
<cli:default-property name="index-type" />
|
<cli:default-property name="index-entry-limit" />
|
<cli:default-property name="index-extensible-matching-rule" />
|
</cli:relation>
|
</adm:profile>
|
</adm:relation>
|
<adm:relation name="local-db-vlv-index">
|
<adm:one-to-many naming-property="name" />
|
<adm:profile name="ldap">
|
<ldap:rdn-sequence>cn=VLV Index</ldap:rdn-sequence>
|
</adm:profile>
|
<adm:profile name="cli">
|
<cli:relation>
|
<cli:default-property name="base-dn" />
|
<cli:default-property name="scope" />
|
<cli:default-property name="filter" />
|
<cli:default-property name="sort-order" />
|
</cli:relation>
|
</adm:profile>
|
</adm:relation>
|
<adm:property-override name="java-class" advanced="true">
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>
|
org.opends.server.backends.jeb.BackendImpl
|
</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
</adm:property-override>
|
<adm:property-override name="writability-mode">
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>enabled</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
</adm:property-override>
|
<adm:property name="db-directory" mandatory="true">
|
<adm:TODO>Default this to the db/backend-id</adm:TODO>
|
<adm:synopsis>
|
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.
|
</adm:synopsis>
|
<adm:description>
|
The path may be either an absolute path or a path relative to the
|
directory containing the base of the <adm:product-name /> 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.
|
</adm:description>
|
<adm:requires-admin-action>
|
<adm:component-restart />
|
</adm:requires-admin-action>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>db</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:string />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-db-directory</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="compact-encoding">
|
<adm:synopsis>
|
Indicates whether the backend should use a compact form when
|
encoding entries by compressing the attribute descriptions and
|
object class sets.
|
</adm:synopsis>
|
<adm:description>
|
Note that this property applies only to the entries themselves and
|
does not impact the index data.
|
</adm:description>
|
<adm:requires-admin-action>
|
<adm:none>
|
<adm:synopsis>
|
Changes to this setting take effect only for writes that
|
occur after the change is made. It is not retroactively
|
applied to existing data.
|
</adm:synopsis>
|
</adm:none>
|
</adm:requires-admin-action>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>true</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:boolean />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-compact-encoding</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="entries-compressed" advanced="true">
|
<adm:synopsis>
|
Indicates whether the backend should attempt to compress entries
|
before storing them in the database.
|
</adm:synopsis>
|
<adm: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.
|
</adm:description>
|
<adm:requires-admin-action>
|
<adm:none>
|
<adm:synopsis>
|
Changes to this setting take effect only for writes that
|
occur after the change is made. It is not retroactively
|
applied to existing data.
|
</adm:synopsis>
|
</adm:none>
|
</adm:requires-admin-action>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>false</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:boolean />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-entries-compressed</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="import-queue-size" advanced="true">
|
<adm:synopsis>
|
This parameter has been deprecated in OpenDS 2.1 and will be removed
|
in <adm:product-name /> 3.0. It is only being kept for migration ease and is ignored
|
in OpenDS versions after 2.0.
|
</adm:synopsis>
|
<adm:requires-admin-action>
|
<adm:none>
|
<adm:synopsis>
|
This parameter has been deprecated in OpenDS 2.1 and will be removed
|
in <adm:product-name /> 3.0. It is only being kept for migration ease and is ignored
|
in OpenDS versions after 2.0.
|
</adm:synopsis>
|
</adm:none>
|
</adm:requires-admin-action>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>100</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:integer lower-limit="1" upper-limit="2147483647" />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-import-queue-size</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="import-thread-count" advanced="true">
|
<adm:synopsis>
|
This parameter has been deprecated in OpenDS 2.1 and will be removed
|
in <adm:product-name /> 3.0. It is only being kept for migration ease and is ignored
|
in OpenDS versions after 2.0.
|
</adm:synopsis>
|
<adm:description>
|
This parameter has been deprecated in OpenDS 2.1 and will be removed
|
in <adm:product-name /> 3.0. It is only being kept for migration ease and is ignored
|
in OpenDS versions after 2.0.
|
</adm:description>
|
<adm:requires-admin-action>
|
<adm:none>
|
<adm:synopsis>
|
Changes do not take effect for any import that may already
|
be in progress.
|
</adm:synopsis>
|
</adm:none>
|
</adm:requires-admin-action>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>8</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:integer lower-limit="1" upper-limit="2147483647" />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-import-thread-count</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="index-entry-limit">
|
<adm: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.
|
</adm:synopsis>
|
<adm: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.
|
</adm:description>
|
<adm:requires-admin-action>
|
<adm:none>
|
<adm:synopsis>
|
If any index keys have already reached this limit, indexes
|
need to be rebuilt before they are allowed to use the
|
new limit.
|
</adm:synopsis>
|
</adm:none>
|
</adm:requires-admin-action>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>4000</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:integer lower-limit="0" upper-limit="2147483647" />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-index-entry-limit</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="db-directory-permissions" advanced="true">
|
<adm:synopsis>
|
Specifies the permissions that should be applied to the directory
|
containing the server database files.
|
</adm:synopsis>
|
<adm: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.
|
</adm:description>
|
<adm:requires-admin-action>
|
<adm:server-restart />
|
</adm:requires-admin-action>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>700</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:string>
|
<adm:pattern>
|
<adm:regex>^7[0-7][0-7]$</adm:regex>
|
<adm:usage>MODE</adm:usage>
|
<adm:synopsis>
|
Any octal value between 700 and 777 (the owner must always
|
have read, write, and execute permissions on the directory).
|
</adm:synopsis>
|
</adm:pattern>
|
</adm:string>
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-db-directory-permissions</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="preload-time-limit" advanced="true">
|
<adm:synopsis>
|
Specifies the length of time that the backend is allowed to
|
spend "pre-loading" data when it is initialized.
|
</adm:synopsis>
|
<adm: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.
|
</adm:description>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>0s</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:duration base-unit="ms" lower-limit="0" upper-limit="2147483647" />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-preload-time-limit</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="db-cache-percent">
|
<adm:synopsis>
|
Specifies the percentage of JVM memory to allocate to the database cache.
|
</adm:synopsis>
|
<adm: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.
|
</adm:description>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>50</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:integer lower-limit="1" upper-limit="90" />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-db-cache-percent</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="db-cache-size">
|
<adm:synopsis>
|
The amount of JVM memory to allocate to the database cache.
|
</adm:synopsis>
|
<adm: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.
|
</adm:description>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>0 MB</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:size lower-limit="0 MB" />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-db-cache-size</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="db-cleaner-min-utilization" advanced="true">
|
<adm:synopsis>
|
Specifies the minimum percentage of "live" data that the database
|
cleaner attempts to keep in database log files.
|
</adm:synopsis>
|
<adm:description>
|
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.
|
</adm:description>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>50</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:integer lower-limit="0" upper-limit="90" />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-db-cleaner-min-utilization</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="db-run-cleaner" advanced="true">
|
<adm:synopsis>
|
Indicates whether the database cleaner threads should be
|
enabled.
|
</adm:synopsis>
|
<adm:description>
|
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.
|
</adm:description>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>true</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:boolean />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-db-run-cleaner</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="db-evictor-lru-only" advanced="true">
|
<adm:synopsis>
|
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).
|
</adm:synopsis>
|
<adm:description>
|
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.
|
</adm:description>
|
<adm:requires-admin-action>
|
<adm:component-restart />
|
</adm:requires-admin-action>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>false</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:boolean />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-db-evictor-lru-only</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="db-evictor-nodes-per-scan" advanced="true">
|
<adm:synopsis>
|
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.
|
</adm:synopsis>
|
<adm:description>
|
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 10 often produces good
|
results, but this may vary from application to application. The
|
larger the nodes per scan, the more accurate the algorithm.
|
However, don't set it too high. When considering larger numbers of
|
nodes for each eviction, the evictor may delay the completion of a
|
given database operation, which impacts the response time of the
|
application thread. In JE 4.1 and later, setting this value too high
|
in an application that is largely CPU bound can reduce the
|
effectiveness of cache eviction. It's best to start with the default
|
value, and increase it gradually to see if it is beneficial for your
|
application.
|
</adm:description>
|
<adm:requires-admin-action>
|
<adm:component-restart />
|
</adm:requires-admin-action>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>10</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:integer lower-limit="1" upper-limit="1000" />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-db-evictor-nodes-per-scan</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="db-evictor-core-threads" advanced="true">
|
<adm:synopsis>
|
Specifies the core number of threads in the eviction thread pool.
|
</adm:synopsis>
|
<adm:description>
|
Specifies the core number of threads in the eviction thread pool.
|
These threads help keep memory usage within cache bounds,
|
offloading work from application threads. db-evictor-core-threads,
|
db-evictor-max-threads and db-evictor-keep-alive are used to configure
|
the core, max and keepalive attributes for the eviction thread pool.
|
</adm:description>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>1</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:integer lower-limit="0" upper-limit="2147483647" />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-db-evictor-core-threads</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="db-evictor-max-threads" advanced="true">
|
<adm:synopsis>
|
Specifies the maximum number of threads in the eviction thread pool.
|
</adm:synopsis>
|
<adm:description>
|
Specifies the maximum number of threads in the eviction thread pool.
|
These threads help keep memory usage within cache bounds,
|
offloading work from application threads. db-evictor-core-threads,
|
db-evictor-max-threads and db-evictor-keep-alive are used to configure
|
the core, max and keepalive attributes for the eviction thread pool.
|
</adm:description>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>10</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:integer lower-limit="1" upper-limit="2147483647" />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-db-evictor-max-threads</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="db-evictor-keep-alive" advanced="true">
|
<adm:synopsis>
|
The duration that excess threads in the eviction thread pool will
|
stay idle. After this period, idle threads will terminate.
|
</adm:synopsis>
|
<adm:description>
|
The duration that excess threads in the eviction thread pool will
|
stay idle. After this period, idle threads will terminate.
|
db-evictor-core-threads, db-evictor-max-threads and
|
db-evictor-keep-alive are used to configure the core, max and
|
keepalive attributes for the eviction thread pool.
|
</adm:description>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>600s</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:duration base-unit="s" lower-limit="1" upper-limit="86400" />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-db-evictor-keep-alive</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="db-log-file-max" advanced="true">
|
<adm:synopsis>
|
Specifies the maximum size for a database log file.
|
</adm:synopsis>
|
<adm:requires-admin-action>
|
<adm:component-restart />
|
</adm:requires-admin-action>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>100mb</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:size lower-limit="1mb" upper-limit="4gib" />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-db-log-file-max</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="db-log-filecache-size" advanced="true">
|
<adm:synopsis>
|
Specifies the size of the file handle cache.
|
</adm:synopsis>
|
<adm:description>
|
The file handle cache is used to keep as much opened log files
|
as possible. When the cache is smaller than the number of logs,
|
the database needs to close some handles and open log files it needs,
|
resulting in less optimal performances. Ideally, the size of the cache
|
should be higher than the number of files contained in the database.
|
Make sure the OS number of open files per process is also tuned
|
appropriately.
|
</adm:description>
|
<adm:requires-admin-action>
|
<adm:component-restart />
|
</adm:requires-admin-action>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>100</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:integer lower-limit="3" upper-limit="2147483647" />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-db-log-filecache-size</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="db-logging-file-handler-on" advanced="true">
|
<adm:synopsis>
|
Indicates whether the database should maintain a je.info file in
|
the same directory as the database log directory.
|
</adm:synopsis>
|
<adm:description>
|
This file contains information about the internal processing
|
performed by the underlying database.
|
</adm:description>
|
<adm:requires-admin-action>
|
<adm:component-restart />
|
</adm:requires-admin-action>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>true</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:boolean />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-db-logging-file-handler-on</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="db-logging-level" advanced="true">
|
<adm:TODO>Use an enumeration</adm:TODO>
|
<adm:synopsis>
|
Specifies the log level that should be used by the database
|
when it is writing information into the je.info file.
|
</adm:synopsis>
|
<adm:description>
|
The database trace logging level is (in increasing order of
|
verbosity) chosen from: OFF, SEVERE, WARNING, INFO, CONFIG, FINE,
|
FINER, FINEST, ALL.
|
</adm:description>
|
<adm:requires-admin-action>
|
<adm:component-restart />
|
</adm:requires-admin-action>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>CONFIG</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:string />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-db-logging-level</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="db-checkpointer-bytes-interval" advanced="true">
|
<adm:synopsis>
|
Specifies the maximum number of bytes that may be written to the
|
database before it is forced to perform a checkpoint.
|
</adm:synopsis>
|
<adm:description>
|
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.
|
</adm:description>
|
<adm:requires-admin-action>
|
<adm:server-restart />
|
</adm:requires-admin-action>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>500mb</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:size lower-limit="0b" upper-limit="9223372036854775807b" />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-db-checkpointer-bytes-interval</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="db-checkpointer-wakeup-interval"
|
advanced="true">
|
<adm:synopsis>
|
Specifies the maximum length of time that may pass between
|
checkpoints.
|
</adm:synopsis>
|
<adm:description>
|
Note that this is only used if the value of the checkpointer
|
bytes interval is zero.
|
</adm:description>
|
<adm:requires-admin-action>
|
<adm:component-restart />
|
</adm:requires-admin-action>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>30s</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:duration base-unit="s" lower-limit="1" upper-limit="4294" />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-db-checkpointer-wakeup-interval</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="db-num-lock-tables" advanced="true">
|
<adm:synopsis>
|
Specifies the number of lock tables that are used by the underlying database.
|
</adm:synopsis>
|
<adm:description>
|
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.
|
</adm:description>
|
<adm:requires-admin-action>
|
<adm:component-restart />
|
</adm:requires-admin-action>
|
<adm:default-behavior>
|
<adm:alias>
|
<adm:synopsis>
|
Let the server decide.
|
</adm:synopsis>
|
</adm:alias>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:integer lower-limit="1" upper-limit="32767" />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-db-num-lock-tables</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="db-num-cleaner-threads" advanced="true">
|
<adm:synopsis>
|
Specifies the number of threads that the backend should maintain
|
to keep the database log files at or near the desired utilization.
|
</adm:synopsis>
|
<adm:description>
|
In environments with high write throughput, multiple cleaner
|
threads may be required to maintain the desired utilization.
|
</adm:description>
|
<adm:default-behavior>
|
<adm:alias>
|
<adm:synopsis>
|
Let the server decide.
|
</adm:synopsis>
|
</adm:alias>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:integer lower-limit="1" />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-db-num-cleaner-threads</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="db-txn-no-sync" advanced="true">
|
<adm:synopsis>
|
Indicates whether database writes should be primarily written to
|
an internal buffer but not immediately written to disk.
|
</adm:synopsis>
|
<adm: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 <adm:product-name /> 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).
|
</adm:description>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>false</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:boolean />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-db-txn-no-sync</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="db-txn-write-no-sync" advanced="true">
|
<adm:synopsis>
|
Indicates whether the database should synchronously flush data as
|
it is written to disk.
|
</adm:synopsis>
|
<adm:description>
|
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 <adm:product-name /> directory server or
|
the JVM exits abnormally).
|
</adm:description>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>true</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:boolean />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-db-txn-write-no-sync</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="disk-low-threshold" advanced="true">
|
<adm:synopsis>
|
Low disk threshold to limit database updates
|
</adm:synopsis>
|
<adm: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.
|
</adm:description>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>200 megabytes</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:size lower-limit="0" />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-disk-low-threshold</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="disk-full-threshold" advanced="true">
|
<adm:synopsis>
|
Full disk threshold to limit database updates
|
</adm:synopsis>
|
<adm: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.
|
</adm:description>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>100 megabytes</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:size lower-limit="0" />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-disk-full-threshold</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="je-property" advanced="true"
|
multi-valued="true">
|
<adm:synopsis>
|
Specifies the database and environment properties for the Berkeley
|
DB Java Edition database serving the data for this backend.
|
</adm:synopsis>
|
<adm:description>
|
Any Berkeley DB Java Edition property can be specified using the
|
following form: property-name=property-value. Refer to <adm:product-name />
|
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.
|
</adm:description>
|
<adm:default-behavior>
|
<adm:undefined />
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:string />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-je-property</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="index-filter-analyzer-enabled" advanced="true">
|
<adm:synopsis>
|
Indicates whether to gather statistical information about the search
|
filters processed by the directory server while evaluating the usage of
|
indexes.
|
</adm:synopsis>
|
<adm: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.
|
</adm:description>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>false</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:boolean />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-index-filter-analyzer-enabled</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="index-filter-analyzer-max-filters" advanced="true">
|
<adm:synopsis>
|
The maximum number of search filter statistics to keep.
|
</adm:synopsis>
|
<adm:description>
|
When the maximum number of search filter is reached, the least used one
|
will be deleted.
|
</adm:description>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>25</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:integer lower-limit="1" />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-index-filter-analyzer-max-filters</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="subordinate-indexes-enabled" advanced="true">
|
<adm:synopsis>
|
Indicates whether id2children and id2subtree indexes should be used for
|
this backend. These indexes are used for constraining filtered searches
|
to the search request's scope as well as for generating values for the
|
hasSubordinates and numSubordinates virtual attributes.
|
</adm:synopsis>
|
<adm:description>
|
Subordinate indexing is enabled by default and should only be disabled
|
for specialized use cases. A typical use case is where the backend is
|
to be subjected to heavy add/delete load beneath the same parent entry
|
such as when used as a session database. Disabling the subordinate
|
indexes means that the numSubordinates and hasSubordinates virtual
|
attributes will not be supported.
|
</adm:description>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>true</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:boolean />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-subordinate-indexes-enabled</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
</adm:managed-object>
|
