com.hazelcast.org.apache.calcite.rel.rel2sql.SqlImplementor Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to you under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.hazelcast.org.apache.calcite.rel.rel2sql;
import com.hazelcast.org.apache.calcite.linq4j.Ord;
import com.hazelcast.org.apache.calcite.linq4j.tree.Expressions;
import com.hazelcast.org.apache.calcite.plan.RelOptUtil;
import com.hazelcast.org.apache.calcite.plan.hep.HepPlanner;
import com.hazelcast.org.apache.calcite.plan.hep.HepProgramBuilder;
import com.hazelcast.org.apache.calcite.rel.RelCollation;
import com.hazelcast.org.apache.calcite.rel.RelFieldCollation;
import com.hazelcast.org.apache.calcite.rel.RelNode;
import com.hazelcast.org.apache.calcite.rel.SingleRel;
import com.hazelcast.org.apache.calcite.rel.core.Aggregate;
import com.hazelcast.org.apache.calcite.rel.core.AggregateCall;
import com.hazelcast.org.apache.calcite.rel.core.CorrelationId;
import com.hazelcast.org.apache.calcite.rel.core.JoinRelType;
import com.hazelcast.org.apache.calcite.rel.core.Project;
import com.hazelcast.org.apache.calcite.rel.core.Window;
import com.hazelcast.org.apache.calcite.rel.rules.AggregateProjectConstantToDummyJoinRule;
import com.hazelcast.org.apache.calcite.rel.type.RelDataType;
import com.hazelcast.org.apache.calcite.rel.type.RelDataTypeFactory;
import com.hazelcast.org.apache.calcite.rel.type.RelDataTypeField;
import com.hazelcast.org.apache.calcite.rel.type.RelDataTypeSystemImpl;
import com.hazelcast.org.apache.calcite.rex.RexBuilder;
import com.hazelcast.org.apache.calcite.rex.RexCall;
import com.hazelcast.org.apache.calcite.rex.RexCorrelVariable;
import com.hazelcast.org.apache.calcite.rex.RexDynamicParam;
import com.hazelcast.org.apache.calcite.rex.RexFieldAccess;
import com.hazelcast.org.apache.calcite.rex.RexFieldCollation;
import com.hazelcast.org.apache.calcite.rex.RexInputRef;
import com.hazelcast.org.apache.calcite.rex.RexLiteral;
import com.hazelcast.org.apache.calcite.rex.RexLocalRef;
import com.hazelcast.org.apache.calcite.rex.RexNode;
import com.hazelcast.org.apache.calcite.rex.RexOver;
import com.hazelcast.org.apache.calcite.rex.RexPatternFieldRef;
import com.hazelcast.org.apache.calcite.rex.RexProgram;
import com.hazelcast.org.apache.calcite.rex.RexShuttle;
import com.hazelcast.org.apache.calcite.rex.RexSubQuery;
import com.hazelcast.org.apache.calcite.rex.RexUnknownAs;
import com.hazelcast.org.apache.calcite.rex.RexUtil;
import com.hazelcast.org.apache.calcite.rex.RexWindow;
import com.hazelcast.org.apache.calcite.rex.RexWindowBound;
import com.hazelcast.org.apache.calcite.sql.JoinType;
import com.hazelcast.org.apache.calcite.sql.SqlAggFunction;
import com.hazelcast.org.apache.calcite.sql.SqlBasicCall;
import com.hazelcast.org.apache.calcite.sql.SqlBinaryOperator;
import com.hazelcast.org.apache.calcite.sql.SqlCall;
import com.hazelcast.org.apache.calcite.sql.SqlDialect;
import com.hazelcast.org.apache.calcite.sql.SqlDynamicParam;
import com.hazelcast.org.apache.calcite.sql.SqlIdentifier;
import com.hazelcast.org.apache.calcite.sql.SqlJoin;
import com.hazelcast.org.apache.calcite.sql.SqlKind;
import com.hazelcast.org.apache.calcite.sql.SqlLiteral;
import com.hazelcast.org.apache.calcite.sql.SqlMatchRecognize;
import com.hazelcast.org.apache.calcite.sql.SqlNode;
import com.hazelcast.org.apache.calcite.sql.SqlNodeList;
import com.hazelcast.org.apache.calcite.sql.SqlNumericLiteral;
import com.hazelcast.org.apache.calcite.sql.SqlOperator;
import com.hazelcast.org.apache.calcite.sql.SqlOverOperator;
import com.hazelcast.org.apache.calcite.sql.SqlSelect;
import com.hazelcast.org.apache.calcite.sql.SqlSelectKeyword;
import com.hazelcast.org.apache.calcite.sql.SqlSetOperator;
import com.hazelcast.org.apache.calcite.sql.SqlTableRef;
import com.hazelcast.org.apache.calcite.sql.SqlUtil;
import com.hazelcast.org.apache.calcite.sql.SqlWindow;
import com.hazelcast.org.apache.calcite.sql.fun.SqlCase;
import com.hazelcast.org.apache.calcite.sql.fun.SqlCountAggFunction;
import com.hazelcast.org.apache.calcite.sql.fun.SqlStdOperatorTable;
import com.hazelcast.org.apache.calcite.sql.fun.SqlSumEmptyIsZeroAggFunction;
import com.hazelcast.org.apache.calcite.sql.parser.SqlParserPos;
import com.hazelcast.org.apache.calcite.sql.type.SqlTypeFactoryImpl;
import com.hazelcast.org.apache.calcite.sql.type.SqlTypeFamily;
import com.hazelcast.org.apache.calcite.sql.type.SqlTypeName;
import com.hazelcast.org.apache.calcite.sql.validate.SqlValidatorUtil;
import com.hazelcast.org.apache.calcite.util.DateString;
import com.hazelcast.org.apache.calcite.util.Pair;
import com.hazelcast.org.apache.calcite.util.RangeSets;
import com.hazelcast.org.apache.calcite.util.Sarg;
import com.hazelcast.org.apache.calcite.util.TimeString;
import com.hazelcast.org.apache.calcite.util.TimestampString;
import com.hazelcast.org.apache.calcite.util.Util;
import com.hazelcast.com.google.common.collect.ImmutableList;
import com.hazelcast.com.google.common.collect.ImmutableMap;
import com.hazelcast.com.google.common.collect.ImmutableSet;
import com.hazelcast.com.google.common.collect.Iterables;
import com.hazelcast.com.google.common.collect.Lists;
import com.hazelcast.com.google.common.collect.Range;
import com.hazelcast.com.google.common.collect.RangeSet;
import com.hazelcast.org.checkerframework.checker.initialization.qual.UnknownInitialization;
import com.hazelcast.org.checkerframework.checker.nullness.qual.Nullable;
import java.math.BigDecimal;
import java.util.AbstractList;
import java.util.ArrayDeque;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Deque;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.function.Function;
import java.util.function.IntFunction;
import java.util.function.Predicate;
import static com.hazelcast.org.apache.calcite.linq4j.Nullness.castNonNull;
import static java.util.Objects.requireNonNull;
/**
* State for generating a SQL statement.
*/
public abstract class SqlImplementor {
// Always use quoted position, the "isQuoted" info is only used when
// unparsing a SqlIdentifier. For some rex nodes, saying RexInputRef, we have
// no idea about whether it is quoted or not for the original sql statement.
// So we just quote it.
public static final SqlParserPos POS = SqlParserPos.QUOTED_ZERO;
/** SQL numeric literal {@code 0}. */
static final SqlNumericLiteral ZERO =
SqlNumericLiteral.createExactNumeric("0", POS);
/** SQL numeric literal {@code 1}. */
static final SqlNumericLiteral ONE =
SqlLiteral.createExactNumeric("1", POS);
public final SqlDialect dialect;
protected final Set aliasSet = new LinkedHashSet<>();
protected final Map correlTableMap = new HashMap<>();
/** Private RexBuilder for short-lived expressions. It has its own
* dedicated type factory, so don't trust the types to be canonized. */
final RexBuilder rexBuilder =
new RexBuilder(new SqlTypeFactoryImpl(RelDataTypeSystemImpl.DEFAULT));
protected SqlImplementor(SqlDialect dialect) {
this.dialect = requireNonNull(dialect, "dialect");
}
/** Visits a relational expression that has no parent. */
public final Result visitRoot(RelNode r) {
RelNode best;
if (!this.dialect.supportsGroupByLiteral()) {
HepProgramBuilder hepProgramBuilder = new HepProgramBuilder();
hepProgramBuilder.addRuleInstance(
AggregateProjectConstantToDummyJoinRule.Config.DEFAULT.toRule());
HepPlanner hepPlanner = new HepPlanner(hepProgramBuilder.build());
hepPlanner.setRoot(r);
best = hepPlanner.findBestExp();
} else {
best = r;
}
try {
return visitInput(holder(best), 0);
} catch (Error | RuntimeException e) {
throw Util.throwAsRuntime("Error while converting RelNode to SqlNode:\n"
+ RelOptUtil.toString(r), e);
}
}
/** Creates a relational expression that has {@code r} as its input. */
private static RelNode holder(RelNode r) {
return new SingleRel(r.getCluster(), r.getTraitSet(), r) {
};
}
// CHECKSTYLE: IGNORE 1
/** @deprecated Use either {@link #visitRoot(RelNode)} or
* {@link #visitInput(RelNode, int)}. */
@Deprecated // to be removed before 2.0
public final Result visitChild(int i, RelNode e) {
throw new UnsupportedOperationException();
}
/** Visits an input of the current relational expression,
* deducing {@code anon} using {@link #isAnon()}. */
public final Result visitInput(RelNode e, int i) {
return visitInput(e, i, ImmutableSet.of());
}
/** Visits an input of the current relational expression,
* with the given expected clauses. */
public final Result visitInput(RelNode e, int i, Clause... clauses) {
return visitInput(e, i, ImmutableSet.copyOf(clauses));
}
/** Visits an input of the current relational expression,
* deducing {@code anon} using {@link #isAnon()}. */
public final Result visitInput(RelNode e, int i, Set clauses) {
return visitInput(e, i, isAnon(), false, clauses);
}
/** Visits the {@code i}th input of {@code e}, the current relational
* expression.
*
* @param e Current relational expression
* @param i Ordinal of input within {@code e}
* @param anon Whether to remove trivial aliases such as "EXPR$0"
* @param ignoreClauses Whether to ignore the expected clauses when deciding
* whether a sub-query is required
* @param expectedClauses Set of clauses that we expect the builder that
* consumes this result will create
* @return Result
*
* @see #isAnon()
*/
public abstract Result visitInput(RelNode e, int i, boolean anon,
boolean ignoreClauses, Set expectedClauses);
public void addSelect(List selectList, SqlNode node,
RelDataType rowType) {
String name = rowType.getFieldNames().get(selectList.size());
String alias = SqlValidatorUtil.getAlias(node, -1);
if (alias == null || !alias.equals(name)) {
node = as(node, name);
}
selectList.add(node);
}
/** Convenience method for creating column and table aliases.
*
* {@code AS(e, "c")} creates "e AS c";
* {@code AS(e, "t", "c1", "c2"} creates "e AS t (c1, c2)". */
protected SqlCall as(SqlNode e, String alias, String... fieldNames) {
final List operandList = new ArrayList<>();
operandList.add(e);
operandList.add(new SqlIdentifier(alias, POS));
for (String fieldName : fieldNames) {
operandList.add(new SqlIdentifier(fieldName, POS));
}
return SqlStdOperatorTable.AS.createCall(POS, operandList);
}
/** Returns whether a list of expressions projects all fields, in order,
* from the input, with the same names. */
public static boolean isStar(List exps, RelDataType inputRowType,
RelDataType projectRowType) {
assert exps.size() == projectRowType.getFieldCount();
int i = 0;
for (RexNode ref : exps) {
if (!(ref instanceof RexInputRef)) {
return false;
} else if (((RexInputRef) ref).getIndex() != i++) {
return false;
}
}
return i == inputRowType.getFieldCount()
&& inputRowType.getFieldNames().equals(projectRowType.getFieldNames());
}
public static boolean isStar(RexProgram program) {
int i = 0;
for (RexLocalRef ref : program.getProjectList()) {
if (ref.getIndex() != i++) {
return false;
}
}
return i == program.getInputRowType().getFieldCount();
}
public Result setOpToSql(SqlSetOperator operator, RelNode rel) {
SqlNode node = null;
for (Ord input : Ord.zip(rel.getInputs())) {
final Result result = visitInput(rel, input.i);
if (node == null) {
node = result.asSelect();
} else {
node = operator.createCall(POS, node, result.asSelect());
}
}
assert node != null : "set op must have at least one input, operator = " + operator
+ ", rel = " + rel;
final List clauses =
Expressions.list(Clause.SET_OP);
return result(node, clauses, rel, null);
}
/**
* Converts a {@link RexNode} condition into a {@link SqlNode}.
*
* @param node Join condition
* @param leftContext Left context
* @param rightContext Right context
*
* @return SqlNode that represents the condition
*/
public static SqlNode convertConditionToSqlNode(RexNode node,
Context leftContext,
Context rightContext) {
if (node.isAlwaysTrue()) {
return SqlLiteral.createBoolean(true, POS);
}
if (node.isAlwaysFalse()) {
return SqlLiteral.createBoolean(false, POS);
}
final Context joinContext =
leftContext.implementor().joinContext(leftContext, rightContext);
return joinContext.toSql(null, node);
}
/** Removes cast from string.
*
* For example, {@code x > CAST('2015-01-07' AS DATE)}
* becomes {@code x > '2015-01-07'}.
*/
private static RexNode stripCastFromString(RexNode node, SqlDialect dialect) {
switch (node.getKind()) {
case EQUALS:
case IS_NOT_DISTINCT_FROM:
case NOT_EQUALS:
case GREATER_THAN:
case GREATER_THAN_OR_EQUAL:
case LESS_THAN:
case LESS_THAN_OR_EQUAL:
final RexCall call = (RexCall) node;
final RexNode o0 = call.operands.get(0);
final RexNode o1 = call.operands.get(1);
if (o0.getKind() == SqlKind.CAST
&& o1.getKind() != SqlKind.CAST) {
if (!dialect.supportsImplicitTypeCoercion((RexCall) o0)) {
// If the dialect does not support implicit type coercion,
// we definitely can not strip the cast.
return node;
}
final RexNode o0b = ((RexCall) o0).getOperands().get(0);
return call.clone(call.getType(), ImmutableList.of(o0b, o1));
}
if (o1.getKind() == SqlKind.CAST
&& o0.getKind() != SqlKind.CAST) {
if (!dialect.supportsImplicitTypeCoercion((RexCall) o1)) {
return node;
}
final RexNode o1b = ((RexCall) o1).getOperands().get(0);
return call.clone(call.getType(), ImmutableList.of(o0, o1b));
}
break;
default:
break;
}
return node;
}
public static JoinType joinType(JoinRelType joinType) {
switch (joinType) {
case LEFT:
return JoinType.LEFT;
case RIGHT:
return JoinType.RIGHT;
case INNER:
return JoinType.INNER;
case FULL:
return JoinType.FULL;
default:
throw new AssertionError(joinType);
}
}
/** Creates a result based on a single relational expression. */
public Result result(SqlNode node, Collection clauses,
RelNode rel, @Nullable Map aliases) {
assert aliases == null
|| aliases.size() < 2
|| aliases instanceof LinkedHashMap
|| aliases instanceof ImmutableMap
: "must use a Map implementation that preserves order";
final String alias2 = SqlValidatorUtil.getAlias(node, -1);
final String alias3 = alias2 != null ? alias2 : "t";
final String alias4 =
SqlValidatorUtil.uniquify(
alias3, aliasSet, SqlValidatorUtil.EXPR_SUGGESTER);
final RelDataType rowType = adjustedRowType(rel, node);
if (aliases != null
&& !aliases.isEmpty()
&& (!dialect.hasImplicitTableAlias()
|| aliases.size() > 1)) {
return result(node, clauses, alias4, rowType, aliases);
}
final String alias5;
if (alias2 == null
|| !alias2.equals(alias4)
|| !dialect.hasImplicitTableAlias()) {
alias5 = alias4;
} else {
alias5 = null;
}
return result(node, clauses, alias5, rowType,
ImmutableMap.of(alias4, rowType));
}
/** Factory method for {@link Result}.
*
* Call this method rather than creating a {@code Result} directly,
* because sub-classes may override. */
protected Result result(SqlNode node, Collection clauses,
@Nullable String neededAlias, @Nullable RelDataType neededType,
Map aliases) {
return new Result(node, clauses, neededAlias, neededType, aliases);
}
/** Returns the row type of {@code rel}, adjusting the field names if
* {@code node} is "(query) as tableAlias (fieldAlias, ...)". */
private static RelDataType adjustedRowType(RelNode rel, SqlNode node) {
final RelDataType rowType = rel.getRowType();
final RelDataTypeFactory.Builder builder;
switch (node.getKind()) {
case UNION:
case INTERSECT:
case EXCEPT:
return adjustedRowType(rel, ((SqlCall) node).getOperandList().get(0));
case SELECT:
final SqlNodeList selectList = ((SqlSelect) node).getSelectList();
if (selectList.equals(SqlNodeList.SINGLETON_STAR)) {
return rowType;
}
builder = rel.getCluster().getTypeFactory().builder();
Pair.forEach(selectList,
rowType.getFieldList(),
(selectItem, field) ->
builder.add(
Util.first(SqlValidatorUtil.getAlias(selectItem, -1),
field.getName()),
field.getType()));
return builder.build();
case AS:
final List operandList = ((SqlCall) node).getOperandList();
if (operandList.size() <= 2) {
return rowType;
}
builder = rel.getCluster().getTypeFactory().builder();
Pair.forEach(Util.skip(operandList, 2),
rowType.getFieldList(),
(operand, field) ->
builder.add(operand.toString(), field.getType()));
return builder.build();
default:
return rowType;
}
}
/** Creates a result based on a join. (Each join could contain one or more
* relational expressions.) */
public Result result(SqlNode join, Result leftResult, Result rightResult) {
final Map aliases;
if (join.getKind() == SqlKind.JOIN) {
final ImmutableMap.Builder builder =
ImmutableMap.builder();
collectAliases(builder, join,
Iterables.concat(leftResult.aliases.values(),
rightResult.aliases.values()).iterator());
aliases = builder.build();
} else {
aliases = leftResult.aliases;
}
return result(join, ImmutableList.of(Clause.FROM), null, null, aliases);
}
private static void collectAliases(ImmutableMap.Builder builder,
SqlNode node, Iterator aliases) {
if (node instanceof SqlJoin) {
final SqlJoin join = (SqlJoin) node;
collectAliases(builder, join.getLeft(), aliases);
collectAliases(builder, join.getRight(), aliases);
} else {
final String alias = SqlValidatorUtil.getAlias(node, -1);
assert alias != null;
builder.put(alias, aliases.next());
}
}
/** Returns whether to remove trivial aliases such as "EXPR$0"
* when converting the current relational expression into a SELECT.
*
* For example, INSERT does not care about field names;
* we would prefer to generate without the "EXPR$0" alias:
*
*
{@code INSERT INTO t1 SELECT x, y + 1 FROM t2}
*
* rather than with it:
*
* {@code INSERT INTO t1 SELECT x, y + 1 AS EXPR$0 FROM t2}
*
* But JOIN does care about field names; we have to generate the "EXPR$0"
* alias:
*
*
{@code SELECT *
* FROM emp AS e
* JOIN (SELECT x, y + 1 AS EXPR$0) AS d
* ON e.deptno = d.EXPR$0}
*
*
* because if we omit "AS EXPR$0" we do not know the field we are joining
* to, and the following is invalid:
*
*
{@code SELECT *
* FROM emp AS e
* JOIN (SELECT x, y + 1) AS d
* ON e.deptno = d.EXPR$0}
*
*/
protected boolean isAnon() {
return false;
}
/** Wraps a node in a SELECT statement that has no clauses:
* "SELECT ... FROM (node)". */
SqlSelect wrapSelect(SqlNode node) {
assert node instanceof SqlJoin
|| node instanceof SqlIdentifier
|| node instanceof SqlMatchRecognize
|| node instanceof SqlTableRef
|| node instanceof SqlCall
&& (((SqlCall) node).getOperator() instanceof SqlSetOperator
|| ((SqlCall) node).getOperator() == SqlStdOperatorTable.AS
|| ((SqlCall) node).getOperator() == SqlStdOperatorTable.VALUES)
: node;
if (requiresAlias(node)) {
node = as(node, "t");
}
return new SqlSelect(POS, SqlNodeList.EMPTY, SqlNodeList.SINGLETON_STAR,
node, null, null, null, SqlNodeList.EMPTY, null, null, null, null);
}
/** Returns whether we need to add an alias if this node is to be the FROM
* clause of a SELECT. */
private boolean requiresAlias(SqlNode node) {
if (!dialect.requiresAliasForFromItems()) {
return false;
}
switch (node.getKind()) {
case IDENTIFIER:
return !dialect.hasImplicitTableAlias();
case AS:
case JOIN:
case EXPLICIT_TABLE:
return false;
default:
return true;
}
}
/** Returns whether a node is a call to an aggregate function. */
private static boolean isAggregate(SqlNode node) {
return node instanceof SqlCall
&& ((SqlCall) node).getOperator() instanceof SqlAggFunction;
}
/** Returns whether a node is a call to a windowed aggregate function. */
private static boolean isWindowedAggregate(SqlNode node) {
return node instanceof SqlCall
&& ((SqlCall) node).getOperator() instanceof SqlOverOperator;
}
/** Context for translating a {@link RexNode} expression (within a
* {@link RelNode}) into a {@link SqlNode} expression (within a SQL parse
* tree). */
public abstract static class Context {
final SqlDialect dialect;
final int fieldCount;
private final boolean ignoreCast;
protected Context(SqlDialect dialect, int fieldCount) {
this(dialect, fieldCount, false);
}
protected Context(SqlDialect dialect, int fieldCount, boolean ignoreCast) {
this.dialect = dialect;
this.fieldCount = fieldCount;
this.ignoreCast = ignoreCast;
}
public abstract SqlNode field(int ordinal);
/** Creates a reference to a field to be used in an ORDER BY clause.
*
* By default, it returns the same result as {@link #field}.
*
*
If the field has an alias, uses the alias.
* If the field is an unqualified column reference which is the same an
* alias, switches to a qualified column reference.
*/
public SqlNode orderField(int ordinal) {
final SqlNode node = field(ordinal);
if (node instanceof SqlNumericLiteral
&& dialect.getConformance().isSortByOrdinal()) {
// An integer literal will be wrongly interpreted as a field ordinal.
// Convert it to a character literal, which will have the same effect.
final String strValue = ((SqlNumericLiteral) node).toValue();
return SqlLiteral.createCharString(strValue, node.getParserPosition());
}
return node;
}
/** Converts an expression from {@link RexNode} to {@link SqlNode}
* format.
*
* @param program Required only if {@code rex} contains {@link RexLocalRef}
* @param rex Expression to convert
*/
public SqlNode toSql(@Nullable RexProgram program, RexNode rex) {
final RexSubQuery subQuery;
final SqlNode sqlSubQuery;
final RexLiteral literal;
switch (rex.getKind()) {
case LOCAL_REF:
final int index = ((RexLocalRef) rex).getIndex();
return toSql(program, requireNonNull(program, "program").getExprList().get(index));
case INPUT_REF:
return field(((RexInputRef) rex).getIndex());
case FIELD_ACCESS:
final Deque accesses = new ArrayDeque<>();
RexNode referencedExpr = rex;
while (referencedExpr.getKind() == SqlKind.FIELD_ACCESS) {
accesses.offerLast((RexFieldAccess) referencedExpr);
referencedExpr = ((RexFieldAccess) referencedExpr).getReferenceExpr();
}
SqlIdentifier sqlIdentifier;
switch (referencedExpr.getKind()) {
case CORREL_VARIABLE:
final RexCorrelVariable variable = (RexCorrelVariable) referencedExpr;
final Context correlAliasContext = getAliasContext(variable);
final RexFieldAccess lastAccess = accesses.pollLast();
assert lastAccess != null;
sqlIdentifier = (SqlIdentifier) correlAliasContext
.field(lastAccess.getField().getIndex());
break;
case ROW:
final SqlNode expr = toSql(program, referencedExpr);
sqlIdentifier = new SqlIdentifier(expr.toString(), POS);
break;
default:
sqlIdentifier = (SqlIdentifier) toSql(program, referencedExpr);
}
int nameIndex = sqlIdentifier.names.size();
RexFieldAccess access;
while ((access = accesses.pollLast()) != null) {
sqlIdentifier = sqlIdentifier.add(nameIndex++, access.getField().getName(), POS);
}
return sqlIdentifier;
case PATTERN_INPUT_REF:
final RexPatternFieldRef ref = (RexPatternFieldRef) rex;
String pv = ref.getAlpha();
SqlNode refNode = field(ref.getIndex());
final SqlIdentifier id = (SqlIdentifier) refNode;
if (id.names.size() > 1) {
return id.setName(0, pv);
} else {
return new SqlIdentifier(ImmutableList.of(pv, id.names.get(0)), POS);
}
case LITERAL:
return SqlImplementor.toSql(program, (RexLiteral) rex);
case CASE:
final RexCall caseCall = (RexCall) rex;
final List caseNodeList =
toSql(program, caseCall.getOperands());
final SqlNode valueNode;
final List whenList = Expressions.list();
final List thenList = Expressions.list();
final SqlNode elseNode;
if (caseNodeList.size() % 2 == 0) {
// switched:
// "case x when v1 then t1 when v2 then t2 ... else e end"
valueNode = caseNodeList.get(0);
for (int i = 1; i < caseNodeList.size() - 1; i += 2) {
whenList.add(caseNodeList.get(i));
thenList.add(caseNodeList.get(i + 1));
}
} else {
// other: "case when w1 then t1 when w2 then t2 ... else e end"
valueNode = null;
for (int i = 0; i < caseNodeList.size() - 1; i += 2) {
whenList.add(caseNodeList.get(i));
thenList.add(caseNodeList.get(i + 1));
}
}
elseNode = caseNodeList.get(caseNodeList.size() - 1);
return new SqlCase(POS, valueNode, new SqlNodeList(whenList, POS),
new SqlNodeList(thenList, POS), elseNode);
case DYNAMIC_PARAM:
final RexDynamicParam caseParam = (RexDynamicParam) rex;
return new SqlDynamicParam(caseParam.getIndex(), POS);
case IN:
subQuery = (RexSubQuery) rex;
sqlSubQuery = implementor().visitRoot(subQuery.rel).asQueryOrValues();
final List operands = subQuery.operands;
SqlNode op0;
if (operands.size() == 1) {
op0 = toSql(program, operands.get(0));
} else {
final List cols = toSql(program, operands);
op0 = new SqlNodeList(cols, POS);
}
return subQuery.getOperator().createCall(POS, op0, sqlSubQuery);
case SEARCH:
final RexCall search = (RexCall) rex;
if (search.operands.get(1).getKind() == SqlKind.LITERAL) {
literal = (RexLiteral) search.operands.get(1);
final Sarg sarg = castNonNull(literal.getValueAs(Sarg.class));
//noinspection unchecked
return toSql(program, search.operands.get(0), literal.getType(), sarg);
}
return toSql(program, RexUtil.expandSearch(implementor().rexBuilder, program, search));
case EXISTS:
case UNIQUE:
case SCALAR_QUERY:
subQuery = (RexSubQuery) rex;
sqlSubQuery =
implementor().visitRoot(subQuery.rel).asQueryOrValues();
return subQuery.getOperator().createCall(POS, sqlSubQuery);
case NOT:
RexNode operand = ((RexCall) rex).operands.get(0);
final SqlNode node = toSql(program, operand);
final SqlOperator inverseOperator = getInverseOperator(operand);
if (inverseOperator != null) {
switch (operand.getKind()) {
case IN:
assert operand instanceof RexSubQuery
: "scalar IN is no longer allowed in RexCall: " + rex;
break;
default:
break;
}
return inverseOperator.createCall(POS,
((SqlCall) node).getOperandList());
} else {
return SqlStdOperatorTable.NOT.createCall(POS, node);
}
default:
if (rex instanceof RexOver) {
return toSql(program, (RexOver) rex);
}
return callToSql(program, (RexCall) rex, false);
}
}
private SqlNode callToSql(@Nullable RexProgram program, RexCall call0,
boolean not) {
final RexCall call1 = reverseCall(call0);
final RexCall call = (RexCall) stripCastFromString(call1, dialect);
SqlOperator op = call.getOperator();
switch (op.getKind()) {
case SUM0:
op = SqlStdOperatorTable.SUM;
break;
case NOT:
RexNode operand = call.operands.get(0);
if (getInverseOperator(operand) != null) {
return callToSql(program, (RexCall) operand, !not);
}
break;
default:
break;
}
if (not) {
op = requireNonNull(getInverseOperator(call),
() -> "unable to negate " + call.getKind());
}
final List nodeList = toSql(program, call.getOperands());
switch (call.getKind()) {
case CAST:
// CURSOR is used inside CAST, like 'CAST ($0): CURSOR NOT NULL',
// convert it to sql call of {@link SqlStdOperatorTable#CURSOR}.
final RelDataType dataType = call.getType();
if (dataType.getSqlTypeName() == SqlTypeName.CURSOR) {
final RexNode operand0 = call.operands.get(0);
assert operand0 instanceof RexInputRef;
int ordinal = ((RexInputRef) operand0).getIndex();
SqlNode fieldOperand = field(ordinal);
return SqlStdOperatorTable.CURSOR.createCall(SqlParserPos.ZERO, fieldOperand);
}
// Ideally the UNKNOWN type would never exist in a fully-formed, validated rel node, but
// it can be useful in certain situations where determining the type of an expression is
// infeasible, such as inserting arbitrary user-provided SQL snippets into an otherwise
// manually-constructed (as opposed to parsed) rel node.
// In such a context, assume that casting anything to UNKNOWN is a no-op.
if (ignoreCast || call.getType().getSqlTypeName() == SqlTypeName.UNKNOWN) {
assert nodeList.size() == 1;
return nodeList.get(0);
} else {
nodeList.add(castNonNull(dialect.getCastSpec(call.getType())));
}
break;
default:
break;
}
return SqlUtil.createCall(op, POS, nodeList);
}
/** Reverses the order of a call, while preserving semantics, if it improves
* readability.
*
* In the base implementation, this method does nothing;
* in a join context, reverses a call such as
* "e.deptno = d.deptno" to
* "d.deptno = e.deptno"
* if "d" is the left input to the join
* and "e" is the right. */
protected RexCall reverseCall(RexCall call) {
return call;
}
/** If {@code node} is a {@link RexCall}, extracts the operator and
* finds the corresponding inverse operator using {@link SqlOperator#not()}.
* Returns null if {@code node} is not a {@link RexCall},
* or if the operator has no logical inverse. */
private static @Nullable SqlOperator getInverseOperator(RexNode node) {
if (node instanceof RexCall) {
return ((RexCall) node).getOperator().not();
} else {
return null;
}
}
/** Converts a Sarg to SQL, generating "operand IN (c1, c2, ...)" if the
* ranges are all points. */
@SuppressWarnings({"BetaApi", "UnstableApiUsage"})
private > SqlNode toSql(@Nullable RexProgram program,
RexNode operand, RelDataType type, Sarg sarg) {
final List orList = new ArrayList<>();
final SqlNode operandSql = toSql(program, operand);
if (sarg.nullAs == RexUnknownAs.TRUE) {
orList.add(SqlStdOperatorTable.IS_NULL.createCall(POS, operandSql));
}
if (sarg.isPoints()) {
// generate 'x = 10' or 'x IN (10, 20, 30)'
orList.add(
toIn(operandSql, SqlStdOperatorTable.EQUALS,
SqlStdOperatorTable.IN, program, type, sarg.rangeSet));
} else if (sarg.isComplementedPoints()) {
// generate 'x <> 10' or 'x NOT IN (10, 20, 30)'
orList.add(
toIn(operandSql, SqlStdOperatorTable.NOT_EQUALS,
SqlStdOperatorTable.NOT_IN, program, type,
sarg.rangeSet.complement()));
} else {
final RangeSets.Consumer consumer =
new RangeToSql<>(operandSql, orList, v ->
toSql(program,
implementor().rexBuilder.makeLiteral(v, type)));
RangeSets.forEach(sarg.rangeSet, consumer);
}
return SqlUtil.createCall(SqlStdOperatorTable.OR, POS, orList);
}
@SuppressWarnings("BetaApi")
private > SqlNode toIn(SqlNode operandSql,
SqlBinaryOperator eqOp, SqlBinaryOperator inOp,
@Nullable RexProgram program, RelDataType type, RangeSet rangeSet) {
final SqlNodeList list = rangeSet.asRanges().stream()
.map(range ->
toSql(program,
implementor().rexBuilder.makeLiteral(range.lowerEndpoint(),
type, true, true)))
.collect(SqlNode.toList());
switch (list.size()) {
case 1:
return eqOp.createCall(POS, operandSql, list.get(0));
default:
return inOp.createCall(POS, operandSql, list);
}
}
/** Converts an expression from {@link RexWindowBound} to {@link SqlNode}
* format.
*
* @param rexWindowBound Expression to convert
*/
public SqlNode toSql(RexWindowBound rexWindowBound) {
final SqlNode offsetLiteral =
rexWindowBound.getOffset() == null
? null
: SqlLiteral.createCharString(rexWindowBound.getOffset().toString(),
SqlParserPos.ZERO);
if (rexWindowBound.isPreceding()) {
return offsetLiteral == null
? SqlWindow.createUnboundedPreceding(POS)
: SqlWindow.createPreceding(offsetLiteral, POS);
} else if (rexWindowBound.isFollowing()) {
return offsetLiteral == null
? SqlWindow.createUnboundedFollowing(POS)
: SqlWindow.createFollowing(offsetLiteral, POS);
} else {
assert rexWindowBound.isCurrentRow();
return SqlWindow.createCurrentRow(POS);
}
}
public List toSql(Window.Group group, ImmutableList constants,
int inputFieldCount) {
final List rexOvers = new ArrayList<>();
final List partitionKeys = new ArrayList<>();
final List orderByKeys = new ArrayList<>();
for (int partition: group.keys) {
partitionKeys.add(this.field(partition));
}
for (RelFieldCollation collation: group.orderKeys.getFieldCollations()) {
this.addOrderItem(orderByKeys, collation);
}
SqlLiteral isRows = SqlLiteral.createBoolean(group.isRows, POS);
SqlNode lowerBound = null;
SqlNode upperBound = null;
final SqlLiteral allowPartial = null;
for (Window.RexWinAggCall winAggCall: group.aggCalls) {
SqlAggFunction aggFunction = (SqlAggFunction) winAggCall.getOperator();
final SqlWindow sqlWindow = SqlWindow.create(null, null,
new SqlNodeList(partitionKeys, POS), new SqlNodeList(orderByKeys, POS),
isRows, lowerBound, upperBound, allowPartial, POS);
if (aggFunction.allowsFraming()) {
lowerBound = createSqlWindowBound(group.lowerBound);
upperBound = createSqlWindowBound(group.upperBound);
sqlWindow.setLowerBound(lowerBound);
sqlWindow.setUpperBound(upperBound);
}
RexShuttle replaceConstants = new RexShuttle() {
@Override public RexNode visitInputRef(RexInputRef inputRef) {
int index = inputRef.getIndex();
RexNode ref;
if (index > inputFieldCount - 1) {
ref = constants.get(index - inputFieldCount);
} else {
ref = inputRef;
}
return ref;
}
};
RexCall aggCall = (RexCall) winAggCall.accept(replaceConstants);
List operands = toSql(null, aggCall.operands);
rexOvers.add(createOverCall(aggFunction, operands, sqlWindow, winAggCall.distinct));
}
return rexOvers;
}
protected Context getAliasContext(RexCorrelVariable variable) {
throw new UnsupportedOperationException();
}
private SqlCall toSql(@Nullable RexProgram program, RexOver rexOver) {
final RexWindow rexWindow = rexOver.getWindow();
final SqlNodeList partitionList = new SqlNodeList(
toSql(program, rexWindow.partitionKeys), POS);
List orderNodes = Expressions.list();
if (rexWindow.orderKeys != null) {
for (RexFieldCollation rfc : rexWindow.orderKeys) {
addOrderItem(orderNodes, program, rfc);
}
}
final SqlNodeList orderList =
new SqlNodeList(orderNodes, POS);
final SqlLiteral isRows =
SqlLiteral.createBoolean(rexWindow.isRows(), POS);
// null defaults to true.
// During parsing the allowPartial == false (e.g. disallow partial)
// is expand into CASE expression and is handled as a such.
// Not sure if we can collapse this CASE expression back into
// "disallow partial" and set the allowPartial = false.
final SqlLiteral allowPartial = null;
SqlAggFunction sqlAggregateFunction = rexOver.getAggOperator();
SqlNode lowerBound = null;
SqlNode upperBound = null;
if (sqlAggregateFunction.allowsFraming()) {
lowerBound = createSqlWindowBound(rexWindow.getLowerBound());
upperBound = createSqlWindowBound(rexWindow.getUpperBound());
}
final SqlWindow sqlWindow = SqlWindow.create(null, null, partitionList,
orderList, isRows, lowerBound, upperBound, allowPartial, POS);
final List nodeList = toSql(program, rexOver.getOperands());
return createOverCall(sqlAggregateFunction, nodeList, sqlWindow, rexOver.isDistinct());
}
private static SqlCall createOverCall(SqlAggFunction op, List operands,
SqlWindow window, boolean isDistinct) {
if (op instanceof SqlSumEmptyIsZeroAggFunction) {
// Rewrite "SUM0(x) OVER w" to "COALESCE(SUM(x) OVER w, 0)"
final SqlCall node =
createOverCall(SqlStdOperatorTable.SUM, operands, window, isDistinct);
return SqlStdOperatorTable.COALESCE.createCall(POS, node, ZERO);
}
SqlCall aggFunctionCall;
if (isDistinct) {
aggFunctionCall = op.createCall(
SqlSelectKeyword.DISTINCT.symbol(POS),
POS,
operands);
} else {
aggFunctionCall = op.createCall(POS, operands);
}
return SqlStdOperatorTable.OVER.createCall(POS, aggFunctionCall,
window);
}
private SqlNode toSql(@Nullable RexProgram program, RexFieldCollation rfc) {
SqlNode node = toSql(program, rfc.left);
switch (rfc.getDirection()) {
case DESCENDING:
case STRICTLY_DESCENDING:
node = SqlStdOperatorTable.DESC.createCall(POS, node);
break;
default:
break;
}
if (rfc.getNullDirection()
!= dialect.defaultNullDirection(rfc.getDirection())) {
switch (rfc.getNullDirection()) {
case FIRST:
node = SqlStdOperatorTable.NULLS_FIRST.createCall(POS, node);
break;
case LAST:
node = SqlStdOperatorTable.NULLS_LAST.createCall(POS, node);
break;
default:
break;
}
}
return node;
}
private SqlNode createSqlWindowBound(RexWindowBound rexWindowBound) {
if (rexWindowBound.isCurrentRow()) {
return SqlWindow.createCurrentRow(POS);
}
if (rexWindowBound.isPreceding()) {
if (rexWindowBound.isUnbounded()) {
return SqlWindow.createUnboundedPreceding(POS);
} else {
SqlNode literal = toSql(null, rexWindowBound.getOffset());
return SqlWindow.createPreceding(literal, POS);
}
}
if (rexWindowBound.isFollowing()) {
if (rexWindowBound.isUnbounded()) {
return SqlWindow.createUnboundedFollowing(POS);
} else {
SqlNode literal = toSql(null, rexWindowBound.getOffset());
return SqlWindow.createFollowing(literal, POS);
}
}
throw new AssertionError("Unsupported Window bound: "
+ rexWindowBound);
}
private List toSql(@Nullable RexProgram program, List operandList) {
final List list = new ArrayList<>();
for (RexNode rex : operandList) {
list.add(toSql(program, rex));
}
return list;
}
public List fieldList() {
return new AbstractList() {
@Override public SqlNode get(int index) {
return field(index);
}
@Override public int size() {
return fieldCount;
}
};
}
void addOrderItem(List orderByList, RelFieldCollation field) {
if (field.nullDirection != RelFieldCollation.NullDirection.UNSPECIFIED) {
final boolean first =
field.nullDirection == RelFieldCollation.NullDirection.FIRST;
SqlNode nullDirectionNode =
dialect.emulateNullDirection(field(field.getFieldIndex()),
first, field.direction.isDescending());
if (nullDirectionNode != null) {
orderByList.add(nullDirectionNode);
field = new RelFieldCollation(field.getFieldIndex(),
field.getDirection(),
RelFieldCollation.NullDirection.UNSPECIFIED);
}
}
orderByList.add(toSql(field));
}
/** Converts a RexFieldCollation to an ORDER BY item. */
private void addOrderItem(List orderByList,
@Nullable RexProgram program, RexFieldCollation field) {
SqlNode node = toSql(program, field.left);
SqlNode nullDirectionNode = null;
if (field.getNullDirection() != RelFieldCollation.NullDirection.UNSPECIFIED) {
final boolean first =
field.getNullDirection() == RelFieldCollation.NullDirection.FIRST;
nullDirectionNode = dialect.emulateNullDirection(
node, first, field.getDirection().isDescending());
}
if (nullDirectionNode != null) {
orderByList.add(nullDirectionNode);
switch (field.getDirection()) {
case DESCENDING:
case STRICTLY_DESCENDING:
node = SqlStdOperatorTable.DESC.createCall(POS, node);
break;
default:
break;
}
orderByList.add(node);
} else {
orderByList.add(toSql(program, field));
}
}
/** Converts a call to an aggregate function to an expression. */
public SqlNode toSql(AggregateCall aggCall) {
return toSql(aggCall.getAggregation(), aggCall.isDistinct(),
Util.transform(aggCall.getArgList(), this::field),
aggCall.filterArg, aggCall.collation, aggCall.isApproximate());
}
/** Converts a call to an aggregate function, with a given list of operands,
* to an expression. */
private SqlCall toSql(SqlOperator op, boolean distinct,
List operandList, int filterArg, RelCollation collation, boolean approximate) {
final SqlLiteral qualifier =
distinct ? SqlSelectKeyword.DISTINCT.symbol(POS) : null;
if (op instanceof SqlSumEmptyIsZeroAggFunction) {
final SqlNode node = toSql(SqlStdOperatorTable.SUM, distinct,
operandList, filterArg, collation, approximate);
return SqlStdOperatorTable.COALESCE.createCall(POS, node, ZERO);
}
// Handle filter on dialects that do support FILTER by generating CASE.
if (filterArg >= 0 && !dialect.supportsAggregateFunctionFilter()) {
// SUM(x) FILTER(WHERE b) ==> SUM(CASE WHEN b THEN x END)
// COUNT(*) FILTER(WHERE b) ==> COUNT(CASE WHEN b THEN 1 END)
// COUNT(x) FILTER(WHERE b) ==> COUNT(CASE WHEN b THEN x END)
// COUNT(x, y) FILTER(WHERE b) ==> COUNT(CASE WHEN b THEN x END, y)
final SqlNodeList whenList = SqlNodeList.of(field(filterArg));
final SqlNodeList thenList =
SqlNodeList.of(operandList.isEmpty()
? ONE
: operandList.get(0));
final SqlNode elseList = SqlLiteral.createNull(POS);
final SqlCall caseCall =
SqlStdOperatorTable.CASE.createCall(null, POS, null, whenList,
thenList, elseList);
final List newOperandList = new ArrayList<>();
newOperandList.add(caseCall);
if (operandList.size() > 1) {
newOperandList.addAll(Util.skip(operandList));
}
return toSql(op, distinct, newOperandList, -1, collation, approximate);
}
if (op instanceof SqlCountAggFunction && operandList.isEmpty()) {
// If there is no parameter in "count" function, add a star identifier
// to it.
operandList = ImmutableList.of(SqlIdentifier.STAR);
}
final SqlCall call =
op.createCall(qualifier, POS, operandList);
// Handle filter by generating FILTER (WHERE ...)
final SqlCall call2;
if (distinct && approximate && dialect.supportsApproxCountDistinct()) {
call2 = SqlStdOperatorTable.APPROX_COUNT_DISTINCT.createCall(POS, operandList);
} else if (filterArg < 0) {
call2 = call;
} else {
assert dialect.supportsAggregateFunctionFilter(); // we checked above
call2 = SqlStdOperatorTable.FILTER.createCall(POS, call,
field(filterArg));
}
// Handle collation
return withOrder(call2, collation);
}
/** Wraps a call in a {@link SqlKind#WITHIN_GROUP} call, if
* {@code collation} is non-empty. */
private SqlCall withOrder(SqlCall call, RelCollation collation) {
if (collation.getFieldCollations().isEmpty()) {
return call;
}
final List orderByList = new ArrayList<>();
for (RelFieldCollation field : collation.getFieldCollations()) {
addOrderItem(orderByList, field);
}
return SqlStdOperatorTable.WITHIN_GROUP.createCall(POS, call,
new SqlNodeList(orderByList, POS));
}
/** Converts a collation to an ORDER BY item. */
public SqlNode toSql(RelFieldCollation collation) {
SqlNode node = orderField(collation.getFieldIndex());
switch (collation.getDirection()) {
case DESCENDING:
case STRICTLY_DESCENDING:
node = SqlStdOperatorTable.DESC.createCall(POS, node);
break;
default:
break;
}
if (collation.nullDirection != dialect.defaultNullDirection(collation.direction)) {
switch (collation.nullDirection) {
case FIRST:
node = SqlStdOperatorTable.NULLS_FIRST.createCall(POS, node);
break;
case LAST:
node = SqlStdOperatorTable.NULLS_LAST.createCall(POS, node);
break;
default:
break;
}
}
return node;
}
public abstract SqlImplementor implementor();
/** Converts a {@link Range} to a SQL expression.
*
* @param Value type */
private static class RangeToSql>
implements RangeSets.Consumer {
private final List list;
private final Function literalFactory;
private final SqlNode arg;
RangeToSql(SqlNode arg, List list,
Function literalFactory) {
this.arg = arg;
this.list = list;
this.literalFactory = literalFactory;
}
private void addAnd(SqlNode... nodes) {
list.add(
SqlUtil.createCall(SqlStdOperatorTable.AND, POS,
ImmutableList.copyOf(nodes)));
}
private SqlNode op(SqlOperator op, C value) {
return op.createCall(POS, arg, literalFactory.apply(value));
}
@Override public void all() {
list.add(SqlLiteral.createBoolean(true, POS));
}
@Override public void atLeast(C lower) {
list.add(op(SqlStdOperatorTable.GREATER_THAN_OR_EQUAL, lower));
}
@Override public void atMost(C upper) {
list.add(op(SqlStdOperatorTable.LESS_THAN_OR_EQUAL, upper));
}
@Override public void greaterThan(C lower) {
list.add(op(SqlStdOperatorTable.GREATER_THAN, lower));
}
@Override public void lessThan(C upper) {
list.add(op(SqlStdOperatorTable.LESS_THAN, upper));
}
@Override public void singleton(C value) {
list.add(op(SqlStdOperatorTable.EQUALS, value));
}
@Override public void closed(C lower, C upper) {
addAnd(op(SqlStdOperatorTable.GREATER_THAN_OR_EQUAL, lower),
op(SqlStdOperatorTable.LESS_THAN_OR_EQUAL, upper));
}
@Override public void closedOpen(C lower, C upper) {
addAnd(op(SqlStdOperatorTable.GREATER_THAN_OR_EQUAL, lower),
op(SqlStdOperatorTable.LESS_THAN, upper));
}
@Override public void openClosed(C lower, C upper) {
addAnd(op(SqlStdOperatorTable.GREATER_THAN, lower),
op(SqlStdOperatorTable.LESS_THAN_OR_EQUAL, upper));
}
@Override public void open(C lower, C upper) {
addAnd(op(SqlStdOperatorTable.GREATER_THAN, lower),
op(SqlStdOperatorTable.LESS_THAN, upper));
}
}
}
/** Converts a {@link RexLiteral} in the context of a {@link RexProgram}
* to a {@link SqlNode}. */
public static SqlNode toSql(@Nullable RexProgram program, RexLiteral literal) {
switch (literal.getTypeName()) {
case SYMBOL:
final Enum symbol = (Enum) literal.getValue();
return SqlLiteral.createSymbol(symbol, POS);
case ROW:
//noinspection unchecked
final List list = castNonNull(literal.getValueAs(List.class));
return SqlStdOperatorTable.ROW.createCall(POS,
list.stream().map(e -> toSql(program, e))
.collect(Util.toImmutableList()));
case SARG:
final Sarg arg = literal.getValueAs(Sarg.class);
throw new AssertionError("sargs [" + arg
+ "] should be handled as part of predicates, not as literals");
default:
return toSql(literal);
}
}
/** Converts a {@link RexLiteral} to a {@link SqlLiteral}. */
public static SqlNode toSql(RexLiteral literal) {
SqlTypeName typeName = literal.getTypeName();
switch (typeName) {
case SYMBOL:
final Enum symbol = (Enum) literal.getValue();
return SqlLiteral.createSymbol(symbol, POS);
case ROW:
//noinspection unchecked
final List list = castNonNull(literal.getValueAs(List.class));
return SqlStdOperatorTable.ROW.createCall(POS,
list.stream().map(e -> toSql(e))
.collect(Util.toImmutableList()));
case SARG:
final Sarg arg = literal.getValueAs(Sarg.class);
throw new AssertionError("sargs [" + arg
+ "] should be handled as part of predicates, not as literals");
default:
break;
}
SqlTypeFamily family = requireNonNull(typeName.getFamily(),
() -> "literal " + literal + " has null SqlTypeFamily, and is SqlTypeName is " + typeName);
switch (family) {
case CHARACTER:
return SqlLiteral.createCharString((String) castNonNull(literal.getValue2()), POS);
case NUMERIC:
case EXACT_NUMERIC:
return SqlLiteral.createExactNumeric(
castNonNull(literal.getValueAs(BigDecimal.class)).toPlainString(), POS);
case APPROXIMATE_NUMERIC:
return SqlLiteral.createApproxNumeric(
castNonNull(literal.getValueAs(BigDecimal.class)).toPlainString(), POS);
case BOOLEAN:
return SqlLiteral.createBoolean(castNonNull(literal.getValueAs(Boolean.class)),
POS);
case INTERVAL_YEAR_MONTH:
case INTERVAL_DAY_TIME:
final boolean negative = castNonNull(literal.getValueAs(Boolean.class));
return SqlLiteral.createInterval(negative ? -1 : 1,
castNonNull(literal.getValueAs(String.class)),
castNonNull(literal.getType().getIntervalQualifier()), POS);
case DATE:
return SqlLiteral.createDate(castNonNull(literal.getValueAs(DateString.class)),
POS);
case TIME:
return SqlLiteral.createTime(castNonNull(literal.getValueAs(TimeString.class)),
literal.getType().getPrecision(), POS);
case TIMESTAMP:
return SqlLiteral.createTimestamp(
castNonNull(literal.getValueAs(TimestampString.class)),
literal.getType().getPrecision(), POS);
case ANY:
case NULL:
switch (typeName) {
case NULL:
return SqlLiteral.createNull(POS);
default:
break;
}
// fall through
default:
throw new AssertionError(literal + ": " + typeName);
}
}
/** Simple implementation of {@link Context} that cannot handle sub-queries
* or correlations. Because it is so simple, you do not need to create a
* {@link SqlImplementor} or {@link com.hazelcast.org.apache.calcite.tools.RelBuilder}
* to use it. It is a good way to convert a {@link RexNode} to SQL text. */
public static class SimpleContext extends Context {
private final IntFunction field;
public SimpleContext(SqlDialect dialect, IntFunction field) {
super(dialect, 0, false);
this.field = field;
}
@Override public SqlImplementor implementor() {
throw new UnsupportedOperationException();
}
@Override public SqlNode field(int ordinal) {
return field.apply(ordinal);
}
}
/** Implementation of {@link Context} that has an enclosing
* {@link SqlImplementor} and can therefore do non-trivial expressions. */
protected abstract class BaseContext extends Context {
BaseContext(SqlDialect dialect, int fieldCount) {
super(dialect, fieldCount);
}
@Override protected Context getAliasContext(RexCorrelVariable variable) {
return requireNonNull(
correlTableMap.get(variable.id),
() -> "variable " + variable.id + " is not found");
}
@Override public SqlImplementor implementor() {
return SqlImplementor.this;
}
}
private static int computeFieldCount(
Map aliases) {
int x = 0;
for (RelDataType type : aliases.values()) {
x += type.getFieldCount();
}
return x;
}
public Context aliasContext(Map aliases,
boolean qualified) {
return new AliasContext(dialect, aliases, qualified);
}
public Context joinContext(Context leftContext, Context rightContext) {
return new JoinContext(dialect, leftContext, rightContext);
}
public Context matchRecognizeContext(Context context) {
return new MatchRecognizeContext(dialect, ((AliasContext) context).aliases);
}
public Context tableFunctionScanContext(List inputSqlNodes) {
return new TableFunctionScanContext(dialect, inputSqlNodes);
}
/** Context for translating MATCH_RECOGNIZE clause. */
public class MatchRecognizeContext extends AliasContext {
protected MatchRecognizeContext(SqlDialect dialect,
Map aliases) {
super(dialect, aliases, false);
}
@Override public SqlNode toSql(@Nullable RexProgram program, RexNode rex) {
if (rex.getKind() == SqlKind.LITERAL) {
final RexLiteral literal = (RexLiteral) rex;
if (literal.getTypeName().getFamily() == SqlTypeFamily.CHARACTER) {
return new SqlIdentifier(castNonNull(RexLiteral.stringValue(literal)), POS);
}
}
return super.toSql(program, rex);
}
}
/** Implementation of Context that precedes field references with their
* "table alias" based on the current sub-query's FROM clause. */
public class AliasContext extends BaseContext {
private final boolean qualified;
private final Map aliases;
/** Creates an AliasContext; use {@link #aliasContext(Map, boolean)}. */
protected AliasContext(SqlDialect dialect,
Map aliases, boolean qualified) {
super(dialect, computeFieldCount(aliases));
this.aliases = aliases;
this.qualified = qualified;
}
@Override public SqlNode field(int ordinal) {
for (Map.Entry alias : aliases.entrySet()) {
final List fields = alias.getValue().getFieldList();
if (ordinal < fields.size()) {
RelDataTypeField field = fields.get(ordinal);
return new SqlIdentifier(!qualified
? ImmutableList.of(field.getName())
: ImmutableList.of(alias.getKey(), field.getName()),
POS);
}
ordinal -= fields.size();
}
throw new AssertionError(
"field ordinal " + ordinal + " out of range " + aliases);
}
}
/** Context for translating ON clause of a JOIN from {@link RexNode} to
* {@link SqlNode}. */
class JoinContext extends BaseContext {
private final SqlImplementor.Context leftContext;
private final SqlImplementor.Context rightContext;
/** Creates a JoinContext; use {@link #joinContext(Context, Context)}. */
private JoinContext(SqlDialect dialect, Context leftContext,
Context rightContext) {
super(dialect, leftContext.fieldCount + rightContext.fieldCount);
this.leftContext = leftContext;
this.rightContext = rightContext;
}
@Override public SqlNode field(int ordinal) {
if (ordinal < leftContext.fieldCount) {
return leftContext.field(ordinal);
} else {
return rightContext.field(ordinal - leftContext.fieldCount);
}
}
@Override protected RexCall reverseCall(RexCall call) {
switch (call.getKind()) {
case EQUALS:
case IS_DISTINCT_FROM:
case IS_NOT_DISTINCT_FROM:
case GREATER_THAN:
case GREATER_THAN_OR_EQUAL:
case LESS_THAN:
case LESS_THAN_OR_EQUAL:
assert call.operands.size() == 2;
final RexNode op0 = call.operands.get(0);
final RexNode op1 = call.operands.get(1);
if (op0 instanceof RexInputRef
&& op1 instanceof RexInputRef
&& ((RexInputRef) op1).getIndex() < leftContext.fieldCount
&& ((RexInputRef) op0).getIndex() >= leftContext.fieldCount) {
// Arguments were of form 'op1 = op0'
final SqlOperator op2 = requireNonNull(call.getOperator().reverse());
return (RexCall) rexBuilder.makeCall(op2, op1, op0);
}
// fall through
default:
return call;
}
}
}
/** Context for translating call of a TableFunctionScan from {@link RexNode} to
* {@link SqlNode}. */
class TableFunctionScanContext extends BaseContext {
private final List inputSqlNodes;
TableFunctionScanContext(SqlDialect dialect, List inputSqlNodes) {
super(dialect, inputSqlNodes.size());
this.inputSqlNodes = inputSqlNodes;
}
@Override public SqlNode field(int ordinal) {
return inputSqlNodes.get(ordinal);
}
}
/** Result of implementing a node. */
public class Result {
final SqlNode node;
final @Nullable String neededAlias;
private final @Nullable RelDataType neededType;
private final Map aliases;
final List clauses;
private final boolean anon;
/** Whether to treat {@link #expectedClauses} as empty for the
* purposes of figuring out whether we need a new sub-query. */
private final boolean ignoreClauses;
/** Clauses that will be generated to implement current relational
* expression. */
private final ImmutableSet expectedClauses;
private final @Nullable RelNode expectedRel;
private final boolean needNew;
public Result(SqlNode node, Collection clauses, @Nullable String neededAlias,
@Nullable RelDataType neededType, Map aliases) {
this(node, clauses, neededAlias, neededType, aliases, false, false,
ImmutableSet.of(), null);
}
private Result(SqlNode node, Collection clauses, @Nullable String neededAlias,
@Nullable RelDataType neededType, Map aliases, boolean anon,
boolean ignoreClauses, Set expectedClauses,
@Nullable RelNode expectedRel) {
this.node = node;
this.neededAlias = neededAlias;
this.neededType = neededType;
this.aliases = aliases;
this.clauses = ImmutableList.copyOf(clauses);
this.anon = anon;
this.ignoreClauses = ignoreClauses;
this.expectedClauses = ImmutableSet.copyOf(expectedClauses);
this.expectedRel = expectedRel;
final Set clauses2 =
ignoreClauses ? ImmutableSet.of() : expectedClauses;
this.needNew = expectedRel != null
&& needNewSubQuery(expectedRel, this.clauses, clauses2);
}
/** Creates a builder for the SQL of the given relational expression,
* using the clauses that you declared when you called
* {@link #visitInput(RelNode, int, Set)}. */
public Builder builder(RelNode rel) {
return builder(rel, expectedClauses);
}
// CHECKSTYLE: IGNORE 3
/** @deprecated Provide the expected clauses up-front, when you call
* {@link #visitInput(RelNode, int, Set)}, then create a builder using
* {@link #builder(RelNode)}. */
@Deprecated // to be removed before 2.0
public Builder builder(RelNode rel, Clause clause, Clause... clauses) {
return builder(rel, ImmutableSet.copyOf(Lists.asList(clause, clauses)));
}
/** Once you have a Result of implementing a child relational expression,
* call this method to create a Builder to implement the current relational
* expression by adding additional clauses to the SQL query.
*
* You need to declare which clauses you intend to add. If the clauses
* are "later", you can add to the same query. For example, "GROUP BY" comes
* after "WHERE". But if they are the same or earlier, this method will
* start a new SELECT that wraps the previous result.
*
*
When you have called
* {@link Builder#setSelect(SqlNodeList)},
* {@link Builder#setWhere(SqlNode)} etc. call
* {@link Builder#result(SqlNode, Collection, RelNode, Map)}
* to fix the new query.
*
* @param rel Relational expression being implemented
* @return A builder
*/
private Builder builder(RelNode rel, Set clauses) {
assert expectedClauses.containsAll(clauses);
assert rel.equals(expectedRel);
final Set clauses2 = ignoreClauses ? ImmutableSet.of() : clauses;
final boolean needNew = needNewSubQuery(rel, this.clauses, clauses2);
assert needNew == this.needNew;
SqlSelect select;
Expressions.FluentList clauseList = Expressions.list();
if (needNew) {
select = subSelect();
} else {
select = asSelect();
clauseList.addAll(this.clauses);
}
clauseList.appendAll(clauses);
final Context newContext;
Map newAliases = null;
final SqlNodeList selectList = select.getSelectList();
if (!selectList.equals(SqlNodeList.SINGLETON_STAR)) {
final boolean aliasRef = expectedClauses.contains(Clause.HAVING)
&& dialect.getConformance().isHavingAlias();
newContext = new Context(dialect, selectList.size()) {
@Override public SqlImplementor implementor() {
return SqlImplementor.this;
}
@Override public SqlNode field(int ordinal) {
final SqlNode selectItem = selectList.get(ordinal);
switch (selectItem.getKind()) {
case AS:
final SqlCall asCall = (SqlCall) selectItem;
SqlNode alias = asCall.operand(1);
if (aliasRef && !SqlUtil.isGeneratedAlias(((SqlIdentifier) alias).getSimple())) {
// For BigQuery, given the query
// SELECT SUM(x) AS x FROM t HAVING(SUM(t.x) > 0)
// we can generate
// SELECT SUM(x) AS x FROM t HAVING(x > 0)
// because 'x' in HAVING resolves to the 'AS x' not 't.x'.
return alias;
}
return asCall.operand(0);
default:
break;
}
return selectItem;
}
@Override public SqlNode orderField(int ordinal) {
// If the field expression is an unqualified column identifier
// and matches a different alias, use an ordinal.
// For example, given
// SELECT deptno AS empno, empno AS x FROM emp ORDER BY emp.empno
// we generate
// SELECT deptno AS empno, empno AS x FROM emp ORDER BY 2
// "ORDER BY empno" would give incorrect result;
// "ORDER BY x" is acceptable but is not preferred.
final SqlNode node = super.orderField(ordinal);
if (node instanceof SqlIdentifier
&& ((SqlIdentifier) node).isSimple()) {
final String name = ((SqlIdentifier) node).getSimple();
for (Ord selectItem : Ord.zip(selectList)) {
if (selectItem.i != ordinal) {
final String alias =
SqlValidatorUtil.getAlias(selectItem.e, -1);
if (name.equalsIgnoreCase(alias)) {
return SqlLiteral.createExactNumeric(
Integer.toString(ordinal + 1), SqlParserPos.ZERO);
}
}
}
}
return node;
}
};
} else {
boolean qualified =
!dialect.hasImplicitTableAlias() || aliases.size() > 1;
// basically, we did a subSelect() since needNew is set and neededAlias is not null
// now, we need to make sure that we need to update the alias context.
// if our aliases map has a single element: ,
// then we don't need to rewrite the alias but otherwise, it should be updated.
if (needNew
&& neededAlias != null
&& (aliases.size() != 1 || !aliases.containsKey(neededAlias))) {
newAliases =
ImmutableMap.of(neededAlias, rel.getInput(0).getRowType());
newContext = aliasContext(newAliases, qualified);
} else {
newContext = aliasContext(aliases, qualified);
}
}
return new Builder(rel, clauseList, select, newContext, isAnon(),
needNew && !aliases.containsKey(neededAlias) ? newAliases : aliases);
}
/** Returns whether a new sub-query is required. */
private boolean needNewSubQuery(
@UnknownInitialization Result this,
RelNode rel, List clauses,
Set expectedClauses) {
if (clauses.isEmpty()) {
return false;
}
final Clause maxClause = Collections.max(clauses);
// If old and new clause are equal and belong to below set,
// then new SELECT wrap is not required
final Set nonWrapSet = ImmutableSet.of(Clause.SELECT);
for (Clause clause : expectedClauses) {
if (maxClause.ordinal() > clause.ordinal()
|| (maxClause == clause
&& !nonWrapSet.contains(clause))) {
return true;
}
}
if (rel instanceof Project
&& clauses.contains(Clause.HAVING)
&& dialect.getConformance().isHavingAlias()) {
return true;
}
if (rel instanceof Project
&& ((Project) rel).containsOver()
&& maxClause == Clause.SELECT) {
// Cannot merge a Project that contains windowed functions onto an
// underlying Project
return true;
}
if (rel instanceof Aggregate) {
final Aggregate agg = (Aggregate) rel;
final boolean hasNestedAgg =
hasNested(agg, SqlImplementor::isAggregate);
final boolean hasNestedWindowedAgg =
hasNested(agg, SqlImplementor::isWindowedAggregate);
if (!dialect.supportsNestedAggregations()
&& (hasNestedAgg || hasNestedWindowedAgg)) {
return true;
}
if (clauses.contains(Clause.GROUP_BY)) {
// Avoid losing the distinct attribute of inner aggregate.
return !hasNestedAgg || Aggregate.isNotGrandTotal(agg);
}
}
return false;
}
/** Returns whether an {@link Aggregate} contains nested operands that
* match the predicate.
*
* @param aggregate Aggregate node
* @param operandPredicate Predicate for the nested operands
* @return whether any nested operands matches the predicate */
private boolean hasNested(
@UnknownInitialization Result this,
Aggregate aggregate,
Predicate operandPredicate) {
if (node instanceof SqlSelect) {
final SqlNodeList selectList = ((SqlSelect) node).getSelectList();
if (!selectList.equals(SqlNodeList.SINGLETON_STAR)) {
final Set aggregatesArgs = new HashSet<>();
for (AggregateCall aggregateCall : aggregate.getAggCallList()) {
aggregatesArgs.addAll(aggregateCall.getArgList());
}
for (int aggregatesArg : aggregatesArgs) {
if (selectList.get(aggregatesArg) instanceof SqlBasicCall) {
final SqlBasicCall call =
(SqlBasicCall) selectList.get(aggregatesArg);
for (SqlNode operand : call.getOperandList()) {
if (operand != null && operandPredicate.test(operand)) {
return true;
}
}
}
}
}
}
return false;
}
/** Returns the highest clause that is in use. */
@Deprecated
public Clause maxClause() {
return Collections.max(clauses);
}
/** Returns a node that can be included in the FROM clause or a JOIN. It has
* an alias that is unique within the query. The alias is implicit if it
* can be derived using the usual rules (For example, "SELECT * FROM emp" is
* equivalent to "SELECT * FROM emp AS emp".) */
public SqlNode asFrom() {
if (neededAlias != null) {
if (node.getKind() == SqlKind.AS) {
// If we already have an AS node, we need to replace the alias
// This is especially relevant for the VALUES clause rendering
SqlCall sqlCall = (SqlCall) node;
@SuppressWarnings("assignment.type.incompatible")
SqlNode[] operands = sqlCall.getOperandList().toArray(new SqlNode[0]);
operands[1] = new SqlIdentifier(neededAlias, POS);
return SqlStdOperatorTable.AS.createCall(POS, operands);
} else {
return SqlStdOperatorTable.AS.createCall(POS, node,
new SqlIdentifier(neededAlias, POS));
}
}
return node;
}
public SqlSelect subSelect() {
return wrapSelect(asFrom());
}
/** Converts a non-query node into a SELECT node. Set operators (UNION,
* INTERSECT, EXCEPT) remain as is. */
public SqlSelect asSelect() {
if (node instanceof SqlSelect) {
return (SqlSelect) node;
}
if (!dialect.hasImplicitTableAlias()) {
return wrapSelect(asFrom());
}
return wrapSelect(node);
}
public void stripTrivialAliases(SqlNode node) {
switch (node.getKind()) {
case SELECT:
final SqlSelect select = (SqlSelect) node;
final SqlNodeList nodeList = select.getSelectList();
if (nodeList != null) {
for (int i = 0; i < nodeList.size(); i++) {
final SqlNode n = nodeList.get(i);
if (n.getKind() == SqlKind.AS) {
final SqlCall call = (SqlCall) n;
final SqlIdentifier identifier = call.operand(1);
if (SqlUtil.isGeneratedAlias(identifier.getSimple())) {
nodeList.set(i, call.operand(0));
}
}
}
}
break;
case UNION:
case INTERSECT:
case EXCEPT:
case INSERT:
case UPDATE:
case DELETE:
case MERGE:
final SqlCall call = (SqlCall) node;
for (SqlNode operand : call.getOperandList()) {
if (operand != null) {
stripTrivialAliases(operand);
}
}
break;
default:
break;
}
}
/** Strips trivial aliases if anon. */
private SqlNode maybeStrip(SqlNode node) {
if (anon) {
stripTrivialAliases(node);
}
return node;
}
/** Converts a non-query node into a SELECT node. Set operators (UNION,
* INTERSECT, EXCEPT) and DML operators (INSERT, UPDATE, DELETE, MERGE)
* remain as is. */
public SqlNode asStatement() {
switch (node.getKind()) {
case UNION:
case INTERSECT:
case EXCEPT:
case INSERT:
case UPDATE:
case DELETE:
case MERGE:
return maybeStrip(node);
default:
return maybeStrip(asSelect());
}
}
/** Converts a non-query node into a SELECT node. Set operators (UNION,
* INTERSECT, EXCEPT) and VALUES remain as is. */
public SqlNode asQueryOrValues() {
switch (node.getKind()) {
case UNION:
case INTERSECT:
case EXCEPT:
case VALUES:
return maybeStrip(node);
default:
return maybeStrip(asSelect());
}
}
/** Returns a context that always qualifies identifiers. Useful if the
* Context deals with just one arm of a join, yet we wish to generate
* a join condition that qualifies column names to disambiguate them. */
public Context qualifiedContext() {
return aliasContext(aliases, true);
}
/**
* In join, when the left and right nodes have been generated,
* update their alias with 'neededAlias' if not null.
*/
public Result resetAlias() {
if (neededAlias == null) {
return this;
} else {
return new Result(node, clauses, neededAlias, neededType,
ImmutableMap.of(neededAlias, castNonNull(neededType)), anon, ignoreClauses,
expectedClauses, expectedRel);
}
}
/**
* Sets the alias of the join or correlate just created.
*
* @param alias New alias
* @param type type of the node associated with the alias
*/
public Result resetAlias(String alias, RelDataType type) {
return new Result(node, clauses, alias, neededType,
ImmutableMap.of(alias, type), anon, ignoreClauses,
expectedClauses, expectedRel);
}
/** Returns a copy of this Result, overriding the value of {@code anon}. */
Result withAnon(boolean anon) {
return anon == this.anon ? this
: new Result(node, clauses, neededAlias, neededType, aliases, anon,
ignoreClauses, expectedClauses, expectedRel);
}
/** Returns a copy of this Result, overriding the value of
* {@code ignoreClauses} and {@code expectedClauses}. */
Result withExpectedClauses(boolean ignoreClauses,
Set expectedClauses, RelNode expectedRel) {
return ignoreClauses == this.ignoreClauses
&& expectedClauses.equals(this.expectedClauses)
&& expectedRel == this.expectedRel
? this
: new Result(node, clauses, neededAlias, neededType, aliases, anon,
ignoreClauses, ImmutableSet.copyOf(expectedClauses), expectedRel);
}
}
/** Builder. */
public class Builder {
private final RelNode rel;
final List clauses;
final SqlSelect select;
public final Context context;
final boolean anon;
private final @Nullable Map aliases;
public Builder(RelNode rel, List clauses, SqlSelect select,
Context context, boolean anon,
@Nullable Map aliases) {
this.rel = requireNonNull(rel, "rel");
this.clauses = ImmutableList.copyOf(clauses);
this.select = requireNonNull(select, "select");
this.context = requireNonNull(context, "context");
this.anon = anon;
this.aliases = aliases;
}
public void setSelect(SqlNodeList nodeList) {
select.setSelectList(nodeList);
}
public void setWhere(SqlNode node) {
assert clauses.contains(Clause.WHERE);
select.setWhere(node);
}
public void setGroupBy(SqlNodeList nodeList) {
assert clauses.contains(Clause.GROUP_BY);
select.setGroupBy(nodeList);
}
public void setHaving(SqlNode node) {
assert clauses.contains(Clause.HAVING);
select.setHaving(node);
}
public void setOrderBy(SqlNodeList nodeList) {
assert clauses.contains(Clause.ORDER_BY);
select.setOrderBy(nodeList);
}
public void setFetch(SqlNode fetch) {
assert clauses.contains(Clause.FETCH);
select.setFetch(fetch);
}
public void setOffset(SqlNode offset) {
assert clauses.contains(Clause.OFFSET);
select.setOffset(offset);
}
public void addOrderItem(List orderByList,
RelFieldCollation field) {
context.addOrderItem(orderByList, field);
}
public Result result() {
return SqlImplementor.this.result(select, clauses, rel, aliases)
.withAnon(anon);
}
}
/** Clauses in a SQL query. Ordered by evaluation order.
* SELECT is set only when there is a NON-TRIVIAL SELECT clause. */
public enum Clause {
FROM, WHERE, GROUP_BY, HAVING, SELECT, SET_OP, ORDER_BY, FETCH, OFFSET
}
}