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

   1 .TH SLAPO-REFINT 5 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" Copyright 2004-2008 The OpenLDAP Foundation All Rights Reserved.
   3 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   4 .\" $OpenLDAP$
   5 .SH NAME
   6 slapo-refint \- Referential Integrity overlay to slapd
   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,dc=example,dc=com" 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 Or, renaming the same record into "uid=george,ou=people,dc=example,dc=com"
  28 would trigger a search for all other records which have a
  29 .B manager
  30 attribute containing that DN.
  31 Entries matching that search would have their
  32 .B manager
  33 attribute deleted and replaced by the new DN.
  34 .SH CONFIGURATION
  35 These
  36 .B slapd.conf
  37 options apply to the Referential Integrity overlay.
  38 They should appear after the
  39 .B overlay
  40 directive.
  41 .TP
  42 .B refint_attributes <attribute> [...]
  43 Specify one or more attributes for which integrity will be maintained
  44 as described above.
  45 .TP
  46 .B refint_nothing <string>
  47 Specify an arbitrary value to be used as a placeholder when the last value
  48 would otherwise be deleted from an attribute. This can be useful in cases
  49 where the schema requires the existence of an attribute for which referential
  50 integrity is enforced. The attempted deletion of a required attribute will
  51 otherwise result in an Object Class Violation, causing the request to fail.
  52 The string must be a valid DN.
  53 .TP
  54 .B refint_modifiersname <DN>
  55 Specify the DN to be used as the modifiersName of the internal modifications
  56 performed by the overlay.
  57 It defaults to "\fIcn=Referential Integrity Overlay\fP".
  58 .B
  59 .SH FILES
  60 .TP
  61 ETCDIR/slapd.conf
  62 default slapd configuration file
  63 .SH SEE ALSO
  64 .BR slapd.conf (5).
  65 .SH ACKNOWLEDGEMENTS
  66 .so ../Project