Version:

UDF

The UDF menu allows you to manage your User-Defined Functions (UDFs). The UDF menu is only available if UDFs have been enabled. See User-Defined Function Implementation for UDF configuration requirements and User-Defined Functions Overview for detail on UDFs themselves.

Important

The UDF section is only available to users with the System Admin permission.

UDF

UDF is the UDF homepage and allows executing, creating, editing, and deleting UDFs. For more detail on Running UDFs, see the Running Python, Java , or C++ UDF pages (depending on your preference).

../_images/udf_procs.png

Creating Procs

Click New to create a new proc.

../_images/udf_procs_new.png

Provide the name of the proc, command necessary to run the proc file (e.g., python, java), and any command-line arguments (e.g., Java class path and/or name, custom Python or C++ arguments; click Add to add additional arguments), then fill the Distributed checkbox if the UDF should be in distributed mode and fill the Limit Concurrency checkbox and type a number to set a concurrency limit. Finally, upload a proc file(s) by clicking Choose file(s) and selecting the proc file(s) from your computer.

Here's an example of the Java Sum of Squares UDF proc being created in GAdmin:

../_images/udf_procs_new_filled.png

Executing UDFs

To execute a UDF, click a UDF then click Execute.

../_images/udf_procs_execute.png

Click Add to add additional parameter names and values, input tables and columns, and/or output tables, then click Execute.

Here's an example of the same Java Sum of Squares UDF proc being set up for execution in GAdmin:

../_images/udf_procs_execute_filled.png

Editing UDFs

To edit a UDF, select a UDF then click Edit. Edit the name or command as necessary, then add or edit arguments. Select the Distributed checkbox if the UDF should run in distributed mode, or clear the checkbox if the UDF should run in non-distributed mode. Select the Limit Concurrency checkbox and adjust the setting to set a concurrency limit, or clear the checkbox to remove the limit. Once editing is finished, click Save.

Important

You cannot change the file for the proc once it has been uploaded.

../_images/udf_procs_edit.png

Deleting UDFs

To delete a UDF, select a UDF then click Delete and confirm the deletion of the selected UDF.

Status

Status displays active, idle, and completed procs. Like Job Manager, this page is automatically refreshed based on the selected interval, so you can see procs' statuses and total run time update at each interval. This page can be manually refreshed by clicking refresh.

../_images/udf_status.png

To kill a stalled proc, select the proc then click Kill.

Once a proc has been completed or killed, you can clear out the status list by clicking Clear Completed.

Click the Run ID to see a detailed status of the UDF execution process.

../_images/udf_detailed_status.png