1 .TH SLAPD-BDB 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2005 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 details on
23 configuration options.
24 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. When
49 the <min> argument is non-zero, an internal task will run every <min>
50 minutes to perform the checkpoint.
51 See the Berkeley DB reference guide for more details.
54 Specify that on-disk database contents should not be immediately
55 synchronized with in memory changes.
56 Enabling this option may improve performance at the expense of data
58 See the Berkeley DB reference guide for more details.
60 .B directory <directory>
61 Specify the directory where the BDB files containing this database and
62 associated indexes live.
63 A separate directory must be specified for each database.
65 .BR LOCALSTATEDIR/openldap-data .
68 Allow reads of modified but not yet committed data.
69 Usually transactions are isolated to prevent other operations from
70 accessing uncommitted data.
71 This option may improve performance, but may also return inconsistent
72 results if the data comes from a transaction that is later aborted.
73 In this case, the modified data is discarded and a subsequent search
74 will return a different result.
76 .B idlcachesize <integer>
77 Specify the size of the in-memory index cache, in index slots. The
78 default is zero. A larger value will speed up frequent searches of
82 index {<attrlist>|default} [pres,eq,approx,sub,<special>]
83 Specify the indexes to maintain for the given attribute (or
85 Some attributes only support a subset of indexes.
86 If only an <attr> is given, the indices specified for \fBdefault\fR
88 Note that setting a default does not imply that all attributes will be
89 indexed. Also, for best performance, an
91 index should always be configured for the
95 A number of special index parameters may be specified.
98 can be decomposed into
105 may be specified to disallow use of this index by language subtypes.
108 may be specified to disallow use of this index by named subtypes.
109 Note: changing index settings requires rebuilding indices, see
113 Tell slapindex to index one attribute at a time. By default, all indexed
114 attributes in an entry are processed at the same time. With this option,
115 each indexed attribute is processed individually, using multiple passes
116 through the entire database. This option improves slapindex performance
117 when the database size exceeds the dbcache size. When the dbcache is
118 large enough, this option is not needed and will decrease performance.
119 Also by default, slapadd performs full indexing and so a separate slapindex
120 run is not needed. With this option, slapadd does no indexing and slapindex
123 .B lockdetect {oldest|youngest|fewest|random|default}
124 Specify which transaction to abort when a deadlock is detected.
125 The default is the same as
129 Specify the file protection mode that newly created database
130 index files should have.
133 .B searchstack <depth>
134 Specify the depth of the stack used for search filter evaluation.
135 Search filters are evaluated on a stack to accommodate nested AND / OR
136 clauses. An individual stack is assigned to each server thread.
137 The depth of the stack determines how complex a filter can be
138 evaluated without requiring any additional memory allocation. Filters that
139 are nested deeper than the search stack depth will cause a separate
140 stack to be allocated for that particular search operation. These
141 allocations can have a major negative impact on server performance,
142 but specifying too much stack will also consume a great deal of memory.
143 Each search stack uses 512K bytes per level. The default stack depth
144 is 16, thus 8MB per thread is used.
147 Specify a key for a shared memory BDB environment. By default the
148 BDB environment uses memory mapped files. If a non-zero value is
149 specified, it will be used as the key to identify a shared memory
150 region that will house the environment.
155 default slapd configuration file
158 Berkeley DB configuration file
165 Berkeley DB documentation.
projects / openldap / blob