git.sur5r.net Git - openldap/blob - doc/man/man5/slapd-mdb.5

   1 .TH SLAPD-MDB 5 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" Copyright 2011 The OpenLDAP Foundation All Rights Reserved.
   3 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   4 .\" $OpenLDAP$
   5 .SH NAME
   6 slapd\-mdb \- Memory-Mapped DB backend to slapd
   7 .SH SYNOPSIS
   8 .B ETCDIR/slapd.conf
   9 .SH DESCRIPTION
  10 The \fBmdb\fP backend to
  11 .BR slapd (8)
  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.
  15 .LP
  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.
  21 .SH CONFIGURATION
  22 These
  23 .B slapd.conf
  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
  28 .BR slapd.conf (5)
  29 manual page.
  30 .TP
  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 The checkpoint will occur if either \fI<kbyte>\fP data has been written or
  35 \fI<min>\fP minutes have passed since the last checkpoint.
  36 Both arguments default to zero, in which case they are ignored. When
  37 the \fI<min>\fP argument is non-zero, an internal task will run every
  38 \fI<min>\fP minutes to perform the checkpoint.
  39 Note: currently the \fI<kbyte>\fP setting is unimplemented.
  40 .TP
  41 .B dbnosync
  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.
  47 .TP
  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.
  52 The default is
  53 .BR LOCALSTATEDIR/openldap\-data .
  54 .TP
  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
  57 list of attributes).
  58 Some attributes only support a subset of indexes.
  59 If only an \fI<attr>\fP is given, the indices specified for \fBdefault\fR
  60 are maintained.
  61 Note that setting a default does not imply that all attributes will be
  62 indexed. Also, for best performance, an
  63 .B eq
  64 index should always be configured for the
  65 .B objectClass
  66 attribute.
  67
  68 A number of special index parameters may be specified.
  69 The index type
  70 .B sub
  71 can be decomposed into
  72 .BR subinitial ,
  73 .BR subany ,\ and
  74 .B subfinal
  75 indices.
  76 The special type
  77 .B nolang
  78 may be specified to disallow use of this index by language subtypes.
  79 The special type
  80 .B nosubtypes
  81 may be specified to disallow use of this index by named subtypes.
  82 Note: changing \fBindex\fP settings in
  83 .BR slapd.conf (5)
  84 requires rebuilding indices, see
  85 .BR slapindex (8);
  86 changing \fBindex\fP settings
  87 dynamically by LDAPModifying "cn=config" automatically causes rebuilding
  88 of the indices online in a background task.
  89 .TP
  90 .BI maxreaders \ <integer>
  91 Specify the maximum number of threads that may have concurrent read access
  92 to the database. Tools such as slapcat count as a single thread,
  93 in addition to threads in any active slapd processes. The
  94 default is 126.
  95 .TP
  96 .BI maxsize \ <bytes>
  97 Specify the maximum size of the database in bytes. A memory map of this
  98 size is allocated at startup time and the database will not be allowed
  99 to grow beyond this size. The default is 10485760 bytes. This setting
 100 may be changed upward if the configured limit needs to be increased.
 101
 102 Note: It is important to set this to as large a value as possible,
 103 (relative to anticipated growth of the actual data over time) since
 104 growing the size later may not be practical when the system is under
 105 heavy load.
 106 .TP
 107 .BI mode \ <integer>
 108 Specify the file protection mode that newly created database
 109 files should have.
 110 The default is 0600.
 111 .TP
 112 .BI searchstack \ <depth>
 113 Specify the depth of the stack used for search filter evaluation.
 114 Search filters are evaluated on a stack to accommodate nested AND / OR
 115 clauses. An individual stack is assigned to each server thread.
 116 The depth of the stack determines how complex a filter can be
 117 evaluated without requiring any additional memory allocation. Filters that
 118 are nested deeper than the search stack depth will cause a separate
 119 stack to be allocated for that particular search operation. These
 120 allocations can have a major negative impact on server performance,
 121 but specifying too much stack will also consume a great deal of memory.
 122 Each search stack uses 512K bytes per level. The default stack depth
 123 is 16, thus 8MB per thread is used.
 124 .SH ACCESS CONTROL
 125 The
 126 .B mdb
 127 backend honors access control semantics as indicated in
 128 .BR slapd.access (5).
 129 .SH FILES
 130 .TP
 131 .B ETCDIR/slapd.conf
 132 default
 133 .B slapd
 134 configuration file
 135 .SH SEE ALSO
 136 .BR slapd.conf (5),
 137 .BR slapd\-config (5),
 138 .BR slapd (8),
 139 .BR slapadd (8),
 140 .BR slapcat (8),
 141 .BR slapindex (8),
 142 OpenLDAP MDB documentation.
 143 .SH ACKNOWLEDGEMENTS
 144 .so ../Project
 145 Written by Howard Chu.