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

Class BeamSqlEnv

java.lang.Object

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

@Internal
@Experimental
public class BeamSqlEnv
extends java.lang.Object

Contains the metadata of tables/UDF functions, and exposes APIs to query/validate/optimize/translate SQL statements.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BeamSqlEnv.BeamSqlEnvBuilder	BeamSqlEnv's Builder.

Method Summary

Modifier and Type	Method	Description
static BeamSqlEnv.BeamSqlEnvBuilder	builder(TableProvider tableProvider)	Creates a builder with the default schema backed by the table provider.
void	executeDdl(java.lang.String sqlStatement)
java.lang.String	explain(java.lang.String sqlString)
org.apache.beam.vendor.calcite.v1_28_0.org.apache.calcite.jdbc.CalcitePrepare.Context	getContext()
java.util.Map<java.lang.String,java.lang.String>	getPipelineOptions()
static BeamSqlEnv	inMemory(TableProvider... tableProviders)	This method creates BeamSqlEnv using empty * Pipeline Options.
boolean	isDdl(java.lang.String sqlStatement)
BeamRelNode	parseQuery(java.lang.String query)
BeamRelNode	parseQuery(java.lang.String query, QueryPlanner.QueryParameters queryParameters)
static BeamSqlEnv	readOnly(java.lang.String tableType, java.util.Map<java.lang.String,BeamSqlTable> tables)	This method creates BeamSqlEnv using empty Pipeline Options.
static BeamSqlEnv	withTableProvider(TableProvider tableProvider)	This method creates BeamSqlEnv using empty Pipeline Options.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static BeamSqlEnv.BeamSqlEnvBuilder builder(TableProvider tableProvider)

Creates a builder with the default schema backed by the table provider.

readOnly

public static BeamSqlEnv readOnly(java.lang.String tableType,
                                  java.util.Map<java.lang.String,BeamSqlTable> tables)

This method creates BeamSqlEnv using empty Pipeline Options. It should only be used in tests.

withTableProvider

public static BeamSqlEnv withTableProvider(TableProvider tableProvider)

This method creates BeamSqlEnv using empty Pipeline Options. It should only be used in tests.

inMemory

public static BeamSqlEnv inMemory(TableProvider... tableProviders)

This method creates BeamSqlEnv using empty * Pipeline Options. It should only be used in tests.

parseQuery

public BeamRelNode parseQuery(java.lang.String query)
                       throws ParseException

Throws:

ParseException

parseQuery

public BeamRelNode parseQuery(java.lang.String query,
                              QueryPlanner.QueryParameters queryParameters)
                       throws ParseException

Throws:

ParseException

isDdl

public boolean isDdl(java.lang.String sqlStatement)
              throws ParseException

Throws:

ParseException

executeDdl

public void executeDdl(java.lang.String sqlStatement)
                throws ParseException

Throws:

ParseException

getContext

public org.apache.beam.vendor.calcite.v1_28_0.org.apache.calcite.jdbc.CalcitePrepare.Context getContext()

getPipelineOptions

public java.util.Map<java.lang.String,java.lang.String> getPipelineOptions()

explain

public java.lang.String explain(java.lang.String sqlString)
                         throws ParseException

Throws:

ParseException