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

   1 .TH SLAPD-BDB 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-bdb \- BDB backend to slapd
   7 .SH SYNOPSIS
   8 ETCDIR/slapd.conf
   9 .SH DESCRIPTION
  10 The BDB backend to
  11 .BR slapd (8)
  12 is the recommended backend for a normal slapd database.
  13 It uses the Sleepycat BerkelyDB package to store data.
  14 It makes extensive use of indexing and caching to speed data access.
  15 .SH CONFIGURATION
  16 The
  17 .BR slapd.conf (5)
  18 options in this category apply to the BDB databases.
  19 That is, they must follow a "database bdb" line and come before any
  20 subsequent "backend" or "database" lines.
  21 .TP
  22 .B cachesize <integer>
  23 Specify the size in entries of the in-memory cache maintained
  24 by the BDB backend database instance.
  25 The default is 1000 entries.
  26 .TP
  27 .B checkpoint <kbyte> <min>
  28 Specify the frequency for checkpointing the database transaction log.
  29 A checkpoint operation flushes the database buffers to disk and writes
  30 a checkpoint record in the log.
  31 The checkpoint will occur if either <kbyte> data has been written or
  32 <min> minutes have passed since the last checkpoint.
  33 Both arguments default to zero, in which case they are ignored.
  34 See the Berkeley DB reference guide for more details.
  35 .TP
  36 .B dbnosync
  37 Specify that on-disk database contents should not be immediately
  38 synchronized with in memory changes.
  39 Enabling this option may improve performance at the expense of data
  40 security.
  41 .TP
  42 .B directory <directory>
  43 Specify the directory where the BDB files containing this database and
  44 associated indexes live.
  45 A separate directory must be specified for each database.
  46 The default is
  47 .BR LOCALSTATEDIR/openldap-data .
  48 .TP
  49 .B dirtyread
  50 Allow reads of modified but not yet committed data.
  51 Usually transactions are isolated to prevent other operations from
  52 accessing uncommitted data.
  53 This option may improve performance, but may also return inconsistent
  54 results if the data comes from a transaction that is later aborted.
  55 In this case, the modified data is discarded and a subsequent search
  56 will return a different result.
  57 .TP
  58 .B
  59 index {<attrlist>|default} [pres,eq,approx,sub,<special>]
  60 Specify the indexes to maintain for the given attribute (or
  61 list of attributes).
  62 Some attributes only support a subset of indexes.
  63 If only an <attr> is given, the indices specified for \fBdefault\fR
  64 are maintained.
  65 Note that setting a default does not imply that all attributes will be
  66 indexed.
  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 index settings requires rebuilding indices, see
  83 .BR slapindex (8).
  84 .TP
  85 .B lockdetect {oldest|youngest|fewest|random|default}
  86 Specify which transaction to abort when a deadlock is detected.
  87 The default is the same as
  88 .BR random .
  89 .TP
  90 .B mode <integer>
  91 Specify the file protection mode that newly created database
  92 index files should have.
  93 The default is 0600.
  94 .SH SEE ALSO
  95 .BR slapd.conf (5),
  96 .BR slapd (8),
  97 .BR slapadd (8),
  98 .BR slapcat (8),
  99 .BR slapindex (8).