git.sur5r.net Git - openldap/blob - doc/man/man5/slapo-valsort.5

   1 .TH SLAPO-VALSORT 5 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" Copyright 2005 The OpenLDAP Foundation All Rights Reserved.
   3 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   4 .\" $OpenLDAP$
   5 .SH NAME
   6 slapo-valsort \- Value Sorting overlay
   7 .SH SYNOPSIS
   8 ETCDIR/slapd.conf
   9 .SH DESCRIPTION
  10 The Value Sorting overlay can be used with a backend database to sort the
  11 values of specific multi-valued attributes within a subtree. The sorting
  12 occurs whenever the attributes are returned in a search response.
  13 .LP
  14 Sorting can be specified in ascending or descending order, using either
  15 numeric or alphanumeric sort methods. Additionally, a "weighted" sort can
  16 be specified, which uses a numeric weight prepended to the attribute values.
  17 The weighted sort is always performed in ascending order, but may be combined
  18 with the other methods for values that all have equal weights. The weight
  19 is specified by prepending an integer weight {<\fIweight\fP>}
  20 in front of each value of the attribute for which weighted sorting is
  21 desired. This weighting factor is stripped off and never returned in
  22 search results.
  23
  24 .SH CONFIGURATION
  25 These
  26 .I slapd.conf
  27 options apply to the Value Sorting overlay.
  28 They should appear after the
  29 .B overlay
  30 directive and before any subsequent
  31 .B database
  32 directive.
  33 .TP
  34 valsort-attr <\fIattribute\fP> <\fIbaseDN\fP> (<\fIsort-method\fP> | weighted [<\fIsort-method\fP>])
  35 Configure a sorting method for the specified
  36 .I attribute
  37 in the subtree rooted at
  38 .IR baseDN .
  39 The
  40 .I sort-method
  41 may be one of
  42 .BR alpha-ascend ,
  43 .BR alpha-descend ,
  44 .BR numeric-ascend ,
  45 or
  46 .BR numeric-descend .
  47 If the special
  48 .B weighted
  49 method is specified, a secondary
  50 .I sort-method
  51 may also be specified. It is an
  52 error to specify an alphanumeric
  53 .I sort-method
  54 for an attribute with Integer
  55 or NumericString syntax, and it is an error to specify a numeric
  56 .I sort-method
  57 for an attribute with a syntax other than Integer or NumericString.
  58 .SH EXAMPLES
  59 .LP
  60 .nf
  61         database bdb
  62         suffix dc=example,dc=com
  63         ...
  64         overlay valsort
  65         valsort-attr member ou=groups,dc=example,dc=com alpha-ascend
  66 .fi
  67
  68 .SH FILES
  69 .TP
  70 \fIETCDIR/slapd.conf\fP
  71 default \fBslapd\fP configuration file
  72 .SH SEE ALSO
  73 .BR slapd.conf (5).
  74 .SH ACKNOWLEDGEMENTS
  75 .P
  76 This module was written in 2005 by Howard Chu of Symas Corporation. The
  77 work was sponsored by Stanford University.