slapo-valsort.5 2.23 KB
Newer Older
Howard Chu's avatar
Howard Chu committed
1
.TH SLAPO-VALSORT 5 "RELEASEDATE" "OpenLDAP LDVERSION"
Kurt Zeilenga's avatar
Kurt Zeilenga committed
2
.\" Copyright 2005-2006 The OpenLDAP Foundation All Rights Reserved.
Howard Chu's avatar
Howard Chu committed
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
.\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
.\" $OpenLDAP$
.SH NAME
slapo-valsort \- Value Sorting overlay
.SH SYNOPSIS
ETCDIR/slapd.conf
.SH DESCRIPTION
The Value Sorting overlay can be used with a backend database to sort the
values of specific multi-valued attributes within a subtree. The sorting
occurs whenever the attributes are returned in a search response.
.LP
Sorting can be specified in ascending or descending order, using either
numeric or alphanumeric sort methods. Additionally, a "weighted" sort can
be specified, which uses a numeric weight prepended to the attribute values.
The weighted sort is always performed in ascending order, but may be combined
with the other methods for values that all have equal weights. The weight
Howard Chu's avatar
Howard Chu committed
19
is specified by prepending an integer weight {<\fIweight\fP>}
Howard Chu's avatar
Howard Chu committed
20
21
22
23
24
25
in front of each value of the attribute for which weighted sorting is
desired. This weighting factor is stripped off and never returned in
search results.

.SH CONFIGURATION
These
Howard Chu's avatar
Howard Chu committed
26
.I slapd.conf
Howard Chu's avatar
Howard Chu committed
27
28
29
30
31
options apply to the Value Sorting overlay.
They should appear after the
.B overlay
directive.
.TP
Howard Chu's avatar
Howard Chu committed
32
valsort-attr <\fIattribute\fP> <\fIbaseDN\fP> (<\fIsort-method\fP> | weighted [<\fIsort-method\fP>])
Howard Chu's avatar
Howard Chu committed
33
Configure a sorting method for the specified
Howard Chu's avatar
Howard Chu committed
34
.I attribute
Howard Chu's avatar
Howard Chu committed
35
in the subtree rooted at
Howard Chu's avatar
Howard Chu committed
36
.IR baseDN .
Howard Chu's avatar
Howard Chu committed
37
The 
Howard Chu's avatar
Howard Chu committed
38
.I sort-method
Howard Chu's avatar
Howard Chu committed
39
40
41
42
43
44
45
46
may be one of
.BR alpha-ascend ,
.BR alpha-descend ,
.BR numeric-ascend ,
or
.BR numeric-descend .
If the special
.B weighted
Howard Chu's avatar
Howard Chu committed
47
48
49
50
51
52
53
54
55
method is specified, a secondary
.I sort-method
may also be specified. It is an
error to specify an alphanumeric
.I sort-method
for an attribute with Integer
or NumericString syntax, and it is an error to specify a numeric
.I sort-method
for an attribute with a syntax other than Integer or NumericString.
Howard Chu's avatar
Howard Chu committed
56
57
58
59
60
61
62
63
64
65
66
67
.SH EXAMPLES
.LP
.nf
	database bdb
	suffix dc=example,dc=com
	...
	overlay valsort
	valsort-attr member ou=groups,dc=example,dc=com alpha-ascend
.fi

.SH FILES
.TP
Howard Chu's avatar
Howard Chu committed
68
69
\fIETCDIR/slapd.conf\fP
default \fBslapd\fP configuration file
Howard Chu's avatar
Howard Chu committed
70
71
72
73
74
75
.SH SEE ALSO
.BR slapd.conf (5).
.SH ACKNOWLEDGEMENTS
.P
This module was written in 2005 by Howard Chu of Symas Corporation. The
work was sponsored by Stanford University.