Manual Pages for UNIX Darwin command on man slapd-bdb

SLAPD-BDB(5) SLAPD-BDB(5)

NAME

slapd-bdb - BDB backend to slapd

SYNOPSIS

/etc/openldap/slapd.conf

DESCRIPTION

The BDB backend to ssllaappdd(8) is the recommended backend for a normal slapd database. However, it takes more care than with the LDBM backend to configure it properly. It uses the Sleepycat Berkeley DB (BDB) package to store data. It makes extensive use of indexing and caching to speed data access. It is noted that these options are intended to complement Berkeley DB configuration options set in the environment's DDBBCCOONNFFIIGG file. See Berkeley DB documentation for details on DDBBCCOONNFFIIGG configuration

options. Where there is overlap, settings in DDBBCCOONNFFIIGG take prece-

dence. CCOONNFFIIGGUURRAATTIIOONN These ssllaappdd..ccoonnff options apply to the BDB backend database. That is, they must follow a "database bdb" line and come before any subsequent "backend" or "database" lines. Other database options are described in the ssllaappdd..ccoonnff(5) manual page. ccaacchheessiizzee <>

Specify the size in entries of the in-memory cache maintained by

the BDB backend database instance. The default is 1000 entries. cchheecckkppooiinntt <> <> Specify the frequency for checkpointing the database transaction log. A checkpoint operation flushes the database buffers to disk and writes a checkpoint record in the log. The checkpoint

will occur if either data has been written or min-

utes have passed since the last checkpoint. Both arguments

default to zero, in which case they are ignored. See the Berke-

ley DB reference guide for more details. ddbbnnoossyynncc

Specify that on-disk database contents should not be immediately

synchronized with in memory changes. Enabling this option may improve performance at the expense of data security. ddiirreeccttoorryy <>

Specify the directory where the BDB files containing this data-

base and associated indexes live. A separate directory must be

specified for each database. The default is //vvaarr//ddbb//ooppeennll-

ddaapp//ooppeennllddaapp-ddaattaa.

ddiirrttyyrreeaadd Allow reads of modified but not yet committed data. Usually transactions are isolated to prevent other operations from

accessing uncommitted data. This option may improve perfor-

mance, but may also return inconsistent results if the data comes from a transaction that is later aborted. In this case, the modified data is discarded and a subsequent search will return a different result. iiddllccaacchheessiizzee <>

Specify the size of the in-memory index cache, in index slots.

The default is zero. A larger value will speed up frequent searches of indexed entries. iinnddeexx {{<>||ddeeffaauulltt}} [[pprreess,,eeqq,,aapppprrooxx,,ssuubb,,<>]] Specify the indexes to maintain for the given attribute (or list of attributes). Some attributes only support a subset of indexes. If only an is given, the indices specified for ddeeffaauulltt are maintained. Note that setting a default does not imply that all attributes will be indexed. A number of special index parameters may be specified. The index type ssuubb can be decomposed into ssuubbiinniittiiaall, ssuubbaannyy, and ssuubbffiinnaall indices. The special type nnoollaanngg may be specified to disallow use of this index by language subtypes. The special type nnoossuubbttyyppeess may be specified to disallow use of this index by named subtypes. Note: changing index settings requires rebuilding indices, see ssllaappiinnddeexx(8). lloocckkddeetteecctt {{oollddeesstt||yyoouunnggeesstt||ffeewweesstt||rraannddoomm||ddeeffaauulltt}} Specify which transaction to abort when a deadlock is detected. The default is the same as rraannddoomm. mmooddee <> Specify the file protection mode that newly created database index files should have. The default is 0600. sseeaarrcchhssttaacckk <>

Specify the depth of the stack used for search filter evalua-

tion. Search filters are evaluated on a stack to accommodate nested AND / OR clauses. An individual stack is assigned to each server thread. The depth of the stack determines how complex a filter can be evaluated without requiring any additional memory allocation. Filters that are nested deeper than the search stack

depth will cause a separate stack to be allocated for that par-

ticular search operation. These allocations can have a major negative impact on server performance, but specifying too much stack will also consume a great deal of memory. Each search stack uses 512K bytes per level. The default stack depth is 16, thus 8MB per thread is used. sshhmmkkeeyy <> Specify a key for a shared memory BDB environment. By default

the BDB environment uses memory mapped files. If a non-zero

value is specified, it will be used as the key to identify a shared memory region that will house the environment. sseessssiioonnlloogg <> <> Specify a session log store for the syncrepl replication provider server. The session log store contains information on

the entries that have been scoped out of the provider replica-

tion content identified by <>.. The number of entries in the session log store is limited by <>.. Excessive entries are removed from the store in the FIFO order. Both <> and

<> are non-negative integers. <> has no more than three

decimal digits. Refer to the "OpenLDAP Administrator's Guide"

for detailed information on setting up a replicated slapd direc-

tory service using the syncrepl replication engine and the ses-

sion log store. FILES /etc/openldap/slapd.conf default slapd configuration file DBCONFIG Berkeley DB configuration file