1.lf 1 stdin
2.TH SLAPO-SSSVLV 5 "2020/04/28" "OpenLDAP 2.4.50"
3.\" Copyright 2009-2020 The OpenLDAP Foundation All Rights Reserved.
4.\" Copyright 2009 Symas Corporation All Rights Reserved.
5.\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
6.\" $OpenLDAP$
7.SH NAME
8slapo\-sssvlv \- Server Side Sorting and Virtual List View overlay to slapd
9.SH SYNOPSIS
10/etc/openldap/slapd.conf
11.SH DESCRIPTION
12This overlay implements the LDAP Server Side Sorting (RFC2891) control
13as well as the Virtual List View control. It also replaces the default
14implementation of the LDAP PagedResults (RFC2696) control, to ensure
15that it works with Sorting. The overlay can be used with any backend
16or globally for all backends.
17
18Since a complete result set must be generated in memory before sorting can
19be performed, processing sort requests can have a large impact on the
20server's memory use. As such, any connection is limited to having only
21a limited number of sort requests active at a time. Additional limits may
22be configured as described below.
23
24.SH CONFIGURATION
25These
26.B slapd.conf
27options apply to the SSSVLV overlay.
28They should appear after the
29.B overlay
30directive.
31.TP
32.B sssvlv\-max <num>
33Set the maximum number of concurrent sort requests allowed across all
34connections. The default is one half of the number of server threads.
35.TP
36.B sssvlv\-maxkeys <num>
37Set the maximum number of keys allowed in a sort request. The default is 5.
38.TP
39.B sssvlv\-maxperconn <num>
40Set the maximum number of concurrent paged search requests per connection. The default is 5. The number of concurrent requests remains limited by
41.B sssvlv-max.
42.SH FILES
43.TP
44/etc/openldap/slapd.conf
45default slapd configuration file
46.TP
47/etc/openldap/slapd.d
48default slapd configuration directory
49.SH SEE ALSO
50.BR slapd.conf (5),
51.BR slapd\-config (5).
52.LP
53"OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
54.LP
55IETF LDAP Virtual List View proposal by D. Boreham, J. Sermersheim,
56and A. Kashi in IETF document "draft-ietf-ldapext-ldapv3-vlv-09.txt".
57.SH AUTHOR
58Howard Chu
59