io.trino.sql.planner.iterative.rule.UnwrapRowSubscript Maven / Gradle / Ivy

Go to download
/*
 * Licensed 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 io.trino.sql.planner.iterative.rule;

import com.google.common.collect.ImmutableList;
import io.trino.metadata.Metadata;
import io.trino.spi.type.RowType;
import io.trino.spi.type.Type;
import io.trino.sql.PlannerContext;
import io.trino.sql.ir.Call;
import io.trino.sql.ir.Cast;
import io.trino.sql.ir.Expression;
import io.trino.sql.ir.ExpressionTreeRewriter;
import io.trino.sql.ir.FieldReference;
import io.trino.sql.ir.Row;
import io.trino.type.UnknownType;

import java.util.ArrayDeque;
import java.util.Deque;

import static io.trino.metadata.GlobalFunctionCatalog.builtinFunctionName;

/**
 * Transforms expressions of the form
 *
 * ROW(x, y)[1] to x
 *
 * and
 *
 * CAST(ROW(x, y) AS row(f1 type1, f2 type2))[1] to CAST(x AS type1)
 *
 */
public class UnwrapRowSubscript
        extends ExpressionRewriteRuleSet
{
    public UnwrapRowSubscript(PlannerContext context)
    {
        super((expression, _) -> ExpressionTreeRewriter.rewriteWith(new Rewriter(context.getMetadata()), expression));
    }

    private static class Rewriter
            extends io.trino.sql.ir.ExpressionRewriter
    {
        private final Metadata metadata;

        public Rewriter(Metadata metadata)
        {
            this.metadata = metadata;
        }

        @Override
        public Expression rewriteSubscript(FieldReference node, Void context, ExpressionTreeRewriter treeRewriter)
        {
            Expression base = treeRewriter.rewrite(node.base(), context);

            Deque coercions = new ArrayDeque<>();
            while (base.type() instanceof RowType rowType) {
                boolean safe;
                Expression expression;
                if (base instanceof Cast cast) {
                    safe = false;
                    expression = cast.expression();
                }
                else if (base instanceof Call call && call.function().name().equals(builtinFunctionName("$try_cast"))) {
                    safe = true;
                    expression = call.arguments().getFirst();
                }
                else {
                    break;
                }

                Type type = rowType.getFields().get(node.field()).getType();
                if (!(type instanceof UnknownType)) {
                    coercions.push(new Coercion(type, safe));
                }

                base = expression;
            }

            if (base instanceof Row row) {
                Expression result = row.items().get(node.field());

                while (!coercions.isEmpty()) {
                    Coercion coercion = coercions.pop();
                    result = coercion.isSafe() ?
                            new Call(
                                    metadata.getCoercion(builtinFunctionName("$try_cast"), result.type(), coercion.getType()),
                                    ImmutableList.of(result)) :
                            new Cast(result, coercion.getType());
                }

                return result;
            }

            // TODO: if we can prove base is of type row(...) or any other subscript-bearing type, we can push the subscript all the way down:
            //    1. CAST(row_producing_function() AS row(bigint, integer))[1] => CAST(row_producing_function()[1] AS bigint)
            //    2. CAST(array_producing_function() AS array(bigint))[1] => CAST(array_producing_function()[1]) AS bigint)
            return treeRewriter.defaultRewrite(node, context);
        }
    }

    private static class Coercion
    {
        private final Type type;
        private final boolean safe;

        public Coercion(Type type, boolean safe)
        {
            this.type = type;
            this.safe = safe;
        }

        public Type getType()
        {
            return type;
        }

        public boolean isSafe()
        {
            return safe;
        }
    }
}