]> git.sur5r.net Git - openldap/blobdiff - doc/man/man5/slapd-sql.5
Delta-syncrepl doc updates
[openldap] / doc / man / man5 / slapd-sql.5
index 34aa56172c2f83d0a0e1208a61524d01d51e066b..7048ce96f3a6d4f8b535b96b124ca61cba857aa7 100644 (file)
@@ -105,7 +105,7 @@ Do not use the subtree condition when the searchBase is the database
 suffix, and the scope is subtree; rather collect all entries.
 
 .RE
-.SH STAMEMENT CONFIGURATION
+.SH STATEMENT CONFIGURATION
 These options specify SQL query templates for loading schema mapping
 metainformation, adding and deleting entries to ldap_entries, etc.
 All these and subtree_cond should have the given default values.
@@ -161,14 +161,7 @@ The default is
 The statement that is used to delete an existing entry's ID
 from table \fIldap_objclasses\fP; see "METAINFORMATION USED" for details.
 The default is
-\fB""DELETE FROM ldap_entry_objclasses WHERE entry_id=?"\fP.
-
-.TP
-.B delreferrals_stmt <SQL expression>
-The statement that is used to delete an existing entry's ID
-from table \fIldap_referrals\fP; see "METAINFORMATION USED" for details.
-The default is
-\fB""DELETE FROM ldap_referrals WHERE entry_id=?"\fP.
+\fB"DELETE FROM ldap_entry_objclasses WHERE entry_id=?"\fP.
 
 .RE
 .SH HELPER CONFIGURATION
@@ -214,7 +207,6 @@ is builtin in back-sql; see macro
 is set to 8192).
 This is \fIexperimental\fP and may change in future releases.
 
-.TP
 .TP
 .B strcast_func <SQL function name>
 Specifies the name of a function that converts a given value to a string
@@ -223,6 +215,7 @@ for strongly typed RDBMSes with little implicit casting (like PostgreSQL),
 when a literal string is specified.
 This is \fIexperimental\fP and may change in future releases.
 
+.TP
 .B concat_pattern <pattern>
 This statement defines the
 .B pattern 
@@ -242,11 +235,22 @@ Carefully check the documentation of your RDBMS or stay with the examples
 for supported ones.
 This is \fIexperimental\fP and may change in future releases.
 
+.TP
+.B aliasing_keyword <string>
+Define the aliasing keyword.  Some RDBMSes use the word "\fIAS\fP"
+(the default), others don't use any.
+
+.TP
+.B aliasing_quote <string>
+Define the quoting char of the aliasing keyword.  Some RDBMSes 
+don't require any (the default), others may require single 
+or double quotes.
+
 .TP
 .B has_ldapinfo_dn_ru { NO | yes }
 Explicitly inform the backend whether the dn_ru column
 (DN in reverse uppercased form) is present in table \fIldap_entries\fP.
-Overrides automatic check (this is required, ofr instance,
+Overrides automatic check (this is required, for instance,
 by PostgreSQL/unixODBC).
 This is \fIexperimental\fP and may change in future releases.
 
@@ -317,6 +321,13 @@ dependent attributes are \fBNOT\fP generated at this point, for
 consistency with the rest of slapd.  This may change in the future.
 .RE
 
+.TP
+.B check_schema { YES | no }
+Instructs the database to check schema adherence of entries after
+modifications, and structural objectClass chain when entries are built.
+By default it is set to 
+.BR yes .
+
 .TP
 .B sqllayer <name> [...]
 Loads the layer \fB<name>\fP onto a stack of helpers that are used 
@@ -599,9 +610,8 @@ 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.
 Fortunately, they are easy to adopt in this scheme.
-The SQL backend suggests two more tables being added to the schema -
-ldap_entry_objectclasses(entry_id,oc_name), and
-ldap_referrals(entry_id,url).
+The SQL backend suggests one more table being added to the schema:
+ldap_entry_objectclasses(entry_id,oc_name).
 .LP
 The first contains any number of objectclass names that corresponding
 entries will be found by, in addition to that mentioned in
@@ -611,13 +621,19 @@ attribute to each objectclass mapping that loads values from this table.
 So, you may, for instance, have a mapping for inetOrgPerson, and use it
 for queries for "person" objectclass...
 .LP
-The second table contains any number of referrals associated with a given entry.
-The SQL backend automatically adds attribute mapping for "ref" attribute
-to each objectclass mapping that loads values from this table.
-So, if you add objectclass "referral" to this entry, and make one or
-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.
+Referrals used to be implemented in a loose manner by adding an extra
+table that allowed any entry to host a "ref" attribute, along with
+a "referral" extra objectClass in table ldap_entry_objclasses.
+In the current implementation, referrals are treated like any other
+user-defined schema, since "referral" is a structural objectclass.
+The suggested practice is to define a "referral" entry in ldap_oc_mappings,
+holding a naming attribute, e.g. "ou" or "cn", a "ref" attribute,
+containing the url; in case multiple referrals per entry are needed,
+a separate table for urls can be created, where urls are mapped
+to the respective entries.
+The use of the naming attribute usually requires to add 
+an "extensibleObject" value to ldap_entry_objclasses.
+
 .LP
 .SH Caveats
 As previously stated, this backend should not be considered
@@ -626,7 +642,7 @@ to existing RDBMS storages that need to be published in LDAP form.
 .LP
 The \fBhasSubordintes\fP 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
+also in filtering.  Owing to design limitations, a (brain-dead?) filter
 of the form
 \fB(!(hasSubordinates=TRUE))\fP
 will give no results instead of returning all the leaf entries, because
@@ -651,6 +667,14 @@ for details.
 .SH EXAMPLES
 There are example SQL modules in the slapd/back-sql/rdbms_depend/
 directory in the OpenLDAP source tree.
+.SH ACCESS CONTROL
+The 
+.B sql
+backend honors access control semantics as indicated in
+.BR slapd.access (5)
+(including the 
+.B disclose
+access privilege when enabled at compile time).
 .SH FILES
 
 .TP