1
.TH SLAPD-NDB 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2
.\" Copyright 2008-2009 The OpenLDAP Foundation All Rights Reserved.
3
.\" Copying restrictions apply. See COPYRIGHT/LICENSE.
4
.\" $OpenLDAP: pkg/ldap/doc/man/man5/slapd-ndb.5,v 1.4.2.3 2009/01/30 20:08:05 quanah Exp $
6
slapd-ndb \- MySQL NDB backend to slapd
10
The \fBndb\fP backend to
12
uses the MySQL Cluster package to store data, through its NDB API.
13
It provides fault tolerance with extreme scalability, along with
14
a degree of SQL compatibility.
16
This backend is designed to store LDAP information using tables that
17
are also visible from SQL. It uses a higher level SQL API for creating
18
these tables, while using the low level NDB API for storing and
19
retrieving the data within these tables. The NDB Cluster engine
20
allows data to be partitioned across multiple data nodes, and this
21
backend allows multiple slapd instances to operate against a given
22
database concurrently.
24
The general approach is to use distinct tables for each LDAP object class.
25
Entries comprised of multiple object classes will have their data
26
spread across multiple tables. The data tables use a 64 bit entryID
27
as their primary key. The DIT hierarchy is maintained in a separate
28
table, which maps DNs to entryIDs.
30
This backend is experimental. While intended to be a general-purpose
31
backend, it is currently missing a number of common LDAP features.
32
See the \fBTODO\fP file in the source directory for details.
36
options apply to the \fBndb\fP backend database.
37
That is, they must follow a "database ndb" line and
38
come before any subsequent "backend" or "database" lines.
39
Other database options are described in the
43
.SH DATA SOURCE CONFIGURATION
47
The name or IP address of the host running the MySQL server. The default
48
is "localhost". On Unix systems, the connection to a local server is made
49
using a Unix Domain socket, whose path is specified using the
54
The MySQL login ID to use when connecting to the MySQL server. The chosen
55
user must have sufficient privileges to manipulate the SQL tables in the
58
.B dbpasswd <password>
59
The password for the \fBdbuser\fP.
61
.B dbname <database name>
62
The name of the MySQL database to use.
65
The port number to use for the TCP connection to the MySQL server.
68
The socket to be used for connecting to a local MySQL server.
71
Client flags for the MySQL session. See the MySQL documentation for details.
73
.B dbconnect <connectstring>
74
The name or IP address of the host running the cluster manager. The default
77
.B dbconnections <integer>
78
The number of cluster connections to establish. Using up to 4 may improve
79
performance under heavier load. The default is 1.
81
.SH SCHEMA CONFIGURATION
83
.B attrlen <attribute> <length>
84
Specify the column length to use for a particular attribute. LDAP attributes are
85
stored in individual columns of the SQL tables. The maximum column lengths for
86
each column must be specified when creating these tables. If a length constraint
87
was specified in the attribute's LDAP schema definition, that value will be used
88
by default. If the schema didn't specify a constraint, the default is 128 bytes.
89
Currently the maximum is 1024.
91
.B index <attr[,attr...]>
92
Specify a list of attributes for which indexing should be maintained.
93
Currently there is no support for substring indexing; a single index structure
94
provides presence, equality, and inequality indexing for the specified attributes.
96
.B attrset <set> <attrs>
97
Specify a list of attributes to be treated as an attribute set. This directive
98
creates a table named \fIset\fP which will contain all of the listed attributes.
99
Ordinarily an attribute resides in a table named by an object class that uses
100
the attribute. However, attributes are only allowed to appear in a single table.
101
For attributes that are derived from an inherited object class definition,
102
the attribute will only be stored in the superior class's table.
103
Attribute sets should be defined for any attributes that are used in multiple
104
unrelated object classes, i.e., classes that are not connected by a simple
109
backend honors most access control semantics as indicated in
110
.BR slapd.access (5).
119
.BR slapd\-config (5),
124
MySQL Cluster documentation.
126
Howard Chu, with assistance from Johan Andersson et al @ MySQL.