ITS#2768: configuring slurpd's interval between replog checks

[openldap] / doc / man / man5 / slapd-sql.5

diff --git a/doc/man/man5/slapd-sql.5 b/doc/man/man5/slapd-sql.5
index c0b55fc623fad76d06003582f4190e2095da9d11..f43d45735a56e9d5cc9e64a80923699aac20c304 100644 (file)
--- a/doc/man/man5/slapd-sql.5
+++ b/doc/man/man5/slapd-sql.5
@@ -40,6 +40,8 @@ Also, it uses ODBC to connect to RDBMSes, and is highly configurable
 for SQL dialects RDBMSes may use, so it may be used for integration
 and distribution of data on different RDBMSes, OSes, hosts etc., in
 other words, in highly heterogeneous environment.
+.LP
+This backend is experimental.
 .SH CONFIGURATION
 These
 .B slapd.conf
@@ -69,7 +71,13 @@ is currently ignored).
 .RE
 .TP
 .B subtree_cond <SQL expression>
-Specifies a where-clause template used to form a subtree search condition.
+Specifies a where-clause template used to form a subtree search condition
+(dn=".*<dn>").
+It may differ from one SQL dialect to another (see samples).
+.TP
+.B children_cond <SQL expression>
+Specifies a where-clause template used to form a children search condition
+(dn="\.+,<dn>").
 It may differ from one SQL dialect to another (see samples).
 .TP
 .B oc_query <SQL expression>
@@ -167,7 +175,7 @@ and may change in future releases.
 .LP
 Almost everything mentioned later is illustrated in examples located
 in the
-.B slapd/back-sql/rdbms_depend/
+.B servers/slapd/back-sql/rdbms_depend/
 directory in the OpenLDAP source tree, and contains scripts for
 generating sample database for Oracle, MS SQL Server, mySQL and more
 (including PostgreSQL and IBM db2).
@@ -399,7 +407,7 @@ SYNTAX of corresponding LDAP schema attribute, we translate the filter
 into the most relaxed SQL condition to filter candidates), and send it to
 the user.
 .LP
-ADD, DELETE, MODIFY operations are also performed on per-attribute
+ADD, DELETE, MODIFY and MODRDN operations are also performed on per-attribute
 metainformation (add_proc etc.).
 In those fields one can specify an SQL statement or stored procedure
 call which can add, or delete given values of a given attribute, using
@@ -413,7 +421,7 @@ Please see samples to find out what are the parameters passed, and other
 information on this matter - they are self-explanatory for those familiar
 with concept expressed above.
 .LP
-.SH common techniques (referrals, multiclassing etc.)
+.SH Common techniques (referrals, multiclassing etc.)
 First of all, let's remember that among other major differences to the
 complete LDAP data model, the concept above does not directly support
 such things as multiple objectclasses per entry, and referrals.
@@ -438,6 +446,21 @@ more tuples in ldap_referrals for this entry (they will be seen as
 values of "ref" attribute), you will have slapd return a referral, as
 described in the Administrators Guide.
 .LP
+.SH Caveats
+As previously stated, this backend should not be considered
+a replacement of other data storage backends, but rather a gateway
+to existing RDBMS storages that need to be published in LDAP form.
+.LP
+The hasSubordintes operational attribute is honored by back-sql
+in search results and in compare operations; it is partially honored
+also in filtering.  Owing to design limitations, a (braindead) filter
+of the form
+\fB(!(hasSubordinates=TRUE))\fP
+will give no results instead of returning all the leaf entries.
+If you need to find all the leaf entries, please use
+\fB(hasSubordinates=FALSE)\fP
+instead.
+.LP
 .SH EXAMPLES
 There are example SQL modules in the slapd/back-sql/rdbms_depend/
 directory in the OpenLDAP source tree.