home *** CD-ROM | disk | FTP | other *** search
/ Complete Linux / Complete Linux.iso / docs / apps / database / postgres / postgre2.z / postgre2 / ref / postquel / cluster < prev    next >
Encoding:
Text File  |  1992-08-27  |  1.3 KB  |  53 lines
  1. .\" XXX standard disclaimer belongs here....
  2. .\" $Header: /private/postgres/ref/postquel/RCS/cluster,v 1.6 1992/07/14 05:54:17 ptong Exp $
  3. .SP CLUSTER COMMANDS 6/14/90
  4. .XA 2 Cluster
  5. .uh NAME
  6. .lp
  7. cluster \*- give storage clustering advice to \*(PP
  8. .uh SYNOPSIS
  9. .lp
  10. .(l
  11. \fBcluster\fR classname \fBon\fR attname [\fBusing\fR operator ]
  12. .)l
  13. .uh DESCRIPTION
  14. .lp
  15. This command instructs \*(PP to keep the class specified by
  16. .i classname
  17. approximately sorted on
  18. .i attname
  19. using the specified operator
  20. to determine the sort order.
  21. The operator must be a binary operator
  22. and both operands must be of type
  23. .i attname
  24. and the operator
  25. must produce a result
  26. of type boolean.  If no operator is specified, then
  27. .q <
  28. is used by default.
  29. .lp
  30. A class can be reclustered at any time on a different
  31. .i attribute
  32. and/or with a different operator.  
  33. .lp
  34. \*(PP will try to keep the heap data structure which stores the
  35. instances of this class approximately in sorted order.  If the user
  36. specifies an operator which does not define a linear ordering, this
  37. command will produce unpredictable orderings.
  38. .lp
  39. Also, if there is no index for the clustering attribute,
  40. then this command will have no effect.
  41. .uh EXAMPLE
  42. .lp
  43. .nf
  44. .ft C
  45. /* cluster employees in salary order */
  46.  
  47. cluster emp on salary
  48. .ft
  49. .fi
  50. .uh BUGS
  51. .lp
  52. Cluster has no effect in Version \*(PV.
  53.