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

   1 .TH SLAPD.BACKENDS 5 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" Copyright 2006-2012 The OpenLDAP Foundation All Rights Reserved.
   3 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   4 .\" $OpenLDAP$
   5 .SH NAME
   6 slapd.backends \- backends for slapd, the stand-alone LDAP daemon
   7 .SH DESCRIPTION
   8 The
   9 .BR slapd (8)
  10 daemon can use a variety of different backends for serving LDAP requests.
  11 Backends may be compiled statically into slapd, or when module support
  12 is enabled, they may be dynamically loaded. Multiple instances of a
  13 backend can be configured, to serve separate databases from the same
  14 slapd server.
  15
  16
  17 Configuration options for each backend are documented separately in the
  18 corresponding
  19 .BR slapd\-<backend> (5)
  20 manual pages.
  21 .TP
  22 .B bdb
  23 This was the recommended primary backend through OpenLDAP 2.3, but it has
  24 since been superseded by the
  25 .BR hdb
  26 backend.  It takes care to configure it properly.
  27 It uses the transactional database interface of the Oracle Berkeley
  28 DB (BDB) package to store data.
  29 .TP
  30 .B config
  31 This backend is used to manage the configuration of slapd at run-time.
  32 Unlike other backends, only a single instance of the
  33 .B config
  34 backend may be defined. It also instantiates itself automatically,
  35 so it is always present even if not explicitly defined in the
  36 .BR slapd.conf (5)
  37 file.
  38 .TP
  39 .B dnssrv
  40 This backend is experimental.
  41 It serves up referrals based upon SRV resource records held in the
  42 Domain Name System.
  43 .TP
  44 .B hdb
  45 This is the recommended primary backend for a normal slapd database.
  46 .B hdb
  47 is a variant of the
  48 .B bdb
  49 backend that uses a hierarchical database
  50 layout.
  51 This layout stores entry DNs more efficiently than the
  52 .B bdb
  53 backend,
  54 using less space and requiring less work to create, delete, and rename
  55 entries. It is also one of the few backends to support subtree renames.
  56 .BR
  57 .TP
  58 .B ldap
  59 This backend acts as a proxy to forward incoming requests to another
  60 LDAP server.
  61 .TP
  62 .B ldif
  63 This database uses the filesystem to build the tree structure
  64 of the database, using plain ascii files to store data.
  65 Its usage should be limited to very simple databases, where performance
  66 is not a requirement. This backend also supports subtree renames.
  67 .TP
  68 .B meta
  69 This backend performs basic LDAP proxying with respect to a set of
  70 remote LDAP servers. It is an enhancement of the
  71 .B ldap
  72 backend.
  73 .TP
  74 .B monitor
  75 This backend provides information about the running status of the slapd
  76 daemon. Only a single instance of the
  77 .B monitor
  78 backend may be defined.
  79 .TP
  80 .B ndb
  81 This backend is experimental.
  82 It uses the transactional database interface of the MySQL Cluster Engine
  83 (NDB) to store data.
  84 .TP
  85 .B null
  86 Operations in this backend succeed but do nothing.
  87 .TP
  88 .B passwd
  89 This backend is provided for demonstration purposes only.
  90 It serves up user account information from the system
  91 .BR passwd (5)
  92 file.
  93 .TP
  94 .B perl
  95 This backend embeds a
  96 .BR perl (1)
  97 interpreter into slapd.
  98 It runs Perl subroutines to implement LDAP operations.
  99 .TP
 100 .B relay
 101 This backend is experimental.
 102 It redirects LDAP operations to another database
 103 in the same server, based on the naming context of the request.
 104 Its use requires the
 105 .B rwm
 106 overlay (see
 107 .BR slapo\-rwm (5)
 108 for details) to rewrite the naming context of the request.
 109 It is primarily intended to implement virtual views on databases
 110 that actually store data.
 111 .TP
 112 .B shell
 113 This backend executes external programs to implement LDAP operations.
 114 It is primarily intended to be used in prototypes.
 115 .TP
 116 .B sql
 117 This backend is experimental.
 118 It services LDAP requests from an SQL database.
 119 .SH FILES
 120 .TP
 121 ETCDIR/slapd.conf
 122 default slapd configuration file
 123 .TP
 124 ETCDIR/slapd.d
 125 default slapd configuration directory
 126 .SH SEE ALSO
 127 .BR ldap (3),
 128 .BR slapd\-bdb (5),
 129 .BR slapd\-config (5),
 130 .BR slapd\-dnssrv (5),
 131 .BR slapd\-hdb (5),
 132 .BR slapd\-ldap (5),
 133 .BR slapd\-ldif (5),
 134 .BR slapd\-meta (5),
 135 .BR slapd\-monitor (5),
 136 .BR slapd\-null (5),
 137 .BR slapd\-passwd (5),
 138 .BR slapd\-perl (5),
 139 .BR slapd\-relay (5),
 140 .BR slapd\-shell (5),
 141 .BR slapd\-sql (5),
 142 .BR slapd.conf (5),
 143 .BR slapd.overlays (5),
 144 .BR slapd (8).
 145 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
 146 .SH ACKNOWLEDGEMENTS
 147 .so ../Project