1 .TH SLAPD-BDB 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2007 The OpenLDAP Foundation All Rights Reserved.
3 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 slapd-bdb, slapd-hdb \- Berkeley DB backends to slapd
10 The \fBbdb\fP backend to
12 is the recommended primary backend for a normal
15 It uses the Oracle Berkeley DB (BDB) package to store data.
16 It makes extensive use of indexing and caching to speed data access.
18 \fBhdb\fP is a variant of the \fBbdb\fP backend that uses a
20 layout which supports subtree renames. It is otherwise identical to
21 the \fBbdb\fP behavior, and all the same configuration options apply.
23 It is noted that these options are intended to complement
24 Berkeley DB configuration options set in the environment's
26 file. See Berkeley DB documentation for details on
28 configuration options.
29 Where there is overlap, settings in
35 options apply to the \fBbdb\fP and \fBhdb\fP backend database.
36 That is, they must follow a "database bdb" or "database hdb" line and
37 come before any subsequent "backend" or "database" lines.
38 Other database options are described in the
42 .BI cachesize \ <integer>
43 Specify the size in entries of the in-memory entry cache maintained
44 by the \fBbdb\fP or \fBhdb\fP backend database instance.
45 The default is 1000 entries.
47 .BI cachefree \ <integer>
48 Specify the number of entries to free from the entry cache when the
49 cache reaches the \fBcachesize\fP limit.
50 The default is 1 entry.
52 .BI checkpoint \ <kbyte>\ <min>
53 Specify the frequency for checkpointing the database transaction log.
54 A checkpoint operation flushes the database buffers to disk and writes
55 a checkpoint record in the log.
56 The checkpoint will occur if either \fI<kbyte>\fP data has been written or
57 \fI<min>\fP minutes have passed since the last checkpoint.
58 Both arguments default to zero, in which case they are ignored. When
59 the \fI<min>\fP argument is non-zero, an internal task will run every
60 \fI<min>\fP minutes to perform the checkpoint.
61 See the Berkeley DB reference guide for more details.
63 .BI dbconfig \ <Berkeley\-DB\-setting>
64 Specify a configuration directive to be placed in the
66 file of the database directory. The
68 directive is just a convenience
69 to allow all necessary configuration to be set in the
72 The options set using this directive will only be written to the
74 file if no such file existed at server startup time. This allows one
75 to set initial values without overwriting/destroying a
77 file that was already customized through other means.
78 This directive may be specified multiple times, as needed.
82 dbconfig set_cachesize 0 1048576 0
83 dbconfig set_lg_bsize 2097152
88 Specify that on-disk database contents should not be immediately
89 synchronized with in memory changes.
90 Enabling this option may improve performance at the expense of data
92 See the Berkeley DB reference guide for more details.
94 .BI directory \ <directory>
95 Specify the directory where the BDB files containing this database and
96 associated indexes live.
97 A separate directory must be specified for each database.
99 .BR LOCALSTATEDIR/openldap-data .
102 Allow reads of modified but not yet committed data.
103 Usually transactions are isolated to prevent other operations from
104 accessing uncommitted data.
105 This option may improve performance, but may also return inconsistent
106 results if the data comes from a transaction that is later aborted.
107 In this case, the modified data is discarded and a subsequent search
108 will return a different result.
110 .BI dncachesize \ <integer>
111 Specify the maximum number of DNs in the in-memory DN cache. The
112 default is twice the \fBcachesize\fP. Ideally this cache should be
113 large enough to contain the DNs of every entry in the database.
115 .BI idlcachesize \ <integer>
116 Specify the size of the in-memory index cache, in index slots. The
117 default is zero. A larger value will speed up frequent searches of
118 indexed entries. An \fBhdb\fP database needs a large \fBidlcachesize\fP
119 for good search performance, typically three times the
124 \fBindex \fR{\fI<attrlist>\fR|\fBdefault\fR} [\fBpres\fR,\fBeq\fR,\fBapprox\fR,\fBsub\fR,\fI<special>\fR]
125 Specify the indexes to maintain for the given attribute (or
127 Some attributes only support a subset of indexes.
128 If only an \fI<attr>\fP is given, the indices specified for \fBdefault\fR
130 Note that setting a default does not imply that all attributes will be
131 indexed. Also, for best performance, an
133 index should always be configured for the
137 A number of special index parameters may be specified.
140 can be decomposed into
147 may be specified to disallow use of this index by language subtypes.
150 may be specified to disallow use of this index by named subtypes.
151 Note: changing \fBindex\fP settings in
153 requires rebuilding indices, see
155 changing \fBindex\fP settings
156 dynamically by LDAPModifying "cn=config" automatically causes rebuilding
157 of the indices online in a background task.
162 to index one attribute at a time. By default, all indexed
163 attributes in an entry are processed at the same time. With this option,
164 each indexed attribute is processed individually, using multiple passes
165 through the entire database. This option improves
168 when the database size exceeds the \fBdbcache\fP size. When the \fBdbcache\fP is
169 large enough, this option is not needed and will decrease performance.
172 performs full indexing and so a separate
174 run is not needed. With this option,
180 .BR lockdetect \ { oldest | youngest | fewest | random | default }
181 Specify which transaction to abort when a deadlock is detected.
186 Specify the file protection mode that newly created database
187 index files should have.
190 .BI searchstack \ <depth>
191 Specify the depth of the stack used for search filter evaluation.
192 Search filters are evaluated on a stack to accommodate nested AND / OR
193 clauses. An individual stack is assigned to each server thread.
194 The depth of the stack determines how complex a filter can be
195 evaluated without requiring any additional memory allocation. Filters that
196 are nested deeper than the search stack depth will cause a separate
197 stack to be allocated for that particular search operation. These
198 allocations can have a major negative impact on server performance,
199 but specifying too much stack will also consume a great deal of memory.
200 Each search stack uses 512K bytes per level. The default stack depth
201 is 16, thus 8MB per thread is used.
203 .BI shm_key \ <integer>
204 Specify a key for a shared memory BDB environment. By default the
205 BDB environment uses memory mapped files. If a non-zero value is
206 specified, it will be used as the key to identify a shared memory
207 region that will house the environment.
213 backends honor access control semantics as indicated in
214 .BR slapd.access (5).
223 Berkeley DB configuration file
230 Berkeley DB documentation.
233 Originally begun by Kurt Zeilenga. Caching mechanisms originally designed
234 by Jong-Hyuk Choi. Completion and subsequent work, as well as
235 back-hdb, by Howard Chu.
projects / openldap / blob