Merge remote branch 'origin/mdb.master' into OPENLDAP_REL_ENG_2_4

[openldap] / doc / man / man5 / slapd.backends.5

diff --git a/doc/man/man5/slapd.backends.5 b/doc/man/man5/slapd.backends.5
index c5801ad31feb28fb48b5a19cdb93dcfaa1fcce58..7c63454bcead606d4b96f7e3fece7e4cf5b5ff1f 100644 (file)
--- a/doc/man/man5/slapd.backends.5
+++ b/doc/man/man5/slapd.backends.5
@@ -1,5 +1,5 @@
 .TH SLAPD.BACKENDS 5 "RELEASEDATE" "OpenLDAP LDVERSION"
-.\" Copyright 2006-2007 The OpenLDAP Foundation All Rights Reserved.
+.\" Copyright 2006-2012 The OpenLDAP Foundation All Rights Reserved.
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .\" $OpenLDAP$
 .SH NAME
@@ -16,13 +16,15 @@ slapd server.
 
 Configuration options for each backend are documented separately in the
 corresponding
-.BR slapd-<backend> (5)
+.BR slapd\-<backend> (5)
 manual pages.
 .TP
 .B bdb
-This is the recommended primary backend for a normal slapd database.
-It takes care to configure it properly.
-It uses the transactional database interface of the Sleepycat Berkeley
+This was the recommended primary backend through OpenLDAP 2.3, but it has
+since been superseded by the
+.BR hdb
+backend.  It takes care to configure it properly.
+It uses the transactional database interface of the Oracle Berkeley
 DB (BDB) package to store data.
 .TP
 .B config
@@ -40,10 +42,13 @@ It serves up referrals based upon SRV resource records held in the
 Domain Name System.
 .TP
 .B hdb
-This is a variant of the
+This is the recommended primary backend for a normal slapd database.
+.B hdb
+is a variant of the
 .B bdb
 backend that uses a hierarchical database
-layout. This layout stores entry DNs more efficiently than the
+layout.
+This layout stores entry DNs more efficiently than the
 .B bdb
 backend,
 using less space and requiring less work to create, delete, and rename
@@ -59,6 +64,16 @@ of the database, using plain ascii files to store data.
 Its usage should be limited to very simple databases, where performance
 is not a requirement. This backend also supports subtree renames.
 .TP
+.B mdb
+This will soon be the recommended primary backend, superseding
+.BR hdb .
+This backend uses OpenLDAP's own MDB transactional database
+library. It is extremely compact and extremely efficient, delivering
+much higher performance than the Berkeley DB backends while using
+significantly less memory.  Also, unlike Berkeley DB, MDB is crash proof,
+and requires no special tuning or maintenance.
+This backend also supports subtree renames.
+.TP
 .B meta
 This backend performs basic LDAP proxying with respect to a set of
 remote LDAP servers. It is an enhancement of the
@@ -71,6 +86,12 @@ daemon. Only a single instance of the
 .B monitor
 backend may be defined.
 .TP
+.B ndb
+This backend is experimental.
+It uses the transactional database interface of the MySQL Cluster Engine
+(NDB) to store data. Note that Oracle, which now owns MySQL, has withdrawn
+support for NDB and this backend is unlikely to be developed any further.
+.TP
 .B null
 Operations in this backend succeed but do nothing.
 .TP
@@ -93,7 +114,7 @@ in the same server, based on the naming context of the request.
 Its use requires the 
 .B rwm
 overlay (see
-.BR slapo-rwm (5)
+.BR slapo\-rwm (5)
 for details) to rewrite the naming context of the request.
 It is primarily intended to implement virtual views on databases
 that actually store data.
@@ -120,8 +141,10 @@ default slapd configuration directory
 .BR slapd\-hdb (5),
 .BR slapd\-ldap (5),
 .BR slapd\-ldif (5),
+.BR slapd\-mdb (5),
 .BR slapd\-meta (5),
 .BR slapd\-monitor (5),
+.BR slapd\-ndb (5),
 .BR slapd\-null (5),
 .BR slapd\-passwd (5),
 .BR slapd\-perl (5),