---

{ “title”: “MAX_BY”, “language”: “en”, “description”: “The MAXBY function returns the associated value based on the maximum value of the specified column.” }

Description

The MAX_BY function returns the associated value based on the maximum value of the specified column.

Syntax

MAX_BY(<expr1>, <expr2>)

Parameters

Parameter	Description
<expr1>	The expression for the associated value, supports types: Bool, TinyInt, SmallInt, Int, BigInt, LargeInt, Float, Double, Decimal, String, Date, Datetime, Array, Map, Struct.
<expr2>	The expression for the maximum value, supports types: Bool, TinyInt, SmallInt, Int, BigInt, LargeInt, Float, Double, Decimal, String, Date, Datetime, Array.

Return Value

Returns the same data type as . Returns NULL if there is no valid data in the group.

Example

-- setup
create table tbl(
    k1 int,
    k2 int,
    arr ARRAY<INT>,
    mp MAP<STRING, INT>,
    st STRUCT<a: INT, b: STRING>,
) distributed by hash(k1) buckets 1
properties ("replication_num"="1");
insert into tbl values
    (0, 100, [1,2,3], {"x": 1, "y": 4}, NAMED_STRUCT("a", 1, "b", "x")),
    (1, 4,   [5, 6],  {"x": 2, "y": 3}, NAMED_STRUCT("a", 2, "b", "y")),
    (4, 1,   [7],     {"x": 3, "y": 2}, NAMED_STRUCT("a", 3, "b", "z")),
    (3, 1,   [8],     {"x": 4, "y": 1}, NAMED_STRUCT("a", 4, "b", "r"));

select max_by(k1, k2) from tbl;

+----------------+
| max_by(k1, k2) |
+----------------+
|              0 |
+----------------+

select max_by(arr, k1), max_by(mp, k1), max_by(st, k1) from tbl;

+-----------------+----------------+------------------+
| max_by(arr, k1) | max_by(mp, k1) | max_by(st, k1)   |
+-----------------+----------------+------------------+
| [7]             | {"x":3, "y":2} | {"a":3, "b":"z"} |
+-----------------+----------------+------------------+

select max_by(k1, arr), max_by(mp, arr), max_by(st, arr), max_by(arr, arr) from tbl;

+-----------------+-----------------+------------------+------------------+
| max_by(k1, arr) | max_by(mp, arr) | max_by(st, arr)  | max_by(arr, arr) |
+-----------------+-----------------+------------------+------------------+
|               3 | {"x":4, "y":1}  | {"a":4, "b":"r"} | [8]              |
+-----------------+-----------------+------------------+------------------+

select max_by(k1, k2) from tbl where k1 is null;

+----------------+
| max_by(k1, k2) |
+----------------+
|           NULL |
+----------------+