1SLAPD-NDB(5)                  File Formats Manual                 SLAPD-NDB(5)
2
3
4

NAME

6       slapd-ndb - MySQL NDB backend to slapd
7

SYNOPSIS

9       /etc/openldap/slapd.conf
10

DESCRIPTION

12       The  ndb  backend  to  slapd(8) uses the MySQL Cluster package to store
13       data, through its NDB API.  It provides fault  tolerance  with  extreme
14       scalability, along with a degree of SQL compatibility.
15
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 re‐
19       trieving the data within these tables. The NDB  Cluster  engine  allows
20       data to be partitioned across multiple data nodes, and this backend al‐
21       lows multiple slapd instances to operate against a given database  con‐
22       currently.
23
24       The  general  approach  is  to use distinct tables for each LDAP object
25       class.  Entries comprised of multiple object classes  will  have  their
26       data  spread  across  multiple tables. The data tables use a 64 bit en‐
27       tryID as their primary key. The DIT hierarchy is maintained in a  sepa‐
28       rate table, which maps DNs to entryIDs.
29
30       This  backend  is  experimental. While intended to be a general-purpose
31       backend, it is currently missing a number of common LDAP features.  See
32       the TODO file in the source directory for details.
33

CONFIGURATION

35       These  slapd.conf  options apply to the ndb backend database.  That is,
36       they must follow a "database ndb" line and come before  any  subsequent
37       "backend" or "database" lines.  Other database options are described in
38       the slapd.conf(5) manual page.
39
40

DATA SOURCE CONFIGURATION

42       dbhost <hostname>
43              The name or IP address of the host running the MySQL server. The
44              default is "localhost". On Unix systems, the connection to a lo‐
45              cal server is made using a Unix Domain  socket,  whose  path  is
46              specified using the dbsocket directive.
47
48       dbuser <username>
49              The  MySQL  login ID to use when connecting to the MySQL server.
50              The chosen user must have sufficient  privileges  to  manipulate
51              the SQL tables in the target database.
52
53       dbpasswd <password>
54              The password for the dbuser.
55
56       dbname <database name>
57              The name of the MySQL database to use.
58
59       dbport <port>
60              The  port  number  to  use  for  the TCP connection to the MySQL
61              server.
62
63       dbsocket <path>
64              The socket to be used for connecting to a local MySQL server.
65
66       dbflag <integer>
67              Client flags for the MySQL session. See the MySQL  documentation
68              for details.
69
70       dbconnect <connectstring>
71              The  name or IP address of the host running the cluster manager.
72              The default is "localhost".
73
74       dbconnections <integer>
75              The number of cluster connections to establish. Using  up  to  4
76              may improve performance under heavier load. The default is 1.
77
78

SCHEMA CONFIGURATION

80       attrlen <attribute> <length>
81              Specify  the  column  length  to use for a particular attribute.
82              LDAP attributes are stored in individual columns of the SQL  ta‐
83              bles.  The maximum column lengths for each column must be speci‐
84              fied when creating these tables.  If  a  length  constraint  was
85              specified  in the attribute's LDAP schema definition, that value
86              will be used by default. If the schema  didn't  specify  a  con‐
87              straint,  the  default  is  128 bytes.  Currently the maximum is
88              1024.
89
90       index <attr[,attr...]>
91              Specify a list of attributes for which indexing should be  main‐
92              tained.  Currently there is no support for substring indexing; a
93              single index structure provides presence, equality, and inequal‐
94              ity indexing for the specified attributes.
95
96       attrset <set> <attrs>
97              Specify  a list of attributes to be treated as an attribute set.
98              This directive creates a table named set which will contain  all
99              of  the listed attributes.  Ordinarily an attribute resides in a
100              table named by an object class that uses the attribute. However,
101              attributes  are  only  allowed to appear in a single table.  For
102              attributes that are derived from an inherited object class defi‐
103              nition,  the  attribute  will  only  be  stored  in the superior
104              class's table.  Attribute sets should be  defined  for  any  at‐
105              tributes  that  are  used  in multiple unrelated object classes,
106              i.e., classes that are not connected  by  a  simple  inheritance
107              chain.
108

ACCESS CONTROL

110       The  ndb  backend  honors most access control semantics as indicated in
111       slapd.access(5).
112

FILES

114       /etc/openldap/slapd.conf
115              default slapd configuration file
116

SEE ALSO

118       slapd.conf(5),  slapd-config(5),  slapd(8),   slapadd(8),   slapcat(8),
119       slapindex(8), MySQL Cluster documentation.
120

AUTHOR

122       Howard Chu, with assistance from Johan Andersson et al @ MySQL.
123
124
125
126OpenLDAP 2.4.57                   2021/01/18                      SLAPD-NDB(5)
Impressum