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

Class BeamSqlEnv

java.lang.Object

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

All Implemented Interfaces:

java.io.Serializable

public class BeamSqlEnv
extends java.lang.Object
implements java.io.Serializable

BeamSqlEnv prepares the execution context for BeamSql and BeamSqlCli.

It contains a SchemaPlus which holds the metadata of tables/UDF functions, and a BeamQueryPlanner which parse/validate/optimize/translate input SQL queries.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BeamSqlEnv()

Method Summary

Modifier and Type	Method and Description
void	deregisterTable(java.lang.String targetTableName)
BeamSqlTable	findTable(java.lang.String tableName) Find BaseBeamTable by table name.
BeamQueryPlanner	getPlanner()
void	registerPCollection(java.lang.String name, PCollection<Row> pCollection) Registers PCollection of Rows as a table.
void	registerPCollectionTuple(PCollectionTuple pCollectionTuple) Registers PCollections in PCollectionTuple as a tables.
void	registerTable(java.lang.String tableName, BeamSqlTable table) Registers a BaseBeamTable which can be used for all subsequent queries.
void	registerTable(java.lang.String tableName, PCollection<Row> pCollection, RowType rowType) Registers PCollection as a table.
void	registerUdaf(java.lang.String functionName, Combine.CombineFn combineFn) Register a UDAF function which can be used in GROUP-BY expression.
void	registerUdf(java.lang.String functionName, java.lang.Class<?> clazz, java.lang.String method) Register a UDF function which can be used in SQL expression.
void	registerUdf(java.lang.String functionName, java.lang.Class<? extends BeamSqlUdf> clazz) Register a UDF function which can be used in SQL expression.
void	registerUdf(java.lang.String functionName, SerializableFunction sfn) Register SerializableFunction as a UDF function which can be used in SQL expression.

Methods inherited from class java.lang.Object

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

Constructor Detail

BeamSqlEnv

public BeamSqlEnv()

Method Detail

registerUdf

public void registerUdf(java.lang.String functionName,
                        java.lang.Class<?> clazz,
                        java.lang.String method)

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

registerUdf

public void registerUdf(java.lang.String functionName,
                        java.lang.Class<? extends BeamSqlUdf> clazz)

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

registerUdf

public void registerUdf(java.lang.String functionName,
                        SerializableFunction sfn)

Register SerializableFunction as a UDF function which can be used in SQL expression. Note, SerializableFunction must have a constructor without arguments.

registerUdaf

public void registerUdaf(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.

registerPCollectionTuple

public void registerPCollectionTuple(PCollectionTuple pCollectionTuple)

Registers PCollections in PCollectionTuple as a tables.

Assumes that PCollection elements are Rows.

TupleTag.getId()s are used as table names.

registerPCollection

public void registerPCollection(java.lang.String name,
                                PCollection<Row> pCollection)

Registers PCollection of Rows as a table.

Assumes that PCollection.getCoder() returns an instance of RowCoder.

registerTable

public void registerTable(java.lang.String tableName,
                          PCollection<Row> pCollection,
                          RowType rowType)

Registers PCollection as a table.

registerTable

public void registerTable(java.lang.String tableName,
                          BeamSqlTable table)

Registers a BaseBeamTable which can be used for all subsequent queries.

deregisterTable

public void deregisterTable(java.lang.String targetTableName)

findTable

public BeamSqlTable findTable(java.lang.String tableName)

Find BaseBeamTable by table name.

getPlanner

public BeamQueryPlanner getPlanner()