openldap/doc/man/man5/slapd-wt.5

98 lines
2.6 KiB
Groff
Raw Normal View History

2015-04-26 21:27:58 -04:00
.TH SLAPD-WT 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2024-03-26 15:45:07 -04:00
.\" Copyright 2011-2024 The OpenLDAP Foundation All Rights Reserved.
2015-04-26 21:27:58 -04:00
.\" Copying restrictions apply. See COPYRIGHT/LICENSE.
.\" $OpenLDAP$
.SH NAME
slapd\-wt \- WiredTiger backend to slapd
.SH SYNOPSIS
.B ETCDIR/slapd.conf
.SH DESCRIPTION
The \fBwt\fP backend to
.BR slapd (8)
uses WiredTiger database library to store data.
.LP
The \fBwt\fP backend is experimental module that have potential high
write performance and high concurrency performance.
This backend have not some basic feature yet. Please backup data using
slapcat before update the module.
.SH CONFIGURATION
These
.B slapd.conf
options apply to the \fBwt\fP backend database.
That is, they must follow a "database wt" line and
come before any subsequent "backend" or "database" lines.
Other database options are described in the
.BR slapd.conf (5)
manual page.
.TP
.BI directory \ <directory>
Specify WiredTiger home directory that containing this database and
associated indexes live.
A separate directory must be specified for each database.
The default is
.BR LOCALSTATEDIR/openldap\-data .
.TP
ITS#9463 cumulative fix for back-wt - LDAP MODRDN handling - support paged response - add wt_extended - add config emit - wt_key_read() return WT_NOTFOUND if not found key. - add ext_candidates() - fix idlcache session name - fix warning - don't reuse idlcache cursor - set correct pid when modrdn with newsuperior - fix condition bug - fix send_search_entry() error handling - fix for referral handling - fix for readonly mode - fix sizelimit response - support modrdn - improve modify handling - clear ancestor idlcache - fix for multi-DIT - IMPORTANT CHANGES: Compatibility is broken with previous database table, please restore database from LDIF. - checking for scope=children - sort dn2idl result - fix cursor leak - support db_open with readonly mode - add wt_tool_entry_delete - initialize comp variable - support referrals - implement wt_tool_dn2id_get() and wt_tool_entry_modify() for slapadd -w - skip redundant scan, and more debug message - fix OID conflict with back-passwd - no need to close session, It may cause SEGV. - fixed wt_dn2entry for empty DN - support multiple database - Construct wiredtiger's config parameter. It allow multi line wtconfig settings - add idlcache - fix concurrent modification to a entry with multi values - prevent to add duplicate dn entry - suppress error message "search_near failed: WT_NOTFOUND" - update Debug statements - back-wt does not support subtree rename - fix for @ondra review - update slapd-wt.5 and warning for mode option - add back-wt test into test target - add scope checking
2021-02-10 08:56:09 -05:00
.BI idlcache \ <boolean>
Use the in-memory idlcache. The default is true.
.TP
\fBindex \fR{\fI<attrlist>\fR|\fBdefault\fR} [\fBpres\fR,\fBeq\fR,\fBapprox\fR,\fBsub\fR,\fI<special>\fR]
Specify the indexes to maintain for the given attribute (or
list of attributes).
Some attributes only support a subset of indexes.
If only an \fI<attr>\fP is given, the indices specified for \fBdefault\fR
are maintained.
Note that setting a default does not imply that all attributes will be
indexed. Also, for best performance, an
.B eq
index should always be configured for the
.B objectClass
attribute.
.TP
.BI mode \ <integer>
back-wt does not support mode option. use umask instead.
.TP
2015-04-26 21:27:58 -04:00
\fBwtconfig \fR{\fBcreate\fR,\fBcache_size=512M\fR,\fBasync=(enabled)\fR}
Specify configuration for wiredtiger, This parameter is pass to
.BR wiredtiger_open (3).
.RS
.TP
.B create
create the database if it does not exist.
.RE
.RS
.TP
.B cache_size
maximum heap memory to allocate for the cache.
.RE
.RS
.TP
.B async
asynchronous operations configuration options. disabled by default.
.RE
.RS
.SH ACCESS CONTROL
The
.B wt
backend honors access control semantics as indicated in
.BR slapd.access (5).
.SH FILES
.TP
.B ETCDIR/slapd.conf
default
.B slapd
configuration file
.SH SEE ALSO
.BR slapd.conf (5),
.BR slapd\-config (5),
.BR slapd (8),
.BR slapadd (8),
.BR slapcat (8),
.BR slapindex (8),
.BR slapmodify (8),
2015-04-26 21:27:58 -04:00
WiredTiger documentation.
.SH ACKNOWLEDGEMENTS
.so ../Project
Written by HAMANO Tsukasa <hamano@osstech.co.jp>.