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

   1 .TH SLAPD-LDBM 5 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" Copyright 1998-2005 The OpenLDAP Foundation All Rights Reserved.
   3 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   4 .\" $OpenLDAP$
   5 .SH NAME
   6 slapd-ldbm \- LDBM backend to slapd
   7 .SH SYNOPSIS
   8 ETCDIR/slapd.conf
   9 .SH DESCRIPTION
  10 The LDBM backend to
  11 .BR slapd (8)
  12 is the database backend which is easiest to configure.
  13 However, it does not offer the data durability features of the BDB
  14 backend.
  15 It uses Berkeley DB or GDBM to store data.
  16 It makes extensive use of indexing and caching to speed data access.
  17 .SH CONFIGURATION
  18 These
  19 .B slapd.conf
  20 options apply to the LDBM backend database.
  21 That is, they must follow a "database ldbm" line and come before any
  22 subsequent "backend" or "database" lines.
  23 Other database options are described in the
  24 .BR slapd.conf (5)
  25 manual page.
  26 .TP
  27 .B cachesize <integer>
  28 Specify the size in entries of the in-memory cache maintained
  29 by the LDBM backend database instance.
  30 The default is 1000 entries.
  31 .TP
  32 .B dbcachesize <integer>
  33 Specify the size in bytes of the in-memory cache associated with each
  34 open index file.
  35 If not supported by the underlying database method, this option is
  36 ignored without comment.
  37 The default is 100000 bytes.
  38 .TP
  39 .B dbnolocking
  40 Specify that no database locking should be performed.
  41 Enabling this option may improve performance at the expense of data security.
  42 Do NOT run any slap tools while slapd is running.
  43 .TP
  44 .B dbnosync
  45 Specify that on-disk database contents should not be immediately
  46 synchronized with in memory changes.
  47 Enabling this option may improve performance at the expense of data
  48 security.
  49 .TP
  50 .B dbsync <frequency> <maxdelays> <delayinterval>
  51 Flush dirty database buffers to disk every
  52 .B <seconds>
  53 seconds.
  54 Implies
  55 .B dbnosync
  56 (ie. indvidual updates are no longer written to disk).
  57 It attempts to avoid syncs during periods of peak activity by waiting
  58 .B <delayinterval>
  59 seconds if the server is busy, repeating this delay up to
  60 .B <maxdelays>
  61 times before proceeding.
  62 It is an attempt to provide higher write performance with some amount
  63 of data security.
  64 Note that it may still be possible to get an inconsistent database if
  65 the underlying engine fills its cache and writes out individual pages
  66 and slapd crashes or is killed before the next sync.
  67 .B <maxdelays>
  68 and
  69 .B <delayinterval>
  70 are optional and default to
  71 .B 12
  72 and
  73 .B 5
  74 respectively, giving a total elapsed delay of 60 seconds before a sync
  75 will occur.
  76 .B <maxdelays>
  77 may be zero, and
  78 .B <delayinterval>
  79 must be 1 or greater.
  80 .TP
  81 .B directory <directory>
  82 Specify the directory where the LDBM files containing this database and
  83 associated indexes live.
  84 A separate directory must be specified for each database.
  85 The default is
  86 .BR LOCALSTATEDIR/openldap-data .
  87 .TP
  88 .B
  89 index {<attrlist>|default} [pres,eq,approx,sub,<special>]
  90 Specify the indexes to maintain for the given attribute (or
  91 list of attributes).
  92 Some attributes only support a subset of indexes.
  93 If only an <attr> is given, the indices specified for \fBdefault\fR
  94 are maintained.
  95 Note that setting a default does not imply that all attributes will be
  96 indexed. Also, for best performance, an
  97 .B eq
  98 index should always be configured for the
  99 .B objectClass
 100 attribute.
 101
 102 A number of special index parameters may be specified.
 103 The index type
 104 .B sub
 105 can be decomposed into
 106 .BR subinitial ,
 107 .BR subany ,\ and
 108 .B subfinal
 109 indices.
 110 The special type
 111 .B notags
 112 (or
 113 .BR nolang )
 114 may be specified to disallow use of this index by subtypes with tagging
 115 options (such as language options).
 116 The special type
 117 .B nosubtypes
 118 may be specified to disallow use of this index by named subtypes.
 119 Note: changing index settings requires rebuilding indices, see
 120 .BR slapindex (8).
 121 .TP
 122 .B mode <integer>
 123 Specify the file protection mode that newly created database
 124 index files should have.
 125 The default is 0600.
 126 .SH FILES
 127 .TP
 128 ETCDIR/slapd.conf
 129 default slapd configuration file
 130 .SH SEE ALSO
 131 .BR slapd.conf (5),
 132 .BR slapd (8),
 133 .BR slapadd (8),
 134 .BR slapcat (8),
 135 .BR slapindex (8).