UDFRegistration

Defined in: udf-registration.ts:19

Methods

registerJavaFunction()

registerJavaFunction(
   name,
   javaClassName,
returnType?): Promise<void>;

Defined in: udf-registration.ts:48

Register a Java UDF as a SQL function.

The class must implement one of org.apache.spark.sql.api.java.UDF1 through UDF22 and must already be on the server’s classpath.

Parameters

Parameter	Type	Description
name	string	SQL function name to register under
javaClassName	string	Fully-qualified Java class name implementing the UDF
returnType?	string	Optional Spark SQL DDL type string for the return value (e.g. “INT”, “STRING”, “ARRAY”). Required when the return type cannot be inferred.

Returns

Promise<void>

Example

await spark.udf.registerJavaFunction(
    "my_upper",
    "com.example.UpperUDF",
    "STRING",
  );
  const df = spark.sql("SELECT my_upper(name) FROM people");

---

registerJavaUDAF()

registerJavaUDAF(name, javaClassName): Promise<void>;

Defined in: udf-registration.ts:68

Register a Java UDAF (user-defined aggregate function) as a SQL function.

The class must extend org.apache.spark.sql.expressions.UserDefinedAggregateFunction and must already be on the server’s classpath.

Parameters

Parameter	Type
name	string
javaClassName	string

Returns

Promise<void>