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

   1 .TH SLAPO-SYNCPROV 5 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" Copyright 2004-2005 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 detabase 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 and before any subsequent
  35 .B database
  36 directive.
  37 .TP
  38 .B syncprov-checkpoint <ops> <minutes>
  39 After a write operation has succeeded, write the contextCSN to the underlying
  40 database if <ops> write operations or more than <minutes> time have passed
  41 since the last checkpoint. Checkpointing is disabled by default.
  42 .TP
  43 .B syncprov-sessionlog <sid> <size>
  44 Specify a session log for recording information about entries that have been
  45 scoped out of the content identified by
  46 .BR <sid> .
  47 The number of entries in the log is limited by
  48 .BR <size> .
  49 Both
  50 .B <sid>
  51 and
  52 .B <size>
  53 must be non-negative integers, and
  54 .B <sid>
  55 can have no more than three decimal digits.
  56 When using the session log, it is helpful to set an eq index on the
  57 entryUUID attribute in the underlying database.
  58 .SH FILES
  59 .TP
  60 ETCDIR/slapd.conf
  61 default slapd configuration file
  62 .SH SEE ALSO
  63 .BR slapd.conf (5).
  64 OpenLDAP Administrator's Guide.