UDX overview

UDX types

UDX demo

Build a development environment

Register and use a UDX

1. Log on to the Realtime Compute development platform.
2. In the top navigation bar, click Development.
3. Click Resources on the left.
4. In the upper-right corner of the Resources pane, click Create Resource.
5. In the Upload Resource dialog box, configure resource parameters.

   Parameter	Description
   Location	You can only upload local JAR packages. Note The maximum size of a JAR package that you can upload is 300 MB. If the JAR package exceeds 300 MB, you must upload it to the Object Storage Service (OSS) bucket that is bound to your cluster or use OpenAPI to upload it.
   Resource	Click Upload Resource to select the resource that you want to reference.
   Resource Name	Enter a name for the resource.
   Resource Description	Enter a resource description.
   Resource Type	Select the type of the resource: JAR, DICTIONARY, or PYTHON.

6. On the Resources pane, locate the new resource, and move the pointer over More in the Actions column.
7. Select Reference from the drop-down list to present the resource code in the code editor.
8. In the code editor, declare the UDX at the beginning. An example is as follows:

   CREATE FUNCTION stringLengthUdf AS 'com.hjc.test.blink.sql.udx.StringLengthUdf';

Types of parameters and return values

Obtain parameters in UDXs

UDXs support an optional open(FunctionContext context) method. You can use FunctionContext to pass parameters of custom configuration items.

testKey1=lincoln
test.key2=todd

public void open(FunctionContext context) throws Exception {
      String key1 = context.getJobParameter("testKey1", "empty");
      String key2 = context.getJobParameter("test.key2", "empty");
      System.err.println(String.format("end open: key1:%s, key2:%s", key1, key2));
}