org.apache.beam.sdk.extensions.sql

Class BeamSql.QueryTransform

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PCollectionTuple,PCollection<BeamRecord>>

org.apache.beam.sdk.extensions.sql.BeamSql.QueryTransform

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

BeamSql

public static class BeamSql.QueryTransform
extends PTransform<PCollectionTuple,PCollection<BeamRecord>>

A PTransform representing an execution plan for a SQL query.

The table names in the input PCollectionTuple are only valid during the current query.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.beam.sdk.transforms.PTransform

name

Constructor Summary

Constructors

Constructor and Description
QueryTransform(java.lang.String sqlQuery)

Method Summary

Modifier and Type	Method and Description
PCollection<BeamRecord>	expand(PCollectionTuple input) Override this method to specify how this PTransform should be expanded on the given InputT.
BeamSql.QueryTransform	withUdaf(java.lang.String functionName, Combine.CombineFn combineFn) register a Combine.CombineFn as UDAF function used in this query.
BeamSql.QueryTransform	withUdf(java.lang.String functionName, java.lang.Class<? extends BeamSqlUdf> clazz) register a UDF function used in this query.
BeamSql.QueryTransform	withUdf(java.lang.String functionName, SerializableFunction sfn) register SerializableFunction as a UDF function used in this query.

Methods inherited from class org.apache.beam.sdk.transforms.PTransform

getAdditionalInputs, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, populateDisplayData, toString, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryTransform

public QueryTransform(java.lang.String sqlQuery)

Method Detail

withUdf

public BeamSql.QueryTransform withUdf(java.lang.String functionName,
                                      java.lang.Class<? extends BeamSqlUdf> clazz)

register a UDF function used in this query.

Refer to BeamSqlUdf for more about how to implement a UDF in BeamSql.

withUdf

public BeamSql.QueryTransform withUdf(java.lang.String functionName,
                                      SerializableFunction sfn)

register SerializableFunction as a UDF function used in this query. Note, SerializableFunction must have a constructor without arguments.

withUdaf

public BeamSql.QueryTransform withUdaf(java.lang.String functionName,
                                       Combine.CombineFn combineFn)

register a Combine.CombineFn as UDAF function used in this query.

expand

public PCollection<BeamRecord> expand(PCollectionTuple input)

Description copied from class: PTransform

Override this method to specify how this PTransform should be expanded on the given InputT.

NOTE: This method should not be called directly. Instead apply the PTransform should be applied to the InputT using the apply method.

Composite transforms, which are defined in terms of other transforms, should return the output of one of the composed transforms. Non-composite transforms, which do not apply any transforms internally, should return a new unbound output and register evaluators (via backend-specific registration methods).

Specified by:

expand in class PTransform<PCollectionTuple,PCollection<BeamRecord>>