1 .TH SLAPD-MDB 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 2011 The OpenLDAP Foundation All Rights Reserved.
3 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 slapd\-mdb \- Memory-Mapped DB backend to slapd
10 The \fBmdb\fP backend to
12 uses OpenLDAP's own Memory-Mapped DB (MDB) library to store data.
13 It relies completely on the underlying operating system for memory
14 management and does no caching of its own.
16 The \fBmdb\fP backend is similar to the \fBhdb\fP backend in that
17 it uses a hierarchical database layout which
18 supports subtree renames. It is both more space-efficient and more
19 execution-efficient than the \fBbdb\fP backend, while being overall
20 much simpler to manage.
24 options apply to the \fBmdb\fP backend database.
25 That is, they must follow a "database mdb" line and
26 come before any subsequent "backend" or "database" lines.
27 Other database options are described in the
31 .BI checkpoint \ <kbyte>\ <min>
32 Specify the frequency for flushing the database disk buffers.
33 This setting is only needed if the \fBdbnosync\fP option is used.
34 Note: this feature is not yet implemented.
35 The checkpoint will occur if either \fI<kbyte>\fP data has been written or
36 \fI<min>\fP minutes have passed since the last checkpoint.
37 Both arguments default to zero, in which case they are ignored. When
38 the \fI<min>\fP argument is non-zero, an internal task will run every
39 \fI<min>\fP minutes to perform the checkpoint.
42 Specify that on-disk database contents should not be immediately
43 synchronized with in memory changes.
44 Enabling this option may improve performance at the expense of data
45 security. By default, a full data flush/sync is performed when each
46 transaction is committed.
48 .BI directory \ <directory>
49 Specify the directory where the MDB files containing this database and
50 associated indexes live.
51 A separate directory must be specified for each database.
53 .BR LOCALSTATEDIR/openldap\-data .
55 \fBindex \fR{\fI<attrlist>\fR|\fBdefault\fR} [\fBpres\fR,\fBeq\fR,\fBapprox\fR,\fBsub\fR,\fI<special>\fR]
56 Specify the indexes to maintain for the given attribute (or
58 Some attributes only support a subset of indexes.
59 If only an \fI<attr>\fP is given, the indices specified for \fBdefault\fR
61 Note that setting a default does not imply that all attributes will be
62 indexed. Also, for best performance, an
64 index should always be configured for the
68 A number of special index parameters may be specified.
71 can be decomposed into
78 may be specified to disallow use of this index by language subtypes.
81 may be specified to disallow use of this index by named subtypes.
82 Note: changing \fBindex\fP settings in
84 requires rebuilding indices, see
86 changing \fBindex\fP settings
87 dynamically by LDAPModifying "cn=config" automatically causes rebuilding
88 of the indices online in a background task.
91 Specify the maximum size of the database in bytes. A memory map of this
92 size is allocated at startup time and the database will not be allowed
93 to grow beyond this size. The default is 10485760 bytes. This setting
94 may be changed upward if the configured limit needs to be increased.
96 Note: It is important to set this to as large a value as possible,
97 (relative to anticipated growth of the actual data over time) since
98 growing the size later may not be practical when the system is under
102 Specify the file protection mode that newly created database
106 .BI searchstack \ <depth>
107 Specify the depth of the stack used for search filter evaluation.
108 Search filters are evaluated on a stack to accommodate nested AND / OR
109 clauses. An individual stack is assigned to each server thread.
110 The depth of the stack determines how complex a filter can be
111 evaluated without requiring any additional memory allocation. Filters that
112 are nested deeper than the search stack depth will cause a separate
113 stack to be allocated for that particular search operation. These
114 allocations can have a major negative impact on server performance,
115 but specifying too much stack will also consume a great deal of memory.
116 Each search stack uses 512K bytes per level. The default stack depth
117 is 16, thus 8MB per thread is used.
121 backend honors access control semantics as indicated in
122 .BR slapd.access (5).
131 .BR slapd\-config (5),
136 OpenLDAP MDB documentation.
139 Written by Howard Chu.