1SLAPO-VALSORT(5) File Formats Manual SLAPO-VALSORT(5)
2
6 slapo-valsort - Value Sorting overlay to slapd
7
9 /etc/openldap/slapd.conf
10
12 The Value Sorting overlay can be used with a backend database to sort
13 the values of specific multi-valued attributes within a subtree. The
14 sorting occurs whenever the attributes are returned in a search re‐
15 sponse.
16 Sorting can be specified in ascending or descending order, using either
18 numeric or alphanumeric sort methods. Additionally, a "weighted" sort
19 can be specified, which uses a numeric weight prepended to the attri‐
20 bute values. The weighted sort is always performed in ascending order,
21 but may be combined with the other methods for values that all have
22 equal weights. The weight is specified by prepending an integer weight
23 {<weight>} in front of each value of the attribute for which weighted
24 sorting is desired. This weighting factor is stripped off and not re‐
25 turned in search results unless the valsort control is specified
26 (1.3.6.1.4.1.4203.666.5.14).
27 The valsort control requires a value consisting of a Sequence that con‐
29 tains a boolean flag. The weighting factor is only returned if the
30 boolean value is TRUE. In lber-encode(3) format, the required value
31 must conform to "{b}" syntax.
32
35 These slapd.conf options apply to the Value Sorting overlay. They
36 should appear after the overlay directive.
37 valsort-attr <attribute> <baseDN> (<sort-method> | weighted [<sort-
39 method>])
40 Configure a sorting method for the specified attribute in the
41 subtree rooted at baseDN. The sort-method may be one of al‐
42 pha-ascend, alpha-descend, numeric-ascend, or numeric-descend.
43 If the special weighted method is specified, a secondary sort-
44 method may also be specified. It is an error to specify an al‐
45 phanumeric sort-method for an attribute with Integer or Numeric‐
46 String syntax, and it is an error to specify a numeric sort-
47 method for an attribute with a syntax other than Integer or Nu‐
48 mericString.
49
51 database bdb
52 suffix dc=example,dc=com
53 ...
54 overlay valsort
55 valsort-attr member ou=groups,dc=example,dc=com alpha-ascend
56 To invoke ldapsearch(1) with the valsort control, the control value
58 must be set appropriately. The following octets represent the desired
59 "{b}" encoding:
60 0x30 0x03 0x01 0x01 0xff
62 The control can be sent from the command-line using the base64 encoding
64 of the value:
65 ldapsearch -E 1.3.6.1.4.1.4203.666.5.14=::MAMBAf8=
67
70 /etc/openldap/slapd.conf
71 default slapd configuration file
72
74 slapd.conf(5), slapd-config(5).
75
77 This module was written in 2005 by Howard Chu of Symas Corporation. The
78 work was sponsored by Stanford University.
79OpenLDAP 2021/06/03 SLAPO-VALSORT(5)