mirror of
https://git.openldap.org/openldap/openldap.git
synced 2024-12-21 03:10:25 +08:00
d019bff7b8
Backend documentation patch, version 1 ================ Most of this text is taken from OpenLDAP. The work of rewriting it to manual pages is done by by Hallvard B. Furuseth and placed into the public domain. This software is not subject to any license of the University of Oslo. ================ Hallvard B. Furuseth <h.b.furuseth@usit.uio.no>, April 2002.
100 lines
3.2 KiB
Groff
100 lines
3.2 KiB
Groff
.TH SLAPD-BDB 5 "28 April 2002" "OpenLDAP LDVERSION"
|
|
.\" Copyright 1998-2002 The OpenLDAP Foundation All Rights Reserved.
|
|
.\" Copying restrictions apply. See COPYRIGHT/LICENSE.
|
|
.\" $OpenLDAP$
|
|
.SH NAME
|
|
slapd-bdb \- BDB backend to slapd
|
|
.SH SYNOPSIS
|
|
ETCDIR/slapd.conf
|
|
.SH DESCRIPTION
|
|
The BDB backend to
|
|
.BR slapd (8)
|
|
is the recommended backend for a normal slapd database.
|
|
It uses the Sleepycat BerkelyDB package to store data.
|
|
It makes extensive use of indexing and caching to speed data access.
|
|
.SH CONFIGURATION
|
|
The
|
|
.BR slapd.conf (5)
|
|
options in this category apply to the BDB databases.
|
|
That is, they must follow a "database bdb" line and come before any
|
|
subsequent "backend" or "database" lines.
|
|
.TP
|
|
.B cachesize <integer>
|
|
Specify the size in entries of the in-memory cache maintained
|
|
by the BDB backend database instance.
|
|
The default is 1000 entries.
|
|
.TP
|
|
.B checkpoint <kbyte> <min>
|
|
Specify the frequency for checkpointing the database transaction log.
|
|
A checkpoint operation flushes the database buffers to disk and writes
|
|
a checkpoint record in the log.
|
|
The checkpoint will occur if either <kbyte> data has been written or
|
|
<min> minutes have passed since the last checkpoint.
|
|
Both arguments default to zero, in which case they are ignored.
|
|
See the Berkeley DB reference guide for more details.
|
|
.TP
|
|
.B dbnosync
|
|
Specify that on-disk database contents should not be immediately
|
|
synchronized with in memory changes.
|
|
Enabling this option may improve performance at the expense of data
|
|
security.
|
|
.TP
|
|
.B directory <directory>
|
|
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 .
|
|
.TP
|
|
.B dirtyread
|
|
Allow reads of modified but not yet committed data.
|
|
Usually transactions are isolated to prevent other operations from
|
|
accessing uncommitted data.
|
|
This option may improve performance, but may also return inconsistent
|
|
results if the data comes from a transaction that is later aborted.
|
|
In this case, the modified data is discarded and a subsequent search
|
|
will return a different result.
|
|
.TP
|
|
.B
|
|
index {<attrlist>|default} [pres,eq,approx,sub,<special>]
|
|
Specify the indexes to maintain for the given attribute (or
|
|
list of attributes).
|
|
Some attributes only support a subset of indexes.
|
|
If only an <attr> is given, the indices specified for \fBdefault\fR
|
|
are maintained.
|
|
Note that setting a default does not imply that all attributes will be
|
|
indexed.
|
|
|
|
A number of special index parameters may be specified.
|
|
The index type
|
|
.B sub
|
|
can be decomposed into
|
|
.BR subinitial ,
|
|
.BR subany ,\ and
|
|
.B subfinal
|
|
indices.
|
|
The special type
|
|
.B nolang
|
|
may be specified to disallow use of this index by language subtypes.
|
|
The special type
|
|
.B nosubtypes
|
|
may be specified to disallow use of this index by named subtypes.
|
|
Note: changing index settings requires rebuilding indices, see
|
|
.BR slapindex (8).
|
|
.TP
|
|
.B lockdetect {oldest|youngest|fewest|random|default}
|
|
Specify which transaction to abort when a deadlock is detected.
|
|
The default is the same as
|
|
.BR random .
|
|
.TP
|
|
.B mode <integer>
|
|
Specify the file protection mode that newly created database
|
|
index files should have.
|
|
The default is 0600.
|
|
.SH SEE ALSO
|
|
.BR slapd.conf (5),
|
|
.BR slapd (8),
|
|
.BR slapadd (8),
|
|
.BR slapcat (8),
|
|
.BR slapindex (8).
|