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

[openldap] / doc / guide / admin / backends.sdf

diff --git a/doc/guide/admin/backends.sdf b/doc/guide/admin/backends.sdf
index a675be7503e6886a8ec0287c05eca21a252e1c69..75c98831e3a963f3d8e9fcc6450d1063089f04d2 100644 (file)
--- a/doc/guide/admin/backends.sdf
+++ b/doc/guide/admin/backends.sdf
@@ -1,5 +1,5 @@
 # $OpenLDAP$
-# Copyright 2007-2012 The OpenLDAP Foundation, All Rights Reserved.
+# Copyright 2007-2013 The OpenLDAP Foundation, All Rights Reserved.
 # COPYING RESTRICTIONS APPLY, see COPYRIGHT.
 
 H1: Backends
@@ -139,7 +139,7 @@ configuration lines:
 >      include ./schema/core.schema
 >      
 >      database  ldif
->      directory "./ldif"
+>      directory ./ldif
 >      suffix    "dc=suretecsystems,dc=com"
 >      rootdn    "cn=LDIF,dc=suretecsystems,dc=com"
 >      rootpw    LDIF
@@ -187,6 +187,42 @@ H3: Further Information
 
 {{slapd-ldif}}(5)
 
+H2: MDB
+
+
+H3: Overview
+
+The {{mdb}} backend to {{slapd}}(8) is the upcoming primary backend for a
+normal {{slapd}} database.  It uses OpenLDAP's own Memory-Mapped Database ({{TERM:MDB}})
+library to store data and is intended to replace the Berkeley DB backends.
+
+It supports indexing like the BDB backends, but it uses no caching and requires
+no tuning to deliver maximum search performance.  Like {{hdb}}, it is also
+fully hierarchical and supports subtree renames in constant time.
+
+H3: back-mdb Configuration
+
+Unlike the BDB backends, the MDB backend can be instantiated with very few
+configuration lines:
+
+>      include ./schema/core.schema
+>
+>      database  mdb
+>      directory ./mdb
+>      suffix    "dc=suretecsystems,dc=com"
+>      rootdn    "cn=mdb,dc=suretecsystems,dc=com"
+>      rootpw    mdb
+>      maxsize   1073741824
+
+In addition to the usual parameters that a minimal configuration requires, the MDB
+backend requires a maximum size to be set. This should be the largest that
+the database is ever anticipated to grow (in bytes). The filesystem must also
+provide enough free space to accommodate this size.
+
+H3: Further Information
+
+{{slapd-mdb}}(5)
+
 H2: Metadirectory