apache / apache/arrow

[Docs] UDF Documentation

Open
#31,097 2 comments 0 reactions 0 assignees View on GitHub
Component: Documentation Type: task
Dominant language
C++
Stars
17.1k
Forks
4.3k
Avg merge
3d 18h
Merged PRs (30d)
91

Description

Document the usage of UDFs and important facts about the limitations and provide warnings to the user. 

For example:

System calls to fork, modify system attributes or runtime information and states can be harmful when executed via a UDF. 

**Reporter**: [Vibhatha Lakmal Abeykoon](https://issues.apache.org/jira/browse/ARROW-15638) / @vibhatha

**Note**: *This issue was originally created as [ARROW-15638](https://issues.apache.org/jira/browse/ARROW-15638). Please see the [migration documentation](https://github.com/apache/arrow/issues/14542) for further details.*

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the issue's UDF usage example, the stated limitations around system calls and runtime state, and the linked migration documentation. Done means the documentation explains how to use UDFs and clearly warns about their limitations and potentially harmful operations.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.