org.apache.calcite.prepare

Class CalciteCatalogReader

java.lang.Object

org.apache.calcite.prepare.CalciteCatalogReader

All Implemented Interfaces:

RelOptSchema, Prepare.CatalogReader, Wrapper, SqlOperatorTable, SqlValidatorCatalogReader

public class CalciteCatalogReader
extends Object
implements Prepare.CatalogReader

Implementation of Prepare.CatalogReader and also SqlOperatorTable based on tables and functions defined schemas.

Field Summary

Fields

Modifier and Type	Field and Description
protected CalciteConnectionConfig	config
protected SqlNameMatcher	nameMatcher
protected CalciteSchema	rootSchema
protected RelDataTypeFactory	typeFactory

Fields inherited from interface org.apache.calcite.prepare.Prepare.CatalogReader

THREAD_LOCAL

Constructor Summary

Constructors

Modifier	Constructor and Description
	CalciteCatalogReader(CalciteSchema rootSchema, List<String> defaultSchema, RelDataTypeFactory typeFactory, CalciteConnectionConfig config)
protected	CalciteCatalogReader(CalciteSchema rootSchema, SqlNameMatcher nameMatcher, List<List<String>> schemaPaths, RelDataTypeFactory typeFactory, CalciteConnectionConfig config)

Method Summary

Modifier and Type	Method and Description
RelDataType	createTypeFromProjection(RelDataType type, List<String> columnNameList)
@Nullable RelDataTypeField	field(RelDataType rowType, String alias)
List<SqlMoniker>	getAllSchemaObjectNames(List<String> names) Given fully qualified schema name, returns schema object names as specified.
CalciteConnectionConfig	getConfig() Returns Config settings.
@Nullable RelDataType	getNamedType(SqlIdentifier typeName) Finds a user-defined type with the given name, possibly qualified.
List<SqlOperator>	getOperatorList() Retrieves a list of all functions and operators in this table.
CalciteSchema	getRootSchema() Returns the root namespace for name resolution.
List<List<String>>	getSchemaPaths() Returns the paths of all schemas to look in for tables.
Prepare.PreparingTable	getTable(List<String> names) Finds a table or schema with the given name, possibly qualified.
Prepare.PreparingTable	getTableForMember(List<String> names) Retrieves a RelOptTable based upon a member access.
RelDataTypeFactory	getTypeFactory() Returns the type factory used to generate types for this schema.
boolean	isCaseSensitive()
void	lookupOperatorOverloads(SqlIdentifier opName, @Nullable SqlFunctionCategory category, SqlSyntax syntax, List<SqlOperator> operatorList, SqlNameMatcher nameMatcher) Retrieves a list of operators with a given name and syntax.
boolean	matches(String string, String name)
SqlNameMatcher	nameMatcher() Returns an implementation of SqlNameMatcher that matches the case-sensitivity policy.
static SqlOperatorTable	operatorTable(String... classNames) Creates an operator table that contains functions in the given class or classes.
void	registerRules(RelOptPlanner planner) Registers all of the rules supported by this schema.
<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.
CalciteCatalogReader	withSchemaPath(List<String> schemaPath) Returns a catalog reader the same as this one but with a possibly different schema path.

Methods inherited from class java.lang.Object

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

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

maybeUnwrap, unwrapOrThrow

Field Detail

rootSchema

protected final CalciteSchema rootSchema

typeFactory

protected final RelDataTypeFactory typeFactory

nameMatcher

protected final SqlNameMatcher nameMatcher

config

protected final CalciteConnectionConfig config

Constructor Detail

CalciteCatalogReader

public CalciteCatalogReader(CalciteSchema rootSchema,
                            List<String> defaultSchema,
                            RelDataTypeFactory typeFactory,
                            CalciteConnectionConfig config)

CalciteCatalogReader

protected CalciteCatalogReader(CalciteSchema rootSchema,
                               SqlNameMatcher nameMatcher,
                               List<List<String>> schemaPaths,
                               RelDataTypeFactory typeFactory,
                               CalciteConnectionConfig config)

Method Detail

withSchemaPath

public CalciteCatalogReader withSchemaPath(List<String> schemaPath)

Description copied from interface: Prepare.CatalogReader

Returns a catalog reader the same as this one but with a possibly different schema path.

Specified by:

withSchemaPath in interface Prepare.CatalogReader

getTable

public Prepare.PreparingTable getTable(List<String> names)

Description copied from interface: SqlValidatorCatalogReader

Finds a table or schema with the given name, possibly qualified.

Uses the case-sensitivity policy of the catalog reader.

If not found, returns null. If you want a more descriptive error message or to override the case-sensitivity of the match, use SqlValidatorScope.resolveTable(java.util.List<java.lang.String>, org.apache.calcite.sql.validate.SqlNameMatcher, org.apache.calcite.sql.validate.SqlValidatorScope.Path, org.apache.calcite.sql.validate.SqlValidatorScope.Resolved).

Specified by:

getTable in interface Prepare.CatalogReader

Specified by:

getTable in interface SqlValidatorCatalogReader

Parameters:

names - Name of table, may be qualified or fully-qualified

