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

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