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

   1 .TH SLAPO-SYNCPROV 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-syncprov \- Syncrepl Provider overlay
   7 .SH SYNOPSIS
   8 ETCDIR/slapd.conf
   9 .SH DESCRIPTION
  10 The Syncrepl Provider overlay implements the provider-side support for
  11 syncrepl replication, including persistent search functionality. The overlay
  12 can be used with any backend that maintains entryCSN and entryUUID
  13 attributes for its entries. It also creates a contextCSN attribute in
  14 the root entry of the database.
  15
  16 The contextCSN is updated for every write operation performed against the
  17 database. To reduce database contention, the contextCSN is only updated in
  18 memory. The value is written to the database on server shutdown and read into
  19 memory on startup, and maintained in memory thereafter. Checkpoints may be
  20 configured to write the contextCSN into the underlying database to minimize
  21 recovery time after an unclean shutdown.
  22
  23 Note that due to deadlock constraints in the LDBM database, this overlay
  24 will only work in RefreshOnly mode, and cannot perform checkpoints, on LDBM.
  25
  26 On databases that support inequality indexing, it is helpful to set an
  27 eq index on the entryCSN attribute when using this overlay.
  28 .SH CONFIGURATION
  29 These
  30 .B slapd.conf
  31 options apply to the Syncrepl Provider overlay.
  32 They should appear after the
  33 .B overlay
  34 directive.
  35 .TP
  36 .B syncprov-checkpoint <ops> <minutes>
  37 After a write operation has succeeded, write the contextCSN to the underlying
  38 database if
  39 .B <ops>
  40 write operations or more than
  41 .B <minutes>
  42 time have passed
  43 since the last checkpoint. Checkpointing is disabled by default.
  44 .TP
  45 .B syncprov-sessionlog <ops>
  46 Specify a session log for recording information about write operations made
  47 on the database.  The
  48 .B <ops>
  49 specifies the number of operations that are recorded in the log. All write
  50 operations (except Adds) are recorded in the log.
  51 When using the session log, it is helpful to set an eq index on the
  52 entryUUID attribute in the underlying database.
  53 .TP
  54 .B syncprov-nopresent TRUE | FALSE
  55 Specify that the Present phase of refreshing should be skipped. This value
  56 should only be set TRUE for a syncprov instance on top of a log database
  57 (such as one managed by the accesslog overlay).
  58 The default is FALSE.
  59 .TP
  60 .B syncprov-reloadhint TRUE | FALSE
  61 Specify that the overlay should honor the reloadHint flag in the Syncrepl
  62 Control. In OpenLDAP releases 2.3.11 and earlier the Syncrepl consumer did
  63 not properly set this flag, so the overlay must ignore it. This option
  64 should be set TRUE when working with newer releases that properly support
  65 this flag. It must be set TRUE when using the accesslog overlay for
  66 delta-based Syncrepl support.  The default is FALSE.
  67 .SH FILES
  68 .TP
  69 ETCDIR/slapd.conf
  70 default slapd configuration file
  71 .SH SEE ALSO
  72 .BR slapd.conf (5),
  73 .BR slapo-accesslog (5).
  74 OpenLDAP Administrator's Guide.