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
  20 .B {<weight>}
  21 in front of each value of the attribute for which weighted sorting is
  22 desired. This weighting factor is stripped off and never returned in
  23 search results.
  24
  25 .SH CONFIGURATION
  26 These
  27 .B slapd.conf
  28 options apply to the Value Sorting overlay.
  29 They should appear after the
  30 .B overlay
  31 directive and before any subsequent
  32 .B database
  33 directive.
  34 .TP
  35 .B valsort-attr <attribute> <baseDN> (<sort-method> | weighted [<sort-method>])
  36 Configure a sorting method for the specified
  37 .B attribute
  38 in the subtree rooted at
  39 .BR baseDN .
  40 The
  41 .B sort-method
  42 may be one of
  43 .BR alpha-ascend ,
  44 .BR alpha-descend ,
  45 .BR numeric-ascend ,
  46 or
  47 .BR numeric-descend .
  48 If the special
  49 .B weighted
  50 method is specified, a secondary sort-method may also be specified. It is an
  51 error to specify an alphanumeric sort-method for an attribute with Integer
  52 or NumericString syntax, and it is an error to specify a numeric sort for
  53 an attribute with a syntax other than Integer or NumericString.
  54 .SH EXAMPLES
  55 .LP
  56 .nf
  57         database bdb
  58         suffix dc=example,dc=com
  59         ...
  60         overlay valsort
  61         valsort-attr member ou=groups,dc=example,dc=com alpha-ascend
  62 .fi
  63
  64 .SH FILES
  65 .TP
  66 ETCDIR/slapd.conf
  67 default slapd configuration file
  68 .SH SEE ALSO
  69 .BR slapd.conf (5).
  70 .SH ACKNOWLEDGEMENTS
  71 .P
  72 This module was written in 2005 by Howard Chu of Symas Corporation. The
  73 work was sponsored by Stanford University.