File tree 1 file changed +8
-0
lines changed
datafusion/physical-expr-common/src/aggregate
1 file changed +8
-0
lines changed Original file line number Diff line number Diff line change @@ -43,6 +43,14 @@ use datafusion_expr::utils::AggregateOrderSensitivity;
43
43
44
44
/// Creates a physical expression of the UDAF, that includes all necessary type coercion.
45
45
/// This function errors when `args`' can't be coerced to a valid argument type of the UDAF.
46
+ ///
47
+ /// `input_exprs` and `sort_exprs` are used for customizing Accumulator
48
+ /// whose behavior depends on arguments such as the `ORDER BY`.
49
+ ///
50
+ /// For example to call `ARRAY_AGG(x ORDER BY y)` would pass `y` to `sort_exprs`, `x` to `input_exprs`
51
+ ///
52
+ /// `input_exprs` and `sort_exprs` are used for customizing Accumulator as the arguments in `AccumulatorArgs`,
53
+ /// if you don't need them it is fine to pass empty slice `&[]`.
46
54
#[ allow( clippy:: too_many_arguments) ]
47
55
pub fn create_aggregate_expr (
48
56
fun : & AggregateUDF ,
You can’t perform that action at this time.
0 commit comments