org.apache.calcite.adapter.jdbc

Class JdbcTable

java.lang.Object

org.apache.calcite.schema.impl.AbstractTable

org.apache.calcite.adapter.java.AbstractQueryableTable

org.apache.calcite.adapter.jdbc.JdbcTable

All Implemented Interfaces:

ModifiableTable, QueryableTable, ScannableTable, Table, TranslatableTable, Wrapper

public class JdbcTable
extends AbstractQueryableTable
implements TranslatableTable, ScannableTable, ModifiableTable

Queryable that gets its data from a table within a JDBC connection.

The idea is not to read the whole table, however. The idea is to use this as a building block for a query, by applying Queryable operators such as ExtendedEnumerable.where(org.apache.calcite.linq4j.function.Predicate2). The resulting queryable can then be converted to a SQL query, which can be executed efficiently on the JDBC server.

Field Summary

Fields

Modifier and Type	Field and Description
String	jdbcCatalogName
JdbcSchema	jdbcSchema
String	jdbcSchemaName
String	jdbcTableName
Schema.TableType	jdbcTableType

Fields inherited from class org.apache.calcite.adapter.java.AbstractQueryableTable

elementType

Method Summary

Modifier and Type	Method and Description
<T> org.apache.calcite.linq4j.Queryable<T>	asQueryable(org.apache.calcite.linq4j.QueryProvider queryProvider, SchemaPlus schema, String tableName) Converts this table into a Queryable.
Schema.TableType	getJdbcTableType() Type of table.
@Nullable Collection	getModifiableCollection() Returns the modifiable collection.
RelDataType	getRowType(RelDataTypeFactory typeFactory) Returns this table's row type.
org.apache.calcite.linq4j.Enumerable<Object[]>	scan(DataContext root) Returns an enumerator over the rows in this Table.
SqlIdentifier	tableName() Returns the table name, qualified with catalog and schema name if applicable, as a parse tree node (SqlIdentifier).
TableModify	toModificationRel(RelOptCluster cluster, RelOptTable table, Prepare.CatalogReader catalogReader, RelNode input, TableModify.Operation operation, @Nullable List<String> updateColumnList, @Nullable List<RexNode> sourceExpressionList, boolean flattened) Creates a relational expression that modifies this table.
RelNode	toRel(RelOptTable.ToRelContext context, RelOptTable relOptTable) Converts this table into a relational expression.
String	toString()
<C> C	unwrap(Class<C> aClass) Finds an instance of an interface implemented by this object, or returns null if this object does not support that interface.

Methods inherited from class org.apache.calcite.adapter.java.AbstractQueryableTable

getElementType, getExpression

Methods inherited from class org.apache.calcite.schema.impl.AbstractTable

getStatistic, isRolledUp, rolledUpColumnValidInsideAgg

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.calcite.schema.QueryableTable

getElementType, getExpression

Methods inherited from interface org.apache.calcite.schema.Table

getStatistic, isRolledUp, rolledUpColumnValidInsideAgg

Methods inherited from interface org.apache.calcite.schema.Wrapper

maybeUnwrap, unwrapOrThrow

Field Detail

jdbcSchema

public final JdbcSchema jdbcSchema

jdbcCatalogName

public final String jdbcCatalogName

jdbcSchemaName

public final String jdbcSchemaName

jdbcTableName

public final String jdbcTableName

jdbcTableType

public final Schema.TableType jdbcTableType

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getJdbcTableType

public Schema.TableType getJdbcTableType()

Description copied from interface: Table

Type of table.

Specified by:

getJdbcTableType in interface Table

Overrides:

getJdbcTableType in class AbstractTable

unwrap

public <C> C unwrap(Class<C> aClass)

Description copied from interface: Wrapper

Finds an instance of an interface implemented by this object, or returns null if this object does not support that interface.

Specified by:

unwrap in interface Wrapper

Overrides:

unwrap in class AbstractTable

getRowType

public RelDataType getRowType(RelDataTypeFactory typeFactory)

Description copied from interface: Table

Returns this table's row type.

This is a struct type whose fields describe the names and types of the columns in this table.

The implementer must use the type factory provided. This ensures that the type is converted into a canonical form; other equal types in the same query will use the same object.

Specified by:

getRowType in interface Table

Parameters:

typeFactory - Type factory with which to create the type

Returns:

Row type

tableName

public SqlIdentifier tableName()

Returns the table name, qualified with catalog and schema name if applicable, as a parse tree node (SqlIdentifier).

toRel

public RelNode toRel(RelOptTable.ToRelContext context,
                     RelOptTable relOptTable)

Description copied from interface: TranslatableTable

Converts this table into a relational expression.

Specified by:

toRel in interface TranslatableTable

asQueryable

public <T> org.apache.calcite.linq4j.Queryable<T> asQueryable(org.apache.calcite.linq4j.QueryProvider queryProvider,
                                                              SchemaPlus schema,
                                                              String tableName)

Description copied from interface: QueryableTable

Converts this table into a Queryable.

Specified by:

asQueryable in interface QueryableTable

scan

public org.apache.calcite.linq4j.Enumerable<Object[]> scan(DataContext root)

Description copied from interface: ScannableTable

Returns an enumerator over the rows in this Table. Each row is represented as an array of its column values.

Specified by:

scan in interface ScannableTable

getModifiableCollection

public @Nullable Collection getModifiableCollection()

Description copied from interface: ModifiableTable

Returns the modifiable collection. Modifying the collection will change the table's contents.

Specified by:

getModifiableCollection in interface ModifiableTable

toModificationRel

public TableModify toModificationRel(RelOptCluster cluster,
                                     RelOptTable table,
                                     Prepare.CatalogReader catalogReader,
                                     RelNode input,
                                     TableModify.Operation operation,
                                     @Nullable List<String> updateColumnList,
                                     @Nullable List<RexNode> sourceExpressionList,
                                     boolean flattened)

Description copied from interface: ModifiableTable

Creates a relational expression that modifies this table.

Specified by:

toModificationRel in interface ModifiableTable