]> git.sur5r.net Git - openldap/blob - doc/man/man5/slapd-bdb.5
clarify the use of regex and expand in by dn clauses
[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 details on
22 .B DB_CONFIG
23 configuration options.
24 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 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.
50 .TP
51 .B dbnosync
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
55 security.
56 See the Berkeley DB reference guide for more details.
57 .TP
58 .B directory <directory>
59 Specify the directory where the BDB files containing this database and
60 associated indexes live.
61 A separate directory must be specified for each database.
62 The default is
63 .BR LOCALSTATEDIR/openldap-data .
64 .TP
65 .B dirtyread
66 Allow reads of modified but not yet committed data.
67 Usually transactions are isolated to prevent other operations from
68 accessing uncommitted data.
69 This option may improve performance, but may also return inconsistent
70 results if the data comes from a transaction that is later aborted.
71 In this case, the modified data is discarded and a subsequent search
72 will return a different result.
73 .TP
74 .B idlcachesize <integer>
75 Specify the size of the in-memory index cache, in index slots. The
76 default is zero. A larger value will speed up frequent searches of
77 indexed entries.
78 .TP
79 .B
80 index {<attrlist>|default} [pres,eq,approx,sub,<special>]
81 Specify the indexes to maintain for the given attribute (or
82 list of attributes).
83 Some attributes only support a subset of indexes.
84 If only an <attr> is given, the indices specified for \fBdefault\fR
85 are maintained.
86 Note that setting a default does not imply that all attributes will be
87 indexed.
88
89 A number of special index parameters may be specified.
90 The index type
91 .B sub
92 can be decomposed into
93 .BR subinitial ,
94 .BR subany ,\ and
95 .B subfinal
96 indices.
97 The special type
98 .B nolang
99 may be specified to disallow use of this index by language subtypes.
100 The special type
101 .B nosubtypes
102 may be specified to disallow use of this index by named subtypes.
103 Note: changing index settings requires rebuilding indices, see
104 .BR slapindex (8).
105 .TP
106 .B lockdetect {oldest|youngest|fewest|random|default}
107 Specify which transaction to abort when a deadlock is detected.
108 The default is the same as
109 .BR random .
110 .TP
111 .B mode <integer>
112 Specify the file protection mode that newly created database 
113 index files should have.
114 The default is 0600.
115 .TP
116 .B searchstack <depth>
117 Specify the depth of the stack used for search filter evaluation.
118 Search filters are evaluated on a stack to accommodate nested AND / OR
119 clauses. An individual stack is assigned to each server thread.
120 The depth of the stack determines how complex a filter can be
121 evaluated without requiring any additional memory allocation. Filters that
122 are nested deeper than the search stack depth will cause a separate
123 stack to be allocated for that particular search operation. These
124 allocations can have a major negative impact on server performance,
125 but specifying too much stack will also consume a great deal of memory.
126 Each search stack uses 512K bytes per level. The default stack depth
127 is 16, thus 8MB per thread is used.
128 .TP
129 .B shm_key <integer>
130 Specify a key for a shared memory BDB environment. By default the
131 BDB environment uses memory mapped files. If a non-zero value is
132 specified, it will be used as the key to identify a shared memory
133 region that will house the environment.
134 .TP
135 .B sessionlog <sid> <limit>
136 Specify a session log store for the syncrepl replication provider
137 server. The session log store contains information on the entries that
138 have been scoped out of the provider replication content identified by
139 .B <sid>.
140 The number of entries in the session log store is limited by
141 .B <limit>.
142 Excessive entries are removed from the store in the FIFO order.
143 Both
144 .B <sid>
145 and
146 .B <limit>
147 are non-negative integers.
148 .B <sid>
149 has no more than three decimal digits.
150 Refer to the "OpenLDAP Administrator's Guide" for detailed information
151 on setting up a replicated slapd directory service using the syncrepl
152 replication engine and the session log store.
153 .B
154 .SH FILES
155 .TP
156 ETCDIR/slapd.conf
157 default slapd configuration file
158 .TP
159 DB_CONFIG
160 Berkeley DB configuration file
161 .SH SEE ALSO
162 .BR slapd.conf (5),
163 .BR slapd (8),
164 .BR slapadd (8),
165 .BR slapcat (8),
166 .BR slapindex (8),
167 Berkeley DB documentation.