CLUSTER BY Clause

Description

The CLUSTER BY clause is used to first repartition the data based on the input expressions and then sort the data within each partition. This is semantically equivalent to performing a DISTRIBUTE BY followed by a SORT BY. This clause only ensures that the resultant rows are sorted within each partition and does not guarantee a total order of output.

Syntax

  1. CLUSTER BY { expression [ , ... ] }

Parameters

  • expression

    Specifies combination of one or more values, operators and SQL functions that results in a value.

Examples

  1. CREATE TABLE person (name STRING, age INT);
  2. INSERT INTO person VALUES
  3.     ('Zen Hui', 25),
  4.     ('Anil B', 18),
  5.     ('Shone S', 16),
  6.     ('Mike A', 25),
  7.     ('John A', 18),
  8.     ('Jack N', 16);
  10. -- Reduce the number of shuffle partitions to 2 to illustrate the behavior of `CLUSTER BY`.
  11. -- It's easier to see the clustering and sorting behavior with less number of partitions.
  12. SET spark.sql.shuffle.partitions = 2;
  14. -- Select the rows with no ordering. Please note that without any sort directive, the results
  15. -- of the query is not deterministic. It's included here to show the difference in behavior
  16. -- of a query when `CLUSTER BY` is not used vs when it's used. The query below produces rows
  17. -- where age column is not sorted.
  18. SELECT age, name FROM person;
  19. +---+-------+
  20. |age|   name|
  21. +---+-------+
  22. | 16|Shone S|
  23. | 25|Zen Hui|
  24. | 16| Jack N|
  25. | 25| Mike A|
  26. | 18| John A|
  27. | 18| Anil B|
  28. +---+-------+
  30. -- Produces rows clustered by age. Persons with same age are clustered together.
  31. -- In the query below, persons with age 18 and 25 are in first partition and the
  32. -- persons with age 16 are in the second partition. The rows are sorted based
  33. -- on age within each partition.
  34. SELECT age, name FROM person CLUSTER BY age;
  35. +---+-------+
  36. |age|   name|
  37. +---+-------+
  38. | 18| John A|
  39. | 18| Anil B|
  40. | 25|Zen Hui|
  41. | 25| Mike A|
  42. | 16|Shone S|
  43. | 16| Jack N|
  44. +---+-------+