Returns:

Table with the given name, or null

getConfig

public CalciteConnectionConfig getConfig()

Description copied from interface: SqlValidatorCatalogReader

Returns Config settings.

Specified by:

getConfig in interface SqlValidatorCatalogReader

getNamedType

public @Nullable RelDataType getNamedType(SqlIdentifier typeName)

Description copied from interface: SqlValidatorCatalogReader

Finds a user-defined type with the given name, possibly qualified.

NOTE jvs 12-Feb-2005: the reason this method is defined here instead of on RelDataTypeFactory is that it has to take into account context-dependent information such as SQL schema path, whereas a type factory is context-independent.

Specified by:

getNamedType in interface SqlValidatorCatalogReader

Parameters:

typeName - Name of type

Returns:

named type, or null if not found

getAllSchemaObjectNames

public List<SqlMoniker> getAllSchemaObjectNames(List<String> names)

Description copied from interface: SqlValidatorCatalogReader

Given fully qualified schema name, returns schema object names as specified. They can be schema, table, function, view. When names array is empty, the contents of root schema should be returned.

Specified by:

getAllSchemaObjectNames in interface SqlValidatorCatalogReader

Parameters:

names - the array contains fully qualified schema name or empty list for root schema

Returns:

the list of all object (schema, table, function, view) names under the above criteria

getSchemaPaths

public List<List<String>> getSchemaPaths()

Description copied from interface: SqlValidatorCatalogReader

Returns the paths of all schemas to look in for tables.

Specified by:

getSchemaPaths in interface SqlValidatorCatalogReader

Returns:

paths of current schema and root schema

getTableForMember

public Prepare.PreparingTable getTableForMember(List<String> names)

Description copied from interface: RelOptSchema

Retrieves a RelOptTable based upon a member access.

For example, the Saffron expression salesSchema.emps would be resolved using a call to salesSchema.getTableForMember(new String[]{"emps" }).

Note that name.length is only greater than 1 for queries originating from JDBC.

Specified by:

getTableForMember in interface RelOptSchema

Specified by:

getTableForMember in interface Prepare.CatalogReader

Parameters:

names - Qualified name

field

public @Nullable RelDataTypeField field(RelDataType rowType,
                                        String alias)

Specified by:

field in interface SqlValidatorCatalogReader

matches

public boolean matches(String string,
                       String name)

Specified by:

matches in interface SqlValidatorCatalogReader

createTypeFromProjection

public RelDataType createTypeFromProjection(RelDataType type,
                                            List<String> columnNameList)

Specified by:

createTypeFromProjection in interface SqlValidatorCatalogReader

lookupOperatorOverloads

public void lookupOperatorOverloads(SqlIdentifier opName,
                                    @Nullable SqlFunctionCategory category,
                                    SqlSyntax syntax,
                                    List<SqlOperator> operatorList,
                                    SqlNameMatcher nameMatcher)

Description copied from interface: SqlOperatorTable

Retrieves a list of operators with a given name and syntax. For example, by passing SqlSyntax.Function, the returned list is narrowed to only matching SqlFunction objects.

Specified by:

lookupOperatorOverloads in interface SqlOperatorTable

Parameters:

opName - name of operator

category - function category to look up, or null for any matching operator

syntax - syntax type of operator

operatorList - mutable list to which to append matches

nameMatcher - Name matcher

operatorTable

public static SqlOperatorTable operatorTable(String... classNames)

Creates an operator table that contains functions in the given class or classes.

See Also:

ModelHandler.addFunctions(org.apache.calcite.schema.SchemaPlus, java.lang.String, java.util.List<java.lang.String>, java.lang.String, java.lang.String, boolean)

getOperatorList

public List<SqlOperator> getOperatorList()

Description copied from interface: SqlOperatorTable

Retrieves a list of all functions and operators in this table. Used for automated testing. Depending on the table type, may or may not be mutable.

Specified by:

getOperatorList in interface SqlOperatorTable

Returns:

list of SqlOperator objects

getRootSchema

public CalciteSchema getRootSchema()

Description copied from interface: SqlValidatorCatalogReader

Returns the root namespace for name resolution.

Specified by:

getRootSchema in interface SqlValidatorCatalogReader

getTypeFactory

public RelDataTypeFactory getTypeFactory()

Description copied from interface: RelOptSchema

Returns the type factory used to generate types for this schema.

Specified by:

getTypeFactory in interface RelOptSchema

registerRules

public void registerRules(RelOptPlanner planner)

Description copied from interface: RelOptSchema

Registers all of the rules supported by this schema. Only called by RelOptPlanner.registerSchema(org.apache.calcite.plan.RelOptSchema).

Specified by:

registerRules in interface RelOptSchema

isCaseSensitive

public boolean isCaseSensitive()

Specified by:

isCaseSensitive in interface SqlValidatorCatalogReader

nameMatcher

public SqlNameMatcher nameMatcher()

Description copied from interface: SqlValidatorCatalogReader

Returns an implementation of SqlNameMatcher that matches the case-sensitivity policy.

Specified by:

nameMatcher in interface SqlValidatorCatalogReader

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