]> git.sur5r.net Git - openldap/blob - doc/man/man5/slapd-bdb.5
Add some comments about DB_CONFIG
[openldap] / doc / man / man5 / slapd-bdb.5
1 .TH SLAPD-BDB 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2003 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 It uses the Sleepycat Berkeley DB (BDB) package to store data.
14 It makes extensive use of indexing and caching to speed data access.
15 .TP
16 It is noted that these options are intended to complement
17 Berkeley DB configuration options set in the environment's
18 .B DB_CONFIG
19 file.  See Berkeley DB documentation for
20 details on
21 .B DB_CONFIG
22 configuration options.  Where there is overlap, settings in
23 .B DB_CONFIG
24 take precedence.
25 .SH CONFIGURATION
26 These
27 .B slapd.conf
28 options apply to the BDB backend database.
29 That is, they must follow a "database bdb" line and come before any
30 subsequent "backend" or "database" lines.
31 Other database options are described in the
32 .BR slapd.conf (5)
33 manual page.
34 .TP
35 .B cachesize <integer>
36 Specify the size in entries of the in-memory cache maintained 
37 by the BDB backend database instance.
38 The default is 1000 entries.
39 .TP
40 .B checkpoint <kbyte> <min>
41 Specify the frequency for checkpointing the database transaction log.
42 A checkpoint operation flushes the database buffers to disk and writes
43 a checkpoint record in the log.
44 The checkpoint will occur if either <kbyte> data has been written or
45 <min> minutes have passed since the last checkpoint.
46 Both arguments default to zero, in which case they are ignored.
47 See the Berkeley DB reference guide for more details.
48 .TP
49 .B dbnosync
50 Specify that on-disk database contents should not be immediately
51 synchronized with in memory changes.
52 Enabling this option may improve performance at the expense of data
53 security.
54 .TP
55 .B directory <directory>
56 Specify the directory where the BDB files containing this database and
57 associated indexes live.
58 A separate directory must be specified for each database.
59 The default is
60 .BR LOCALSTATEDIR/openldap-data .
61 .TP
62 .B dirtyread
63 Allow reads of modified but not yet committed data.
64 Usually transactions are isolated to prevent other operations from
65 accessing uncommitted data.
66 This option may improve performance, but may also return inconsistent
67 results if the data comes from a transaction that is later aborted.
68 In this case, the modified data is discarded and a subsequent search
69 will return a different result.
70 .TP
71 .B
72 index {<attrlist>|default} [pres,eq,approx,sub,<special>]
73 Specify the indexes to maintain for the given attribute (or
74 list of attributes).
75 Some attributes only support a subset of indexes.
76 If only an <attr> is given, the indices specified for \fBdefault\fR
77 are maintained.
78 Note that setting a default does not imply that all attributes will be
79 indexed.
80
81 A number of special index parameters may be specified.
82 The index type
83 .B sub
84 can be decomposed into
85 .BR subinitial ,
86 .BR subany ,\ and
87 .B subfinal
88 indices.
89 The special type
90 .B nolang
91 may be specified to disallow use of this index by language subtypes.
92 The special type
93 .B nosubtypes
94 may be specified to disallow use of this index by named subtypes.
95 Note: changing index settings requires rebuilding indices, see
96 .BR slapindex (8).
97 .TP
98 .B lockdetect {oldest|youngest|fewest|random|default}
99 Specify which transaction to abort when a deadlock is detected.
100 The default is the same as
101 .BR random .
102 .TP
103 .B mode <integer>
104 Specify the file protection mode that newly created database 
105 index files should have.
106 The default is 0600.
107 .TP
108 .B searchstack <depth>
109 Specify the depth of the stack used for search filter evaluation.
110 Search filters are evaluated on a stack to accomodate nested AND / OR
111 clauses. An individual stack is assigned to each server thread.
112 The depth of the stack determines how complex a filter can be
113 evaluated without requiring any additional memory allocation. Filters that
114 are nested deeper than the search stack depth will cause a separate
115 stack to be allocated for that particular search operation. These
116 allocations can have a major negative impact on server performance,
117 but specifying too much stack will also consume a great deal of memory.
118 Each search stack uses 512K bytes per level. The default stack depth
119 is 16, thus 8MB per thread is used.
120 .SH FILES
121 .TP
122 ETCDIR/slapd.conf
123 default slapd configuration file
124 .TP
125 DB_CONFIG
126 Berkeley DB configuration file
127 .SH SEE ALSO
128 .BR slapd.conf (5),
129 .BR slapd (8),
130 .BR slapadd (8),
131 .BR slapcat (8),
132 .BR slapindex (8),
133 .BR Berkeley DB documentation .