slapd-bdb.5 7.54 KB
Newer Older
1
.TH SLAPD-BDB 5 "RELEASEDATE" "OpenLDAP LDVERSION"
Kurt Zeilenga's avatar
Kurt Zeilenga committed
2
.\" Copyright 1998-2007 The OpenLDAP Foundation All Rights Reserved.
3
4
5
.\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
.\" $OpenLDAP$
.SH NAME
Kurt Zeilenga's avatar
Kurt Zeilenga committed
6
\fBslapd-bdb\fP, \fBslapd-hdb\fP \- Berkeley DB backends to \fBslapd\fP
7
.SH SYNOPSIS
Kurt Zeilenga's avatar
Kurt Zeilenga committed
8
.B ETCDIR/slapd.conf
9
.SH DESCRIPTION
Kurt Zeilenga's avatar
Kurt Zeilenga committed
10
The \fBbdb\fP backend to
11
.BR slapd (8)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
12
is the recommended primary backend for a normal 
Kurt Zeilenga's avatar
Kurt Zeilenga committed
13
14
.B slapd 
database.
Gavin Henry's avatar
Gavin Henry committed
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.
17
.LP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
18
19
\fBhdb\fP is a variant of the \fBbdb\fP backend that uses a 
hierarchical database
Kurt Zeilenga's avatar
Kurt Zeilenga committed
20
layout which supports subtree renames. It is otherwise identical to
Kurt Zeilenga's avatar
Kurt Zeilenga committed
21
the \fBbdb\fP behavior, and all the same configuration options apply.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
22
.LP
23
24
25
It is noted that these options are intended to complement
Berkeley DB configuration options set in the environment's
.B DB_CONFIG
26
file.  See Berkeley DB documentation for details on
27
.B DB_CONFIG
28
configuration options.
29
30
31
Where there is overlap, settings in
.B DB_CONFIG
take precedence.
32
.SH CONFIGURATION
Pierangelo Masarati's avatar
Pierangelo Masarati committed
33
34
These
.B slapd.conf
Kurt Zeilenga's avatar
Kurt Zeilenga committed
35
options apply to the \fBbdb\fP and \fBhdb\fP backend database.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
36
37
That is, they must follow a "database bdb" or "database hdb" line and
come before any subsequent "backend" or "database" lines.
Pierangelo Masarati's avatar
Pierangelo Masarati committed
38
39
40
Other database options are described in the
.BR slapd.conf (5)
manual page.
41
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
42
.BI cachesize \ <integer>
Kurt Zeilenga's avatar
Kurt Zeilenga committed
43
Specify the size in entries of the in-memory entry cache maintained 
Kurt Zeilenga's avatar
Kurt Zeilenga committed
44
by the \fBbdb\fP or \fBhdb\fP backend database instance.
45
The default is 1000 entries.
46
.TP
47
48
49
50
51
.BI cachefree \ <integer>
Specify the number of entries to free from the entry cache when the
cache reaches the \fBcachesize\fP limit.
The default is 1 entry.
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
52
.BI checkpoint \ <kbyte>\ <min>
53
54
55
Specify the frequency for checkpointing the database transaction log.
A checkpoint operation flushes the database buffers to disk and writes
a checkpoint record in the log.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
56
57
The checkpoint will occur if either \fI<kbyte>\fP data has been written or
\fI<min>\fP minutes have passed since the last checkpoint.
58
Both arguments default to zero, in which case they are ignored. When
Kurt Zeilenga's avatar
Kurt Zeilenga committed
59
60
the \fI<min>\fP argument is non-zero, an internal task will run every 
\fI<min>\fP minutes to perform the checkpoint.
61
62
See the Berkeley DB reference guide for more details.
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
63
.BI dbconfig \ <Berkeley\-DB\-setting>
64
65
66
67
68
69
70
71
Specify a configuration directive to be placed in the
.B DB_CONFIG
file of the database directory. The
.B dbconfig
directive is just a convenience
to allow all necessary configuration to be set in the
.B slapd.conf
file.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
72
73
The options set using this directive will only be written to the 
.B DB_CONFIG
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
74
75
file if no such file existed at server startup time, otherwise
they are completely ignored. This allows one
Kurt Zeilenga's avatar
Kurt Zeilenga committed
76
77
78
79
80
to set initial values without overwriting/destroying a 
.B DB_CONFIG 
file that was already customized through other means. 
This directive may be specified multiple times, as needed. 
For example:
81
82
83
84
85
86
87
.RS
.nf
	dbconfig set_cachesize 0 1048576 0
	dbconfig set_lg_bsize 2097152
