org.apache.calcite.schema.impl

Class ViewTableMacro

java.lang.Object

org.apache.calcite.schema.impl.ViewTableMacro

All Implemented Interfaces:

Function, TableMacro

Direct Known Subclasses:

MaterializedViewTable.MaterializedViewTableMacro

public class ViewTableMacro
extends Object
implements TableMacro

Table function that implements a view. It returns the operator tree of the view's SQL query.

Field Summary

Fields

Modifier and Type	Field and Description
protected CalciteSchema	schema
protected @Nullable List<String>	schemaPath Typically null.
protected @Nullable List<String>	viewPath
protected String	viewSql

Constructor Summary

Constructors

Constructor and Description
ViewTableMacro(CalciteSchema schema, String viewSql, @Nullable List<String> schemaPath, @Nullable List<String> viewPath, @Nullable Boolean modifiable) Creates a ViewTableMacro.

Method Summary

Modifier and Type	Method and Description
TranslatableTable	apply(List<? extends Object> arguments) Applies arguments to yield a table.
List<FunctionParameter>	getParameters() Returns the parameters of this function.
protected ModifiableViewTable	modifiableViewTable(CalcitePrepare.AnalyzeViewResult parsed, String viewSql, List<String> schemaPath, @Nullable List<String> viewPath, CalciteSchema schema) Allows a sub-class to return an extension of ModifiableViewTable by overriding this method.
protected ViewTable	viewTable(CalcitePrepare.AnalyzeViewResult parsed, String viewSql, List<String> schemaPath, @Nullable List<String> viewPath) Allows a sub-class to return an extension of ViewTable by overriding this method.

Methods inherited from class java.lang.Object

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

Field Detail

viewSql

protected final String viewSql

schema

protected final CalciteSchema schema

schemaPath

protected final @Nullable List<String> schemaPath

Typically null. If specified, overrides the path of the schema as the context for validating viewSql.

viewPath

protected final @Nullable List<String> viewPath

Constructor Detail

ViewTableMacro

public ViewTableMacro(CalciteSchema schema,
                      String viewSql,
                      @Nullable List<String> schemaPath,
                      @Nullable List<String> viewPath,
                      @Nullable Boolean modifiable)

Creates a ViewTableMacro.

Parameters:

schema - Root schema

viewSql - SQL defining the view

schemaPath - Schema path relative to the root schema

viewPath - View path relative to the schema path

modifiable - Request that a view is modifiable (dependent on analysis of viewSql)

Method Detail

getParameters

public List<FunctionParameter> getParameters()

Description copied from interface: Function

Returns the parameters of this function.

Specified by:

getParameters in interface Function

Returns:

Parameters; never null

apply

public TranslatableTable apply(List<? extends Object> arguments)

Description copied from interface: TableMacro

Applies arguments to yield a table.

Specified by:

apply in interface TableMacro

Parameters:

arguments - Arguments

Returns:

Table

modifiableViewTable

protected ModifiableViewTable modifiableViewTable(CalcitePrepare.AnalyzeViewResult parsed,
                                                  String viewSql,
                                                  List<String> schemaPath,
                                                  @Nullable List<String> viewPath,
                                                  CalciteSchema schema)

Allows a sub-class to return an extension of ModifiableViewTable by overriding this method.

viewTable

protected ViewTable viewTable(CalcitePrepare.AnalyzeViewResult parsed,
                              String viewSql,
                              List<String> schemaPath,
                              @Nullable List<String> viewPath)

Allows a sub-class to return an extension of ViewTable by overriding this method.