X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=doc%2Fman%2Fman5%2Fslapd-bdb.5;h=f64e6d3e4b311af70d03836b4884506976767c94;hb=550dc4aaeee2b9f2ed25b451d950bd5e7088652d;hp=677747f0dc2e8e70746cdeb5728892d938a983d8;hpb=4491c98250d0b6e8d356d3ff258e5a9543676416;p=openldap diff --git a/doc/man/man5/slapd-bdb.5 b/doc/man/man5/slapd-bdb.5 index 677747f0dc..f64e6d3e4b 100644 --- a/doc/man/man5/slapd-bdb.5 +++ b/doc/man/man5/slapd-bdb.5 @@ -1,24 +1,22 @@ .TH SLAPD-BDB 5 "RELEASEDATE" "OpenLDAP LDVERSION" -.\" Copyright 1998-2009 The OpenLDAP Foundation All Rights Reserved. +.\" Copyright 1998-2011 The OpenLDAP Foundation All Rights Reserved. .\" Copying restrictions apply. See COPYRIGHT/LICENSE. .\" $OpenLDAP$ .SH NAME -slapd-bdb, slapd-hdb \- Berkeley DB backends to slapd +slapd\-bdb, slapd\-hdb \- Berkeley DB backends to slapd .SH SYNOPSIS .B ETCDIR/slapd.conf .SH DESCRIPTION The \fBbdb\fP backend to .BR slapd (8) -is the recommended primary backend for a normal -.B slapd -database. -It uses the Oracle Berkeley DB (BDB) package to store data. +uses the Oracle Berkeley DB (BDB) package to store data. It makes extensive use of indexing and caching to speed data access. .LP -\fBhdb\fP is a variant of the \fBbdb\fP backend that uses a -hierarchical database -layout which supports subtree renames. It is otherwise identical to -the \fBbdb\fP behavior, and all the same configuration options apply. +\fBhdb\fP is the recommended primary database backend. It is a variant of +the \fBbdb\fP backend that uses a hierarchical database layout which +supports subtree renames. It is both more space-efficient and more +execution-efficient than the \fBbdb\fP backend. It is otherwise identical +to the \fBbdb\fP behavior, and all the same configuration options apply. .LP It is noted that these options are intended to complement Berkeley DB configuration options set in the environment's @@ -83,7 +81,7 @@ or .B cryptfile may be configured. .TP -.BI dbconfig \ +.BI dbconfig \ Specify a configuration directive to be placed in the .B DB_CONFIG file of the database directory. The @@ -123,7 +121,7 @@ file is 16, the default for all other files depends on the size of the underlying filesystem's block size (typically 4 or 8). The maximum that BerkeleyDB supports is 64. This setting usually should not need to be changed, but if BerkeleyDB's -"db_stat -d" shows a large amount of overflow pages in use in a file, +"db_stat \-d" shows a large amount of overflow pages in use in a file, setting a larger size may increase performance at the expense of data integrity. This setting only takes effect when a database is being newly created. See the Berkeley DB reference guide for more details. @@ -133,7 +131,7 @@ Specify the directory where the BDB files containing this database and associated indexes live. A separate directory must be specified for each database. The default is -.BR LOCALSTATEDIR/openldap-data . +.BR LOCALSTATEDIR/openldap\-data . .TP .B dirtyread Allow reads of modified but not yet committed data. @@ -145,9 +143,13 @@ In this case, the modified data is discarded and a subsequent search will return a different result. .TP .BI dncachesize \ -Specify the maximum number of DNs in the in-memory DN cache. The -default is twice the \fBcachesize\fP. Ideally this cache should be -large enough to contain the DNs of every entry in the database. +Specify the maximum number of DNs in the in-memory DN cache. +Ideally this cache should be +large enough to contain the DNs of every entry in the database. If +set to a smaller value than the \fBcachesize\fP it will be silently +increased to equal the \fBcachesize\fP. The default value is 0 which +means unlimited, i.e. the DN cache will grow without bound. + It should be noted that the \fBDN cache\fP is allowed to temporarily grow beyond the configured size. It does this if many entries are locked when it tries to do a purge, because that means they're @@ -266,6 +268,7 @@ configuration file Berkeley DB configuration file .SH SEE ALSO .BR slapd.conf (5), +.BR slapd\-config (5), .BR slapd (8), .BR slapadd (8), .BR slapcat (8),