]> git.sur5r.net Git - openldap/blob - doc/man/man5/slapd-bdb.5
Fix typos in prev commit
[openldap] / doc / man / man5 / slapd-bdb.5
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.
4 .\" $OpenLDAP$
5 .SH NAME
6 slapd-bdb \- BDB backend to slapd
7 .SH SYNOPSIS
8 ETCDIR/slapd.conf
9 .SH DESCRIPTION
10 The BDB backend to
11 .BR slapd (8)
12 is the recommended backend for a normal slapd database.
13 However, it takes more care than with the LDBM backend to configure
14 it properly.
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.
17 .LP
18 It is noted that these options are intended to complement
19 Berkeley DB configuration options set in the environment's
20 .B DB_CONFIG
21 file.  See Berkeley DB documentation for
22 details on
23 .B DB_CONFIG
24 configuration options.  Where there is overlap, settings in
25 .B DB_CONFIG
26 take precedence.
27 .SH CONFIGURATION
28 These
29 .B slapd.conf
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
34 .BR slapd.conf (5)
35 manual page.
36 .TP
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.
41 .TP
42 .B checkpoint <kbyte> <min>
43 Specify the frequency for checkpointing the database transaction
44 log upon updating of the database.  A checkpoint flushes the
45 database buffers to disk and writes a checkpoint record in the log.
46 Upon a database update, a checkpoint will occur if either <kbyte>
47 data has been written or <min> minutes have passed since the last
48 checkpoint.  Both arguments default to zero, in which case they are
49 ignored.  Note: checkpointing by this directive occurs only upon execution of
50 a database update.  If one desires checkpointing to occur otherwise,
51 db_checkpoint(1) or some other external process should be used to cause
52 a database checkpoint to be taken.  See the Berkeley DB reference
53 guide for more details.
54 .TP
55 .B dbnosync
56 Specify that on-disk database contents should not be immediately
57 synchronized with in memory changes.
58 Enabling this option may improve performance at the expense of data
59 security.
60 .TP
61 .B directory <directory>
62 Specify the directory where the BDB files containing this database and
63 associated indexes live.
64 A separate directory must be specified for each database.
65 The default is
66 .BR LOCALSTATEDIR/openldap-data .
67 .TP
68 .B dirtyread
69 Allow reads of modified but not yet committed data.
70 Usually transactions are isolated to prevent other operations from
71 accessing uncommitted data.
72 This option may improve performance, but may also return inconsistent
73 results if the data comes from a transaction that is later aborted.
74 In this case, the modified data is discarded and a subsequent search
75 will return a different result.
76 .TP
77 .B idlcachesize <integer>
78 Specify the size of the in-memory index cache, in index slots. The
79 default is zero. A larger value will speed up frequent searches of
80 indexed entries.
81 .TP
82 .B
83 index {<attrlist>|default} [pres,eq,approx,sub,<special>]
84 Specify the indexes to maintain for the given attribute (or
85 list of attributes).
86 Some attributes only support a subset of indexes.
87 If only an <attr> is given, the indices specified for \fBdefault\fR
88 are maintained.
89 Note that setting a default does not imply that all attributes will be
90 indexed. Also, for best performance, an
91 .B eq
92 index should always be configured for the
93 .B objectClass
94 attribute.
95
96 A number of special index parameters may be specified.
97 The index type
98 .B sub
99 can be decomposed into
100 .BR subinitial ,
101 .BR subany ,\ and
102 .B subfinal
103 indices.
104 The special type
105 .B nolang
106 may be specified to disallow use of this index by language subtypes.
107 The special type
108 .B nosubtypes
109 may be specified to disallow use of this index by named subtypes.
110 Note: changing index settings requires rebuilding indices, see
111 .BR slapindex (8).
112 .TP
113 .B lockdetect {oldest|youngest|fewest|random|default}
114 Specify which transaction to abort when a deadlock is detected.
115 The default is the same as
116 .BR random .
117 .TP
118 .B mode <integer>
119 Specify the file protection mode that newly created database 
120 index files should have.
121 The default is 0600.
122 .TP
123 .B searchstack <depth>
124 Specify the depth of the stack used for search filter evaluation.
125 Search filters are evaluated on a stack to accommodate nested AND / OR
126 clauses. An individual stack is assigned to each server thread.
127 The depth of the stack determines how complex a filter can be
128 evaluated without requiring any additional memory allocation. Filters that
129 are nested deeper than the search stack depth will cause a separate
130 stack to be allocated for that particular search operation. These
131 allocations can have a major negative impact on server performance,
132 but specifying too much stack will also consume a great deal of memory.
133 Each search stack uses 512K bytes per level. The default stack depth
134 is 16, thus 8MB per thread is used.
135 .TP
136 .B shm_key <integer>
137 Specify a key for a shared memory BDB environment. By default the
138 BDB environment uses memory mapped files. If a non-zero value is
139 specified, it will be used as the key to identify a shared memory
140 region that will house the environment.
141 .TP
142 .B sessionlog <sid> <limit>
143 Specify a session log store for the syncrepl replication provider
144 server. The session log store contains information on the entries that
145 have been scoped out of the provider replication content identified by
146 .B <sid>.
147 The number of entries in the session log store is limited by
148 .B <limit>.
149 Excessive entries are removed from the store in the FIFO order.
150 Both
151 .B <sid>
152 and
153 .B <limit>
154 are non-negative integers.
155 .B <sid>
156 has no more than three decimal digits.
157 Refer to the "OpenLDAP Administrator's Guide" for detailed information
158 on setting up a replicated slapd directory service using the syncrepl
159 replication engine and the session log store.
160 .B
161 .SH FILES
162 .TP
163 ETCDIR/slapd.conf
164 default slapd configuration file
165 .TP
166 DB_CONFIG
167 Berkeley DB configuration file
168 .SH SEE ALSO
169 .BR slapd.conf (5),
170 .BR slapd (8),
171 .BR slapadd (8),
172 .BR slapcat (8),
173 .BR slapindex (8),
174 Berkeley DB documentation.