1 .TH SLAPD-BDB 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2004 The OpenLDAP Foundation All Rights Reserved.
3 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 slapd-bdb \- BDB backend to slapd
12 is the recommended backend for a normal slapd database.
13 However, it takes more care than with the LDBM backend to configure
15 It uses the Sleepycat Berkeley DB (BDB) package to store data.
16 It makes extensive use of indexing and caching to speed data access.
18 It is noted that these options are intended to complement
19 Berkeley DB configuration options set in the environment's
21 file. See Berkeley DB documentation for
24 configuration options. Where there is overlap, settings in
30 options apply to the BDB backend database.
31 That is, they must follow a "database bdb" line and come before any
32 subsequent "backend" or "database" lines.
33 Other database options are described in the
37 .B cachesize <integer>
38 Specify the size in entries of the in-memory cache maintained
39 by the BDB backend database instance.
40 The default is 1000 entries.
42 .B checkpoint <kbyte> <min>
43 Specify the frequency for checkpointing the database transaction log.
44 A checkpoint operation flushes the database buffers to disk and writes
45 a checkpoint record in the log.
46 The checkpoint will occur if either <kbyte> data has been written or
47 <min> minutes have passed since the last checkpoint.
48 Both arguments default to zero, in which case they are ignored.
49 See the Berkeley DB reference guide for more details.
52 Specify that on-disk database contents should not be immediately
53 synchronized with in memory changes.
54 Enabling this option may improve performance at the expense of data
57 .B directory <directory>
58 Specify the directory where the BDB files containing this database and
59 associated indexes live.
60 A separate directory must be specified for each database.
62 .BR LOCALSTATEDIR/openldap-data .
65 Allow reads of modified but not yet committed data.
66 Usually transactions are isolated to prevent other operations from
67 accessing uncommitted data.
68 This option may improve performance, but may also return inconsistent
69 results if the data comes from a transaction that is later aborted.
70 In this case, the modified data is discarded and a subsequent search
71 will return a different result.
73 .B idlcachesize <integer>
74 Specify the size of the in-memory index cache, in index slots. The
75 default is zero. A larger value will speed up frequent searches of
79 index {<attrlist>|default} [pres,eq,approx,sub,<special>]
80 Specify the indexes to maintain for the given attribute (or
82 Some attributes only support a subset of indexes.
83 If only an <attr> is given, the indices specified for \fBdefault\fR
85 Note that setting a default does not imply that all attributes will be
88 A number of special index parameters may be specified.
91 can be decomposed into
98 may be specified to disallow use of this index by language subtypes.
101 may be specified to disallow use of this index by named subtypes.
102 Note: changing index settings requires rebuilding indices, see
105 .B lockdetect {oldest|youngest|fewest|random|default}
106 Specify which transaction to abort when a deadlock is detected.
107 The default is the same as
111 Specify the file protection mode that newly created database
112 index files should have.
115 .B searchstack <depth>
116 Specify the depth of the stack used for search filter evaluation.
117 Search filters are evaluated on a stack to accommodate nested AND / OR
118 clauses. An individual stack is assigned to each server thread.
119 The depth of the stack determines how complex a filter can be
120 evaluated without requiring any additional memory allocation. Filters that
121 are nested deeper than the search stack depth will cause a separate
122 stack to be allocated for that particular search operation. These
123 allocations can have a major negative impact on server performance,
124 but specifying too much stack will also consume a great deal of memory.
125 Each search stack uses 512K bytes per level. The default stack depth
126 is 16, thus 8MB per thread is used.
129 Specify a key for a shared memory BDB environment. By default the
130 BDB environment uses memory mapped files. If a non-zero value is
131 specified, it will be used as the key to identify a shared memory
132 region that will house the environment.
134 .B sessionlog <sid> <limit>
135 Specify a session log store for the syncrepl replication provider
136 server. The session log store contains information on the entries that
137 have been scoped out of the provider replication content identified by
139 The number of entries in the session log store is limited by
141 Excessive entries are removed from the store in the FIFO order.
146 are non-negative integers.
148 has no more than three decimal digits.
149 Refer to the "OpenLDAP Administrator's Guide" for detailed information
150 on setting up a replicated slapd directory service using the syncrepl
151 replication engine and the session log store.
156 default slapd configuration file
159 Berkeley DB configuration file
166 Berkeley DB documentation.