org.apache.calcite.sql.validate

Class SqlValidatorUtil

java.lang.Object

org.apache.calcite.sql.validate.SqlValidatorUtil

public class SqlValidatorUtil
extends Object

Utility methods related to validation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SqlValidatorUtil.DeepCopier Walks over an expression, copying every node, and fully-qualifying every identifier.

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.calcite.sql.validate.SqlValidatorUtil.Suggester	EXPR_SUGGESTER
static org.apache.calcite.sql.validate.SqlValidatorUtil.Suggester	F_SUGGESTER

Method Summary

Methods

Modifier and Type	Method and Description
static SqlNode	addAlias(SqlNode expr, String alias) Converts an expression "expr" into "expr AS alias".
static void	analyzeGroupItem(SqlValidatorScope scope, List<SqlNode> groupExprs, Map<Integer,Integer> groupExprProjection, com.google.common.collect.ImmutableList.Builder<com.google.common.collect.ImmutableList<ImmutableBitSet>> topBuilder, SqlNode groupExpr) Analyzes an expression in a GROUP BY clause.
static void	checkCharsetAndCollateConsistentIfCharType(RelDataType type)
static RelDataType	createTypeFromProjection(RelDataType type, List<String> columnNameList, RelDataTypeFactory typeFactory, boolean caseSensitive, boolean elideRecord)
static com.google.common.collect.ImmutableList<ImmutableBitSet>	cube(List<ImmutableBitSet> bitSets) Computes the cube of bit sets.
static List<String>	deriveNaturalJoinColumnList(RelDataType leftRowType, RelDataType rightRowType) Derives the list of column names suitable for NATURAL JOIN.
static String	getAlias(SqlNode node, int ordinal) Derives an alias for a node, and invents a mangled identifier if it cannot.
static AggregatingSelectScope	getEnclosingAggregateSelectScope(SqlValidatorScope scope)
static SelectScope	getEnclosingSelectScope(SqlValidatorScope scope)
static RelOptTable	getRelOptTable(SqlValidatorNamespace namespace, Prepare.CatalogReader catalogReader, String datasetName, boolean[] usedDataset) Converts a SqlValidatorScope into a RelOptTable.
static void	getSchemaObjectMonikers(SqlValidatorCatalogReader catalogReader, List<String> names, List<SqlMoniker> hints)
static SqlValidatorNamespace	lookup(SqlValidatorScope scope, List<String> names) Resolves a multi-part identifier such as "SCHEMA.EMP.EMPNO" to a namespace.
static RelDataTypeField	lookupField(boolean caseSensitive, boolean elideRecord, RelDataType rowType, String columnName) Looks up a field with a given name, returning null if not found.
static SqlValidatorWithHints	newValidator(SqlOperatorTable opTab, SqlValidatorCatalogReader catalogReader, RelDataTypeFactory typeFactory) Factory method for SqlValidator.
static com.google.common.collect.ImmutableList<ImmutableBitSet>	rollup(List<ImmutableBitSet> bitSets) Computes the rollup of bit sets.
static List<String>	uniquify(List<String> nameList) Makes sure that the names in a list are unique.
static List<String>	uniquify(List<String> nameList, org.apache.calcite.sql.validate.SqlValidatorUtil.Suggester suggester)
static String	uniquify(String name, Set<String> nameList, org.apache.calcite.sql.validate.SqlValidatorUtil.Suggester suggester) Makes a name distinct from other names which have already been used, adds it to the list, and returns it.

Methods inherited from class java.lang.Object

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

Field Detail

EXPR_SUGGESTER

public static final org.apache.calcite.sql.validate.SqlValidatorUtil.Suggester EXPR_SUGGESTER

F_SUGGESTER

public static final org.apache.calcite.sql.validate.SqlValidatorUtil.Suggester F_SUGGESTER

Method Detail

getRelOptTable

public static RelOptTable getRelOptTable(SqlValidatorNamespace namespace,
                         Prepare.CatalogReader catalogReader,
                         String datasetName,
                         boolean[] usedDataset)

Converts a SqlValidatorScope into a RelOptTable. This is only possible if the scope represents an identifier, such as "sales.emp". Otherwise, returns null.

Parameters:

namespace - Namespace

catalogReader - Schema

datasetName - Name of sample dataset to substitute, or null to use the regular table

usedDataset - Output parameter which is set to true if a sample dataset is found; may be null

lookupField

public static RelDataTypeField lookupField(boolean caseSensitive,
                           boolean elideRecord,
                           RelDataType rowType,
                           String columnName)

Looks up a field with a given name, returning null if not found.

Parameters:

caseSensitive - Whether match is case-sensitive

