git.sur5r.net Git - openldap/blob - doc/man/man5/slapo-refint.5

   1 .TH SLAPO-REFINT 5 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" Copyright 2004-2006 The OpenLDAP Foundation All Rights Reserved.
   3 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   4 .\" $OpenLDAP$
   5 .SH NAME
   6 slapo-refint \- Referential Integrity overlay
   7 .SH SYNOPSIS
   8 ETCDIR/slapd.conf
   9 .SH DESCRIPTION
  10 The Referential Integrity overlay can be used with a backend database such as
  11 .BR slapd-bdb (5)
  12 to maintain the cohesiveness of a schema which utilizes reference attributes.
  13 .LP
  14 Integrity is maintained by updating database records which contain the named
  15 attributes to match the results of a
  16 .B modrdn
  17 or
  18 .B delete
  19 operation. For example, if the integrity attribute were configured as
  20 .BR manager ,
  21 deletion of the record "uid=robert,ou=people,o=openldap.org" would trigger a
  22 search for all other records which have a
  23 .B manager
  24 attribute containing that DN. Entries matching that search would have their
  25 .B manager
  26 attribute removed.
  27 .SH CONFIGURATION
  28 These
  29 .B slapd.conf
  30 options apply to the Referential Integrity overlay.
  31 They should appear after the
  32 .B overlay
  33 directive and before any subsequent
  34 .B database
  35 directive.
  36 .TP
  37 .B refint_attributes <attribute...>
  38 Specify one or more attributes for which integrity will be maintained
  39 as described above.
  40 .TP
  41 .B refint_nothing <string>
  42 Specify an arbitrary value to be used as a placeholder when the last value
  43 would otherwise be deleted from an attribute. This can be useful in cases
  44 where the schema requires the existence of an attribute for which referential
  45 integrity is enforced. The attempted deletion of a required attribute will
  46 otherwise result in an Object Class Violation, causing the request to fail.
  47 .B
  48 .SH FILES
  49 .TP
  50 ETCDIR/slapd.conf
  51 default slapd configuration file
  52 .SH SEE ALSO
  53 .BR slapd.conf (5).