org.apache.beam.sdk.extensions.sql.udf

Class ScalarFn

java.lang.Object

org.apache.beam.sdk.extensions.sql.udf.ScalarFn

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

UdfTestProvider.DateIncrementAllFn, UdfTestProvider.HelloWorldFn, UdfTestProvider.IncrementFn, UdfTestProvider.IsNullFn, UdfTestProvider.MatchFn, UdfTestProvider.UnusedFn

public abstract class ScalarFn
extends java.lang.Object
implements java.io.Serializable

A scalar function that can be executed as part of a SQL query. Subclasses must contain exactly one method annotated with ScalarFn.ApplyMethod, which will be applied to the SQL function arguments at runtime.

For example:

 public class IncrementFn extends ScalarFn {
   @ApplyMethod
   public Long increment(Long i) {
     return i + 1;
   }
 }
 

ScalarFn is experimental. Compatibility is not guaranteed across Beam versions.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ScalarFn.ApplyMethod Annotates the single method in a ScalarFn implementation that is to be applied to SQL function arguments.

Constructor Summary

Constructors

Constructor and Description
ScalarFn()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScalarFn

public ScalarFn()