elideRecord - Whether to find fields nested within records

rowType - Row type

columnName - Field name

Returns:

Field, or null if not found

checkCharsetAndCollateConsistentIfCharType

public static void checkCharsetAndCollateConsistentIfCharType(RelDataType type)

addAlias

public static SqlNode addAlias(SqlNode expr,
               String alias)

Converts an expression "expr" into "expr AS alias".

getAlias

public static String getAlias(SqlNode node,
              int ordinal)

Derives an alias for a node, and invents a mangled identifier if it cannot.

Examples:

• Alias: "1 + 2 as foo" yields "foo"
• Identifier: "foo.bar.baz" yields "baz"
• Anything else yields "expr$ordinal"

Returns:

An alias, if one can be derived; or a synthetic alias "expr$ordinal" if ordinal < 0; otherwise null

uniquify

public static String uniquify(String name,
              Set<String> nameList,
              org.apache.calcite.sql.validate.SqlValidatorUtil.Suggester suggester)

Makes a name distinct from other names which have already been used, adds it to the list, and returns it.

Parameters:

name - Suggested name, may not be unique

nameList - Collection of names already used

suggester - Base for name when input name is null

Returns:

Unique name

newValidator

public static SqlValidatorWithHints newValidator(SqlOperatorTable opTab,
                                 SqlValidatorCatalogReader catalogReader,
                                 RelDataTypeFactory typeFactory)

Factory method for SqlValidator.

uniquify

public static List<String> uniquify(List<String> nameList)

Makes sure that the names in a list are unique.

Does not modify the input list. Returns the input list if the strings are unique, otherwise allocates a new list.

Parameters:

nameList - List of strings

Returns:

List of unique strings

uniquify

public static List<String> uniquify(List<String> nameList,
                    org.apache.calcite.sql.validate.SqlValidatorUtil.Suggester suggester)

lookup

public static SqlValidatorNamespace lookup(SqlValidatorScope scope,
                           List<String> names)

Resolves a multi-part identifier such as "SCHEMA.EMP.EMPNO" to a namespace. The returned namespace, never null, may represent a schema, table, column, etc.

getSchemaObjectMonikers

public static void getSchemaObjectMonikers(SqlValidatorCatalogReader catalogReader,
                           List<String> names,
                           List<SqlMoniker> hints)

getEnclosingSelectScope

public static SelectScope getEnclosingSelectScope(SqlValidatorScope scope)

getEnclosingAggregateSelectScope

public static AggregatingSelectScope getEnclosingAggregateSelectScope(SqlValidatorScope scope)

deriveNaturalJoinColumnList

public static List<String> deriveNaturalJoinColumnList(RelDataType leftRowType,
                                       RelDataType rightRowType)

Derives the list of column names suitable for NATURAL JOIN. These are the columns that occur exactly once on each side of the join.

Parameters:

leftRowType - Row type of left input to the join

rightRowType - Row type of right input to the join

Returns:

List of columns that occur once on each side

createTypeFromProjection

public static RelDataType createTypeFromProjection(RelDataType type,
                                   List<String> columnNameList,
                                   RelDataTypeFactory typeFactory,
                                   boolean caseSensitive,
                                   boolean elideRecord)

analyzeGroupItem

public static void analyzeGroupItem(SqlValidatorScope scope,
                    List<SqlNode> groupExprs,
                    Map<Integer,Integer> groupExprProjection,
                    com.google.common.collect.ImmutableList.Builder<com.google.common.collect.ImmutableList<ImmutableBitSet>> topBuilder,
                    SqlNode groupExpr)

Analyzes an expression in a GROUP BY clause.

It may be an expression, an empty list (), or a call to GROUPING SETS, CUBE or ROLLUP.

Each group item produces a list of group sets, which are written to topBuilder. To find the grouping sets of the query, we will take the cartesian product of the group sets.

rollup

public static com.google.common.collect.ImmutableList<ImmutableBitSet> rollup(List<ImmutableBitSet> bitSets)

Computes the rollup of bit sets.

For example, rollup({0}, {1}) returns ({0, 1}, {0}, {}).

Bit sets are not necessarily singletons: rollup({0, 2}, {3, 5}) returns ({0, 2, 3, 5}, {0, 2}, {}).

cube

public static com.google.common.collect.ImmutableList<ImmutableBitSet> cube(List<ImmutableBitSet> bitSets)

Computes the cube of bit sets.

For example, rollup({0}, {1}) returns ({0, 1}, {0}, {}).

Bit sets are not necessarily singletons: rollup({0, 2}, {3, 5}) returns ({0, 2, 3, 5}, {0, 2}, {}).