git.sur5r.net Git - openldap/blob - doc/man/man5/slapd-wt.5

   1 .TH SLAPD-WT 5 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" Copyright 2011-2018 The OpenLDAP Foundation All Rights Reserved.
   3 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   4 .\" $OpenLDAP$
   5 .SH NAME
   6 slapd\-wt \- WiredTiger backend to slapd
   7 .SH SYNOPSIS
   8 .B ETCDIR/slapd.conf
   9 .SH DESCRIPTION
  10 The \fBwt\fP backend to
  11 .BR slapd (8)
  12 uses WiredTiger database library to store data.
  13 .LP
  14 The \fBwt\fP backend is experimental module that have potential high
  15 write performance and high concurrency performance.
  16 This backend have not some basic feature yet. Please backup data using
  17 slapcat before update the module.
  18
  19 .SH CONFIGURATION
  20 These
  21 .B slapd.conf
  22 options apply to the \fBwt\fP backend database.
  23 That is, they must follow a "database wt" line and
  24 come before any subsequent "backend" or "database" lines.
  25 Other database options are described in the
  26 .BR slapd.conf (5)
  27 manual page.
  28 .TP
  29 .BI directory \ <directory>
  30 Specify WiredTiger home directory that containing this database and
  31 associated indexes live.
  32 A separate directory must be specified for each database.
  33 The default is
  34 .BR LOCALSTATEDIR/openldap\-data .
  35 .TP
  36 \fBwtconfig \fR{\fBcreate\fR,\fBcache_size=512M\fR,\fBasync=(enabled)\fR}
  37 Specify configuration for wiredtiger, This parameter is pass to
  38 .BR wiredtiger_open (3).
  39 .RS
  40 .TP
  41 .B create
  42 create the database if it does not exist.
  43 .RE
  44 .RS
  45 .TP
  46 .B cache_size
  47 maximum heap memory to allocate for the cache.
  48 .RE
  49 .RS
  50 .TP
  51 .B async
  52 asynchronous operations configuration options. disabled by default.
  53 .RE
  54 .RS
  55 .TP
  56 \fBindex \fR{\fI<attrlist>\fR|\fBdefault\fR} [\fBpres\fR,\fBeq\fR,\fBapprox\fR,\fBsub\fR,\fI<special>\fR]
  57 Specify the indexes to maintain for the given attribute (or
  58 list of attributes).
  59 Some attributes only support a subset of indexes.
  60 If only an \fI<attr>\fP is given, the indices specified for \fBdefault\fR
  61 are maintained.
  62 Note that setting a default does not imply that all attributes will be
  63 indexed. Also, for best performance, an
  64 .B eq
  65 index should always be configured for the
  66 .B objectClass
  67 attribute.
  68
  69 .SH ACCESS CONTROL
  70 The
  71 .B wt
  72 backend honors access control semantics as indicated in
  73 .BR slapd.access (5).
  74 .SH FILES
  75 .TP
  76 .B ETCDIR/slapd.conf
  77 default
  78 .B slapd
  79 configuration file
  80 .SH SEE ALSO
  81 .BR slapd.conf (5),
  82 .BR slapd\-config (5),
  83 .BR slapd (8),
  84 .BR slapadd (8),
  85 .BR slapcat (8),
  86 .BR slapindex (8),
  87 WiredTiger documentation.
  88 .SH ACKNOWLEDGEMENTS
  89 .so ../Project
  90 Written by HAMANO Tsukasa <hamano@osstech.co.jp>.