This is an automated email from the ASF dual-hosted git repository.
zeroshade pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-go.git
The following commit(s) were added to refs/heads/main by this push:
new e7b1e355 docs(compute): state which function kinds the registry
implements (#1303)
e7b1e355 is described below
commit e7b1e355c6f2b895e090d9ed71b0506b453f1311
Author: singhpratech <[email protected]>
AuthorDate: Tue Sep 8 15:18:27 2026 -0400
docs(compute): state which function kinds the registry implements (#1303)
### Rationale for this change
The package comment describes an Acero-like engine but does not say that
scalar aggregate and hash
aggregate functions are not implemented, so a reader coming from
`pyarrow.compute` or the C++
function list finds out by a failed `GetFunction`. #1296.
### What changes are included in this PR?
A "What is implemented" section in the `compute` package comment listing
the function kinds the
registry holds (scalar, vector, meta, with the families and the
vector/meta names) and stating that
`FuncScalarAgg` and `FuncHashAgg` have no registered functions yet.
### Are these changes tested?
Documentation only; the names were taken from `GetFunctionRegistry()` on
main.
### Are there any user-facing changes?
Documentation only. The aggregate kernels themselves are a separate
piece of work; see the issue.
---
arrow/compute/doc.go | 13 ++++++++++++-
1 file changed, 12 insertions(+), 1 deletion(-)
diff --git a/arrow/compute/doc.go b/arrow/compute/doc.go
index 6bb020ca..39d9848b 100644
--- a/arrow/compute/doc.go
+++ b/arrow/compute/doc.go
@@ -23,7 +23,18 @@
// is an attempt to provide for those users, and in general create a
// native-go arrow compute engine.
//
-// Everything in this package should be considered Experimental for now.
+// # What is implemented
+//
+// The function registry holds scalar functions (element-wise arithmetic,
+// comparisons, boolean logic, bit-wise operations, rounding, set lookup with
+// is_in, list_element and the null checks), vector functions (array_filter,
+// array_take, unique, dictionary_encode, cumulative_sum and the run-end
+// encode/decode functions) and the meta functions cast, filter, take, sort
+// and sort_indices that dispatch to them. Scalar aggregate functions (sum,
+// mean, min_max, count, any, all, variance and so on) and hash aggregate
+// functions (the hash_* family used for group-by) are not implemented yet:
+// FuncScalarAgg and FuncHashAgg exist as function kinds, but no function of
+// either kind is registered, and GetFunction returns false for their names.
package compute
//go:generate go tool stringer -type=FuncKind -linecomment
