org.apache.beam.sdk.extensions.sql.impl

Class BeamSqlEnv.BeamSqlEnvBuilder

java.lang.Object

org.apache.beam.sdk.extensions.sql.impl.BeamSqlEnv.BeamSqlEnvBuilder

Enclosing class:

BeamSqlEnv

public static class BeamSqlEnv.BeamSqlEnvBuilder
extends java.lang.Object

BeamSqlEnv's Builder.

Method Summary

Modifier and Type	Method and Description
BeamSqlEnv.BeamSqlEnvBuilder	addSchema(java.lang.String name, TableProvider tableProvider) Add a top-level schema backed by the table provider.
BeamSqlEnv.BeamSqlEnvBuilder	addUdaf(java.lang.String functionName, Combine.CombineFn combineFn) Register a UDAF function which can be used in GROUP-BY expression.
BeamSqlEnv.BeamSqlEnvBuilder	addUdf(java.lang.String functionName, java.lang.Class<?> clazz, java.lang.String method) Register a UDF function which can be used in SQL expression.
BeamSqlEnv.BeamSqlEnvBuilder	addUdf(java.lang.String functionName, java.lang.Class<? extends BeamSqlUdf> clazz) Register a UDF function which can be used in SQL expression.
BeamSqlEnv.BeamSqlEnvBuilder	addUdf(java.lang.String functionName, SerializableFunction sfn) Register a UDF function which can be used in SQL expression.
BeamSqlEnv.BeamSqlEnvBuilder	autoLoadBuiltinFunctions() Load Beam SQL built-in functions defined in BeamBuiltinFunctionProvider.
BeamSqlEnv.BeamSqlEnvBuilder	autoLoadUserDefinedFunctions() Load UDF/UDAFs from UdfUdafProvider.
BeamSqlEnv	build() Build function to create an instance of BeamSqlEnv based on preset fields.
BeamSqlEnv.BeamSqlEnvBuilder	setCurrentSchema(java.lang.String name) Set the current (default) schema.
BeamSqlEnv.BeamSqlEnvBuilder	setPipelineOptions(PipelineOptions pipelineOptions)
BeamSqlEnv.BeamSqlEnvBuilder	setQueryPlannerClassName(java.lang.String name)
BeamSqlEnv.BeamSqlEnvBuilder	setRuleSets(java.util.Collection<org.apache.beam.vendor.calcite.v1_20_0.org.apache.calcite.tools.RuleSet> ruleSets) Set the ruleSet used for query optimizer.

Methods inherited from class java.lang.Object

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

Method Detail

addSchema

public BeamSqlEnv.BeamSqlEnvBuilder addSchema(java.lang.String name,
                                              TableProvider tableProvider)

Add a top-level schema backed by the table provider.

setCurrentSchema

public BeamSqlEnv.BeamSqlEnvBuilder setCurrentSchema(java.lang.String name)

Set the current (default) schema.

setRuleSets

public BeamSqlEnv.BeamSqlEnvBuilder setRuleSets(java.util.Collection<org.apache.beam.vendor.calcite.v1_20_0.org.apache.calcite.tools.RuleSet> ruleSets)

Set the ruleSet used for query optimizer.

addUdf

public BeamSqlEnv.BeamSqlEnvBuilder addUdf(java.lang.String functionName,
                                           java.lang.Class<?> clazz,
                                           java.lang.String method)

Register a UDF function which can be used in SQL expression.

addUdf

public BeamSqlEnv.BeamSqlEnvBuilder addUdf(java.lang.String functionName,
                                           java.lang.Class<? extends BeamSqlUdf> clazz)

Register a UDF function which can be used in SQL expression.

addUdf

public BeamSqlEnv.BeamSqlEnvBuilder addUdf(java.lang.String functionName,
                                           SerializableFunction sfn)

Register a UDF function which can be used in SQL expression.

addUdaf

public BeamSqlEnv.BeamSqlEnvBuilder addUdaf(java.lang.String functionName,
                                            Combine.CombineFn combineFn)

Register a UDAF function which can be used in GROUP-BY expression.

See Combine.CombineFn on how to implement a UDAF.

autoLoadUserDefinedFunctions

public BeamSqlEnv.BeamSqlEnvBuilder autoLoadUserDefinedFunctions()

Load UDF/UDAFs from UdfUdafProvider.

autoLoadBuiltinFunctions

public BeamSqlEnv.BeamSqlEnvBuilder autoLoadBuiltinFunctions()

Load Beam SQL built-in functions defined in BeamBuiltinFunctionProvider.

setQueryPlannerClassName

public BeamSqlEnv.BeamSqlEnvBuilder setQueryPlannerClassName(java.lang.String name)

setPipelineOptions

public BeamSqlEnv.BeamSqlEnvBuilder setPipelineOptions(PipelineOptions pipelineOptions)

build

public BeamSqlEnv build()

Build function to create an instance of BeamSqlEnv based on preset fields.

Returns:

BeamSqlEnv.