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

   1 .TH SLAPO-VALSORT 5 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" Copyright 2005-2012 The OpenLDAP Foundation All Rights Reserved.
   3 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   4 .\" $OpenLDAP$
   5 .SH NAME
   6 slapo\-valsort \- Value Sorting overlay to slapd
   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.
  31 .TP
  32 valsort\-attr <\fIattribute\fP> <\fIbaseDN\fP> (<\fIsort-method\fP> | weighted [<\fIsort-method\fP>])
  33 Configure a sorting method for the specified
  34 .I attribute
  35 in the subtree rooted at
  36 .IR baseDN .
  37 The
  38 .I sort-method
  39 may be one of
  40 .BR alpha\-ascend ,
  41 .BR alpha\-descend ,
  42 .BR numeric\-ascend ,
  43 or
  44 .BR numeric\-descend .
  45 If the special
  46 .B weighted
  47 method is specified, a secondary
  48 .I sort-method
  49 may also be specified. It is an
  50 error to specify an alphanumeric
  51 .I sort-method
  52 for an attribute with Integer
  53 or NumericString syntax, and it is an error to specify a numeric
  54 .I sort-method
  55 for an attribute with a syntax other than Integer or NumericString.
  56 .SH EXAMPLES
  57 .LP
  58 .nf
  59         database bdb
  60         suffix dc=example,dc=com
  61         ...
  62         overlay valsort
  63         valsort\-attr member ou=groups,dc=example,dc=com alpha\-ascend
  64 .fi
  65
  66 .SH FILES
  67 .TP
  68 \fIETCDIR/slapd.conf\fP
  69 default \fBslapd\fP configuration file
  70 .SH SEE ALSO
  71 .BR slapd.conf (5),
  72 .BR slapd\-config (5).
  73 .SH ACKNOWLEDGEMENTS
  74 .P
  75 This module was written in 2005 by Howard Chu of Symas Corporation. The
  76 work was sponsored by Stanford University.