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

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