.fi
.RE
.TP
88
89
90
91
92
93
.B dbnosync
Specify that on-disk database contents should not be immediately
synchronized with in memory changes.
Enabling this option may improve performance at the expense of data
security.
See the Berkeley DB reference guide for more details.
94
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
95
.BI directory \ <directory>
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
Specify the directory where the BDB files containing this database and
associated indexes live.
A separate directory must be specified for each database.
The default is
.BR LOCALSTATEDIR/openldap-data .
.TP
.B dirtyread
Allow reads of modified but not yet committed data.
Usually transactions are isolated to prevent other operations from
accessing uncommitted data.
This option may improve performance, but may also return inconsistent
results if the data comes from a transaction that is later aborted.
In this case, the modified data is discarded and a subsequent search
will return a different result.
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
111
.BI idlcachesize \ <integer>
112
113
Specify the size of the in-memory index cache, in index slots. The
default is zero. A larger value will speed up frequent searches of
Kurt Zeilenga's avatar
Kurt Zeilenga committed
114
115
116
117
indexed entries. An \fBhdb\fP database needs a large \fBidlcachesize\fP
for good search performance, typically three times the 
.B cachesize
(entry cache size)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
118
or larger.
119
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
120
\fBindex \fR{\fI<attrlist>\fR|\fBdefault\fR} [\fBpres\fR,\fBeq\fR,\fBapprox\fR,\fBsub\fR,\fI<special>\fR]
121
122
123
Specify the indexes to maintain for the given attribute (or
list of attributes).
Some attributes only support a subset of indexes.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
124
If only an \fI<attr>\fP is given, the indices specified for \fBdefault\fR
125
126
are maintained.
Note that setting a default does not imply that all attributes will be
Kurt Zeilenga's avatar
Kurt Zeilenga committed
127
128
129
130
131
indexed. Also, for best performance, an
.B eq
index should always be configured for the
.B objectClass
attribute.
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

A number of special index parameters may be specified.
The index type
.B sub
can be decomposed into
.BR subinitial ,
.BR subany ,\ and
.B subfinal
indices.
The special type
.B nolang
may be specified to disallow use of this index by language subtypes.
The special type
.B nosubtypes
may be specified to disallow use of this index by named subtypes.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
147
148
149
150
151
152
153
Note: changing \fBindex\fP settings in 
.BR slapd.conf (5)
requires rebuilding indices, see
.BR slapindex (8);
changing \fBindex\fP settings
dynamically by LDAPModifying "cn=config" automatically causes rebuilding
of the indices online in a background task.
154
.TP
155
.B linearindex
Kurt Zeilenga's avatar
Kurt Zeilenga committed
156
157
158
Tell 
.B slapindex 
to index one attribute at a time. By default, all indexed
159
160
attributes in an entry are processed at the same time. With this option,
each indexed attribute is processed individually, using multiple passes
Kurt Zeilenga's avatar
Kurt Zeilenga committed
161
162
163
164
through the entire database. This option improves 
.B slapindex 
performance
when the database size exceeds the \fBdbcache\fP size. When the \fBdbcache\fP is
165
large enough, this option is not needed and will decrease performance.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
166
167
168
169
170
171
172
173
Also by default, 
.B slapadd 
performs full indexing and so a separate 
.B slapindex
run is not needed. With this option, 
.B slapadd 
does no indexing and 
.B slapindex
174
must be used.
175
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
176
.BR lockdetect \ { oldest | youngest | fewest | random | default }
177
Specify which transaction to abort when a deadlock is detected.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
178
The default is
179
180
.BR random .
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
181
.BI mode \ <integer>
182
183
184
Specify the file protection mode that newly created database 
index files should have.
The default is 0600.
185
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
186
.BI searchstack \ <depth>
187
Specify the depth of the stack used for search filter evaluation.
188
Search filters are evaluated on a stack to accommodate nested AND / OR
189
190
191
192
193
194
195
196
197
clauses. An individual stack is assigned to each server thread.
The depth of the stack determines how complex a filter can be
evaluated without requiring any additional memory allocation. Filters that
are nested deeper than the search stack depth will cause a separate
stack to be allocated for that particular search operation. These
allocations can have a major negative impact on server performance,
but specifying too much stack will also consume a great deal of memory.
Each search stack uses 512K bytes per level. The default stack depth
is 16, thus 8MB per thread is used.
198
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
199
.BI shm_key \ <integer>
200
201
202
203
Specify a key for a shared memory BDB environment. By default the
BDB environment uses memory mapped files. If a non-zero value is
specified, it will be used as the key to identify a shared memory
region that will house the environment.
204
205
206
207
208
209
210
.SH ACCESS CONTROL
The 
.B bdb
and
.B hdb
backends honor access control semantics as indicated in
.BR slapd.access (5).
Pierangelo Masarati's avatar
Pierangelo Masarati committed
211
.SH FILES
212
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
213
214
215
216
.B ETCDIR/slapd.conf
default 
.B slapd 
configuration file
217
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
218
.B DB_CONFIG
219
Berkeley DB configuration file
220
221
222
223
224
.SH SEE ALSO
.BR slapd.conf (5),
.BR slapd (8),
.BR slapadd (8),
.BR slapcat (8),
225
.BR slapindex (8),
226
Berkeley DB documentation.