• Home
• io.trino
• trino-main
• 446
• source code
• Analysis.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

io.trino.sql.analyzer.Analysis Maven / Gradle / Ivy

/*
 * 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.analyzer;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.common.collect.ArrayListMultimap;
import com.google.common.collect.HashMultiset;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Multimap;
import com.google.common.collect.Multiset;
import com.google.common.collect.Streams;
import com.google.errorprone.annotations.CanIgnoreReturnValue;
import com.google.errorprone.annotations.Immutable;
import io.trino.metadata.AnalyzeMetadata;
import io.trino.metadata.QualifiedObjectName;
import io.trino.metadata.ResolvedFunction;
import io.trino.metadata.TableExecuteHandle;
import io.trino.metadata.TableHandle;
import io.trino.metadata.TableLayout;
import io.trino.security.AccessControl;
import io.trino.security.SecurityContext;
import io.trino.spi.QueryId;
import io.trino.spi.connector.CatalogHandle;
import io.trino.spi.connector.CatalogHandle.CatalogVersion;
import io.trino.spi.connector.ColumnHandle;
import io.trino.spi.connector.ColumnSchema;
import io.trino.spi.connector.ConnectorTableMetadata;
import io.trino.spi.connector.ConnectorTransactionHandle;
import io.trino.spi.eventlistener.BaseViewReferenceInfo;
import io.trino.spi.eventlistener.ColumnDetail;
import io.trino.spi.eventlistener.ColumnInfo;
import io.trino.spi.eventlistener.ColumnMaskReferenceInfo;
import io.trino.spi.eventlistener.MaterializedViewReferenceInfo;
import io.trino.spi.eventlistener.RoutineInfo;
import io.trino.spi.eventlistener.RowFilterReferenceInfo;
import io.trino.spi.eventlistener.TableInfo;
import io.trino.spi.eventlistener.TableReferenceInfo;
import io.trino.spi.eventlistener.ViewReferenceInfo;
import io.trino.spi.function.table.Argument;
import io.trino.spi.function.table.ConnectorTableFunctionHandle;
import io.trino.spi.security.Identity;
import io.trino.spi.type.RowType;
import io.trino.spi.type.Type;
import io.trino.sql.analyzer.JsonPathAnalyzer.JsonPathAnalysis;
import io.trino.sql.analyzer.PatternRecognitionAnalysis.PatternInputAnalysis;
import io.trino.sql.planner.PartitioningHandle;
import io.trino.sql.tree.AllColumns;
import io.trino.sql.tree.DataType;
import io.trino.sql.tree.ExistsPredicate;
import io.trino.sql.tree.Expression;
import io.trino.sql.tree.FieldReference;
import io.trino.sql.tree.FunctionCall;
import io.trino.sql.tree.GroupingOperation;
import io.trino.sql.tree.Identifier;
import io.trino.sql.tree.InPredicate;
import io.trino.sql.tree.Join;
import io.trino.sql.tree.JsonTable;
import io.trino.sql.tree.JsonTableColumnDefinition;
import io.trino.sql.tree.LambdaArgumentDeclaration;
import io.trino.sql.tree.MeasureDefinition;
import io.trino.sql.tree.Node;
import io.trino.sql.tree.NodeRef;
import io.trino.sql.tree.Offset;
import io.trino.sql.tree.OrderBy;
import io.trino.sql.tree.Parameter;
import io.trino.sql.tree.QualifiedName;
import io.trino.sql.tree.QuantifiedComparisonExpression;
import io.trino.sql.tree.Query;
import io.trino.sql.tree.QuerySpecification;
import io.trino.sql.tree.RangeQuantifier;
import io.trino.sql.tree.Relation;
import io.trino.sql.tree.RowPattern;
import io.trino.sql.tree.SampledRelation;
import io.trino.sql.tree.Statement;
import io.trino.sql.tree.SubqueryExpression;
import io.trino.sql.tree.SubsetDefinition;
import io.trino.sql.tree.Table;
import io.trino.sql.tree.TableFunctionInvocation;
import io.trino.sql.tree.Unnest;
import io.trino.sql.tree.WindowFrame;
import io.trino.sql.tree.WindowOperation;
import io.trino.transaction.TransactionId;
import jakarta.annotation.Nullable;

import java.time.Instant;
import java.util.ArrayDeque;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Deque;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.OptionalLong;
import java.util.Set;

import static com.google.common.base.MoreObjects.toStringHelper;
import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.base.Preconditions.checkState;
import static com.google.common.collect.ImmutableList.toImmutableList;
import static com.google.common.collect.ImmutableMap.toImmutableMap;
import static com.google.common.collect.ImmutableSet.toImmutableSet;
import static io.trino.sql.analyzer.QueryType.DESCRIBE;
import static io.trino.sql.analyzer.QueryType.EXPLAIN;
import static java.lang.Boolean.FALSE;
import static java.lang.String.format;
import static java.util.Collections.emptyList;
import static java.util.Collections.unmodifiableList;
import static java.util.Collections.unmodifiableMap;
import static java.util.Collections.unmodifiableSet;
import static java.util.Objects.requireNonNull;

public class Analysis
{
    @Nullable
    private final Statement root;
    private final Map, Expression> parameters;
    private String updateType;
    private Optional target = Optional.empty();
    private boolean skipMaterializedViewRefresh;
    private Optional tableExecuteReadsData;

    private final Map, Query> namedQueries = new LinkedHashMap<>();

    // map expandable query to the node being the inner recursive reference
    private final Map, Node> expandableNamedQueries = new LinkedHashMap<>();

    // map inner recursive reference in the expandable query to the recursion base scope
    private final Map, Scope> expandableBaseScopes = new LinkedHashMap<>();

    // Synthetic scope when a query does not have a FROM clause
    // We need to track this separately because there's no node we can attach it to.
    private final Map, Scope> implicitFromScopes = new LinkedHashMap<>();

    private final Map, Scope> scopes = new LinkedHashMap<>();
    private final Map, ResolvedField> columnReferences = new LinkedHashMap<>();

    // a map of users to the columns per table that they access
    private final Map>> tableColumnReferences = new LinkedHashMap<>();

    // Record fields prefixed with labels in row pattern recognition context
    private final Map, Optional> labels = new LinkedHashMap<>();
    private final Map, Range> ranges = new LinkedHashMap<>();
    private final Map, Set> undefinedLabels = new LinkedHashMap<>();
    private final Map, MeasureDefinition> measureDefinitions = new LinkedHashMap<>();

    // Pattern function analysis (classifier, match_number, aggregations and prev/next/first/last) in the context of the given node
    private final Map, List> patternInputsAnalysis = new LinkedHashMap<>();

    // FunctionCall nodes corresponding to any of the special pattern recognition functions
    private final Set> patternRecognitionFunctionCalls = new LinkedHashSet<>();

    // FunctionCall nodes corresponding to any of the navigation functions (prev/next/first/last)
    private final Set> patternNavigationFunctions = new LinkedHashSet<>();

    private final Map, String> resolvedLabels = new LinkedHashMap<>();
    private final Map, Set> subsets = new LinkedHashMap<>();

    // for JSON features
    private final Map, JsonPathAnalysis> jsonPathAnalyses = new LinkedHashMap<>();
    private final Map, ResolvedFunction> jsonInputFunctions = new LinkedHashMap<>();
    private final Map, ResolvedFunction> jsonOutputFunctions = new LinkedHashMap<>();
    private final Map, JsonTableAnalysis> jsonTableAnalyses = new LinkedHashMap<>();

    private final Map, List> aggregates = new LinkedHashMap<>();
    private final Map, List> orderByAggregates = new LinkedHashMap<>();
    private final Map, GroupingSetAnalysis> groupingSets = new LinkedHashMap<>();

    private final Map, Expression> where = new LinkedHashMap<>();
    private final Map, Expression> having = new LinkedHashMap<>();
    private final Map, List> orderByExpressions = new LinkedHashMap<>();
    private final Set> redundantOrderBy = new HashSet<>();
    private final Map, List> selectExpressions = new LinkedHashMap<>();

    // Store resolved window specifications defined in WINDOW clause
    private final Map, Map, ResolvedWindow>> windowDefinitions = new LinkedHashMap<>();

    // Store resolved window specifications for window functions and row pattern measures
    private final Map, ResolvedWindow> windows = new LinkedHashMap<>();

    private final Map, List> windowFunctions = new LinkedHashMap<>();
    private final Map, List> orderByWindowFunctions = new LinkedHashMap<>();
    private final Map, List> windowMeasures = new LinkedHashMap<>();
    private final Map, List> orderByWindowMeasures = new LinkedHashMap<>();
    private final Map, Long> offset = new LinkedHashMap<>();
    private final Map, OptionalLong> limit = new LinkedHashMap<>();
    private final Map, List> selectAllResultFields = new LinkedHashMap<>();

    private final Map, Expression> joins = new LinkedHashMap<>();
    private final Map, JoinUsingAnalysis> joinUsing = new LinkedHashMap<>();
    private final Map, SubqueryAnalysis> subqueries = new LinkedHashMap<>();
    private final Map, PredicateCoercions> predicateCoercions = new LinkedHashMap<>();

    private final Map, TableEntry> tables = new LinkedHashMap<>();

    private final Map, Type> types = new LinkedHashMap<>();
    private final Map, Type> coercions = new LinkedHashMap<>();

    private final Map, Type> sortKeyCoercionsForFrameBoundCalculation = new LinkedHashMap<>();
    private final Map, Type> sortKeyCoercionsForFrameBoundComparison = new LinkedHashMap<>();
    private final Map, ResolvedFunction> frameBoundCalculations = new LinkedHashMap<>();
    private final Map, List> relationCoercions = new LinkedHashMap<>();
    private final Map, RoutineEntry> resolvedFunctions = new LinkedHashMap<>();
    private final Map, LambdaArgumentDeclaration> lambdaArgumentReferences = new LinkedHashMap<>();

    private final Map columns = new LinkedHashMap<>();

    private final Map, Double> sampleRatios = new LinkedHashMap<>();

    private final Map, List> groupingOperations = new LinkedHashMap<>();

    private final Multiset rowFilterScopes = HashMultiset.create();
    private final Map, List> rowFilters = new LinkedHashMap<>();
    private final Map, List> checkConstraints = new LinkedHashMap<>();

    private final Multiset columnMaskScopes = HashMultiset.create();
    private final Map, Map> columnMasks = new LinkedHashMap<>();

    private final Map, UnnestAnalysis> unnestAnalysis = new LinkedHashMap<>();
    private Optional create = Optional.empty();
    private Optional insert = Optional.empty();
    private Optional refreshMaterializedView = Optional.empty();
    private Optional delegatedRefreshMaterializedView = Optional.empty();
    private Optional analyzeMetadata = Optional.empty();
    private Optional> updatedColumns = Optional.empty();
    private Optional mergeAnalysis = Optional.empty();

    private final QueryType queryType;

    // for recursive view detection
    private final Deque tablesForView = new ArrayDeque<>();

    private final Deque referenceChain = new ArrayDeque<>();

    // row id field for update/delete queries
    private final Map, FieldReference> rowIdField = new LinkedHashMap<>();
    private final Multimap originColumnDetails = ArrayListMultimap.create();
    private final Multimap, Field> fieldLineage = ArrayListMultimap.create();

    private Optional tableExecuteHandle = Optional.empty();

    // names of tables and aliased relations. All names are resolved case-insensitive.
    private final Map, QualifiedName> relationNames = new LinkedHashMap<>();
    private final Map, TableFunctionInvocationAnalysis> tableFunctionAnalyses = new LinkedHashMap<>();
    private final Set> aliasedRelations = new LinkedHashSet<>();
    private final Set> polymorphicTableFunctions = new LinkedHashSet<>();
    private final Map, List> materializedViewStorageTableFields = new LinkedHashMap<>();

    public Analysis(@Nullable Statement root, Map, Expression> parameters, QueryType queryType)
    {
        this.root = root;
        this.parameters = ImmutableMap.copyOf(requireNonNull(parameters, "parameters is null"));
        this.queryType = requireNonNull(queryType, "queryType is null");
    }

    public Statement getStatement()
    {
        return root;
    }

    public String getUpdateType()
    {
        return updateType;
    }

    public Optional
 getTarget()
    {
        return target.map(target -> {
            QualifiedObjectName name = target.getName();
            return new Output(name.catalogName(), target.getCatalogVersion(), name.schemaName(), name.objectName(), target.getColumns());
        });
    }

    public void setUpdateType(String updateType)
    {
        if (queryType != EXPLAIN) {
            this.updateType = updateType;
        }
    }

    public void setUpdateTarget(CatalogVersion catalogVersion, QualifiedObjectName targetName, Optional targetTable, Optional> targetColumns)
    {
        this.target = Optional.of(new UpdateTarget(catalogVersion, targetName, targetTable, targetColumns));
    }

    public boolean isUpdateTarget(Table table)
    {
        requireNonNull(table, "table is null");
        return target
                .flatMap(UpdateTarget::getTable)
                .map(tableReference -> tableReference == table) // intentional comparison by reference
                .orElse(FALSE);
    }

    public boolean isSkipMaterializedViewRefresh()
    {
        return skipMaterializedViewRefresh;
    }

    public void setSkipMaterializedViewRefresh(boolean skipMaterializedViewRefresh)
    {
        this.skipMaterializedViewRefresh = skipMaterializedViewRefresh;
    }

    public boolean isTableExecuteReadsData()
    {
        return tableExecuteReadsData.orElseThrow(() -> new IllegalStateException("tableExecuteReadsData not set"));
    }

    public void setTableExecuteReadsData(boolean readsData)
    {
        this.tableExecuteReadsData = Optional.of(readsData);
    }

    public void setAggregates(QuerySpecification node, List aggregates)
    {
        this.aggregates.put(NodeRef.of(node), ImmutableList.copyOf(aggregates));
    }

    public List getAggregates(QuerySpecification query)
    {
        return aggregates.get(NodeRef.of(query));
    }

    public void setOrderByAggregates(OrderBy node, List aggregates)
    {
        this.orderByAggregates.put(NodeRef.of(node), ImmutableList.copyOf(aggregates));
    }

    public List getOrderByAggregates(OrderBy node)
    {
        return orderByAggregates.get(NodeRef.of(node));
    }

    public Map, Type> getTypes()
    {
        return unmodifiableMap(types);
    }

    public boolean isAnalyzed(Expression expression)
    {
        return expression instanceof DataType || types.containsKey(NodeRef.of(expression));
    }

    public Type getType(Expression expression)
    {
        Type type = types.get(NodeRef.of(expression));
        checkArgument(type != null, "Expression not analyzed: %s", expression);
        return type;
    }

    public List getRelationCoercion(Relation relation)
    {
        return relationCoercions.get(NodeRef.of(relation));
    }

    public void addRelationCoercion(Relation relation, Type[] types)
    {
        relationCoercions.put(NodeRef.of(relation), ImmutableList.copyOf(types));
    }

    public Map, Type> getCoercions()
    {
        return unmodifiableMap(coercions);
    }

    public Type getCoercion(Expression expression)
    {
        checkArgument(isAnalyzed(expression), "Expression has not been analyzed (%s): %s", expression.getClass().getName(), expression);
        return coercions.get(NodeRef.of(expression));
    }

    public void addLambdaArgumentReferences(Map, LambdaArgumentDeclaration> lambdaArgumentReferences)
    {
        this.lambdaArgumentReferences.putAll(lambdaArgumentReferences);
    }

    public LambdaArgumentDeclaration getLambdaArgumentReference(Identifier identifier)
    {
        return lambdaArgumentReferences.get(NodeRef.of(identifier));
    }

    public Map, LambdaArgumentDeclaration> getLambdaArgumentReferences()
    {
        return unmodifiableMap(lambdaArgumentReferences);
    }

    public void setGroupingSets(QuerySpecification node, GroupingSetAnalysis groupingSets)
    {
        this.groupingSets.put(NodeRef.of(node), groupingSets);
    }

    public boolean isAggregation(QuerySpecification node)
    {
        return groupingSets.containsKey(NodeRef.of(node));
    }

    public GroupingSetAnalysis getGroupingSets(QuerySpecification node)
    {
        return groupingSets.get(NodeRef.of(node));
    }

    public void setWhere(Node node, Expression expression)
    {
        where.put(NodeRef.of(node), expression);
    }

    public Expression getWhere(QuerySpecification node)
    {
        return where.get(NodeRef.of(node));
    }

    public void setOrderByExpressions(Node node, List items)
    {
        orderByExpressions.put(NodeRef.of(node), ImmutableList.copyOf(items));
    }

    public List getOrderByExpressions(Node node)
    {
        return orderByExpressions.get(NodeRef.of(node));
    }

    public void setOffset(Offset node, long rowCount)
    {
        offset.put(NodeRef.of(node), rowCount);
    }

    public long getOffset(Offset node)
    {
        checkState(offset.containsKey(NodeRef.of(node)), "missing OFFSET value for node %s", node);
        return offset.get(NodeRef.of(node));
    }

    public void setLimit(Node node, OptionalLong rowCount)
    {
        limit.put(NodeRef.of(node), rowCount);
    }

    public void setLimit(Node node, long rowCount)
    {
        limit.put(NodeRef.of(node), OptionalLong.of(rowCount));
    }

    public OptionalLong getLimit(Node node)
    {
        checkState(limit.containsKey(NodeRef.of(node)), "missing LIMIT value for node %s", node);
        return limit.get(NodeRef.of(node));
    }

    public void setSelectAllResultFields(AllColumns node, List expressions)
    {
        selectAllResultFields.put(NodeRef.of(node), ImmutableList.copyOf(expressions));
    }

    public List getSelectAllResultFields(AllColumns node)
    {
        return selectAllResultFields.get(NodeRef.of(node));
    }

    public void setSelectExpressions(Node node, List expressions)
    {
        selectExpressions.put(NodeRef.of(node), ImmutableList.copyOf(expressions));
    }

    public List getSelectExpressions(Node node)
    {
        return selectExpressions.get(NodeRef.of(node));
    }

    public void setHaving(QuerySpecification node, Expression expression)
    {
        having.put(NodeRef.of(node), expression);
    }

    public void setJoinCriteria(Join node, Expression criteria)
    {
        joins.put(NodeRef.of(node), criteria);
    }

    public Expression getJoinCriteria(Join join)
    {
        return joins.get(NodeRef.of(join));
    }

    public void recordSubqueries(Node node, ExpressionAnalysis expressionAnalysis)
    {
        SubqueryAnalysis subqueries = this.subqueries.computeIfAbsent(NodeRef.of(node), key -> new SubqueryAnalysis());
        subqueries.addInPredicates(dereference(expressionAnalysis.getSubqueryInPredicates()));
        subqueries.addSubqueries(dereference(expressionAnalysis.getSubqueries()));
        subqueries.addExistsSubqueries(dereference(expressionAnalysis.getExistsSubqueries()));
        subqueries.addQuantifiedComparisons(dereference(expressionAnalysis.getQuantifiedComparisons()));
    }

    private  List dereference(Collection> nodeRefs)
    {
        return nodeRefs.stream()
                .map(NodeRef::getNode)
                .collect(toImmutableList());
    }

    public SubqueryAnalysis getSubqueries(Node node)
    {
        return subqueries.computeIfAbsent(NodeRef.of(node), key -> new SubqueryAnalysis());
    }

    public void addWindowDefinition(QuerySpecification query, CanonicalizationAware name, ResolvedWindow window)
    {
        windowDefinitions.computeIfAbsent(NodeRef.of(query), key -> new LinkedHashMap<>())
                .put(name, window);
    }

    public ResolvedWindow getWindowDefinition(QuerySpecification query, CanonicalizationAware name)
    {
        Map, ResolvedWindow> windows = windowDefinitions.get(NodeRef.of(query));
        if (windows != null) {
            return windows.get(name);
        }

        return null;
    }

    public void setWindow(Node node, ResolvedWindow window)
    {
        windows.put(NodeRef.of(node), window);
    }

    public ResolvedWindow getWindow(Node node)
    {
        return windows.get(NodeRef.of(node));
    }

    public void setWindowFunctions(QuerySpecification node, List functions)
    {
        windowFunctions.put(NodeRef.of(node), ImmutableList.copyOf(functions));
    }

    public List getWindowFunctions(QuerySpecification query)
    {
        return windowFunctions.get(NodeRef.of(query));
    }

    public void setOrderByWindowFunctions(OrderBy node, List functions)
    {
        orderByWindowFunctions.put(NodeRef.of(node), ImmutableList.copyOf(functions));
    }

    public List getOrderByWindowFunctions(OrderBy query)
    {
        return orderByWindowFunctions.get(NodeRef.of(query));
    }

    public void setWindowMeasures(QuerySpecification node, List measures)
    {
        windowMeasures.put(NodeRef.of(node), ImmutableList.copyOf(measures));
    }

    public List getWindowMeasures(QuerySpecification node)
    {
        return windowMeasures.get(NodeRef.of(node));
    }

    public void setOrderByWindowMeasures(OrderBy node, List measures)
    {
        orderByWindowMeasures.put(NodeRef.of(node), ImmutableList.copyOf(measures));
    }

    public List getOrderByWindowMeasures(OrderBy node)
    {
        return orderByWindowMeasures.get(NodeRef.of(node));
    }

    public void addColumnReferences(Map, ResolvedField> columnReferences)
    {
        this.columnReferences.putAll(columnReferences);
    }

    public Scope getScope(Node node)
    {
        return tryGetScope(node).orElseThrow(() -> new IllegalArgumentException(format("Analysis does not contain information for node: %s", node)));
    }

    public Optional tryGetScope(Node node)
    {
        NodeRef key = NodeRef.of(node);
        if (scopes.containsKey(key)) {
            return Optional.of(scopes.get(key));
        }

        return Optional.empty();
    }

    public Scope getRootScope()
    {
        return getScope(root);
    }

    public void setScope(Node node, Scope scope)
    {
        scopes.put(NodeRef.of(node), scope);
    }

    public RelationType getOutputDescriptor()
    {
        return getOutputDescriptor(root);
    }

    public RelationType getOutputDescriptor(Node node)
    {
        return getScope(node).getRelationType();
    }

    public TableHandle getTableHandle(Table table)
    {
        return tables.get(NodeRef.of(table))
                .getHandle()
                .orElseThrow(() -> new IllegalArgumentException(format("%s is not a table reference", table)));
    }

    public Collection getTables()
    {
        return tables.values().stream()
                .map(TableEntry::getHandle)
                .filter(Optional::isPresent)
                .map(Optional::get)
                .collect(toImmutableList());
    }

    public void registerTable(
            Table table,
            Optional handle,
            QualifiedObjectName name,
            String authorization,
            Scope accessControlScope,
            Optional viewText)
    {
        tables.put(
                NodeRef.of(table),
                new TableEntry(
                        handle,
                        name,
                        authorization,
                        accessControlScope,
                        tablesForView.isEmpty() &&
                                rowFilterScopes.isEmpty() &&
                                columnMaskScopes.isEmpty(),
                        viewText,
                        referenceChain));
    }

    public Set getResolvedFunctions()
    {
        return resolvedFunctions.values().stream()
                .map(RoutineEntry::getFunction)
                .collect(toImmutableSet());
    }

    public ResolvedFunction getResolvedFunction(Node node)
    {
        return resolvedFunctions.get(NodeRef.of(node)).getFunction();
    }

    public void addResolvedFunction(Node node, ResolvedFunction function, String authorization)
    {
        resolvedFunctions.put(NodeRef.of(node), new RoutineEntry(function, authorization));
    }

    public Set> getColumnReferences()
    {
        return unmodifiableSet(columnReferences.keySet());
    }

    public Map, ResolvedField> getColumnReferenceFields()
    {
        return unmodifiableMap(columnReferences);
    }

    public ResolvedField getResolvedField(Expression expression)
    {
        checkArgument(isColumnReference(expression), "Expression is not a column reference: %s", expression);
        return columnReferences.get(NodeRef.of(expression));
    }

    public boolean isColumnReference(Expression expression)
    {
        requireNonNull(expression, "expression is null");
        return columnReferences.containsKey(NodeRef.of(expression));
    }

    public void addType(Expression expression, Type type)
    {
        this.types.put(NodeRef.of(expression), type);
    }

    public void addTypes(Map, Type> types)
    {
        this.types.putAll(types);
    }

    public void addCoercion(Expression expression, Type type)
    {
        this.coercions.put(NodeRef.of(expression), type);
    }

    public void addCoercions(
            Map, Type> coercions,
            Map, Type> sortKeyCoercionsForFrameBoundCalculation,
            Map, Type> sortKeyCoercionsForFrameBoundComparison)
    {
        this.coercions.putAll(coercions);
        this.sortKeyCoercionsForFrameBoundCalculation.putAll(sortKeyCoercionsForFrameBoundCalculation);
        this.sortKeyCoercionsForFrameBoundComparison.putAll(sortKeyCoercionsForFrameBoundComparison);
    }

    public Type getSortKeyCoercionForFrameBoundCalculation(Expression frameOffset)
    {
        return sortKeyCoercionsForFrameBoundCalculation.get(NodeRef.of(frameOffset));
    }

    public Type getSortKeyCoercionForFrameBoundComparison(Expression frameOffset)
    {
        return sortKeyCoercionsForFrameBoundComparison.get(NodeRef.of(frameOffset));
    }

    public void addFrameBoundCalculations(Map, ResolvedFunction> frameBoundCalculations)
    {
        this.frameBoundCalculations.putAll(frameBoundCalculations);
    }

    public ResolvedFunction getFrameBoundCalculation(Expression frameOffset)
    {
        return frameBoundCalculations.get(NodeRef.of(frameOffset));
    }

    public Expression getHaving(QuerySpecification query)
    {
        return having.get(NodeRef.of(query));
    }

    public void setColumn(Field field, ColumnHandle handle)
    {
        columns.put(field, handle);
    }

    public ColumnHandle getColumn(Field field)
    {
        return columns.get(field);
    }

    public Optional getAnalyzeMetadata()
    {
        return analyzeMetadata;
    }

    public void setAnalyzeMetadata(AnalyzeMetadata analyzeMetadata)
    {
        this.analyzeMetadata = Optional.of(analyzeMetadata);
    }

    public void setCreate(Create create)
    {
        this.create = Optional.of(create);
    }

    public Optional getCreate()
    {
        return create;
    }

    public void setInsert(Insert insert)
    {
        this.insert = Optional.of(insert);
    }

    public Optional getInsert()
    {
        return insert;
    }

    public void setUpdatedColumns(List updatedColumns)
    {
        this.updatedColumns = Optional.of(updatedColumns);
    }

    public Optional> getUpdatedColumns()
    {
        return updatedColumns;
    }

    public Optional getMergeAnalysis()
    {
        return mergeAnalysis;
    }

    public void setMergeAnalysis(MergeAnalysis mergeAnalysis)
    {
        this.mergeAnalysis = Optional.of(mergeAnalysis);
    }

    public void setRefreshMaterializedView(RefreshMaterializedViewAnalysis refreshMaterializedView)
    {
        this.refreshMaterializedView = Optional.of(refreshMaterializedView);
    }

    public Optional getRefreshMaterializedView()
    {
        return refreshMaterializedView;
    }

    public void setDelegatedRefreshMaterializedView(QualifiedObjectName viewName)
    {
        this.delegatedRefreshMaterializedView = Optional.of(viewName);
    }

    public Optional getDelegatedRefreshMaterializedView()
    {
        return delegatedRefreshMaterializedView;
    }

    public Query getNamedQuery(Table table)
    {
        return namedQueries.get(NodeRef.of(table));
    }

    public void registerNamedQuery(Table tableReference, Query query)
    {
        requireNonNull(tableReference, "tableReference is null");
        requireNonNull(query, "query is null");

        namedQueries.put(NodeRef.of(tableReference), query);
    }

    public void registerExpandableQuery(Query query, Node recursiveReference)
    {
        requireNonNull(query, "query is null");
        requireNonNull(recursiveReference, "recursiveReference is null");

        expandableNamedQueries.put(NodeRef.of(query), recursiveReference);
    }

    public boolean isExpandableQuery(Query query)
    {
        return expandableNamedQueries.containsKey(NodeRef.of(query));
    }

    public Node getRecursiveReference(Query query)
    {
        checkArgument(isExpandableQuery(query), "query is not registered as expandable");
        return expandableNamedQueries.get(NodeRef.of(query));
    }

    public void setExpandableBaseScope(Node node, Scope scope)
    {
        expandableBaseScopes.put(NodeRef.of(node), scope);
    }

    public Optional getExpandableBaseScope(Node node)
    {
        return Optional.ofNullable(expandableBaseScopes.get(NodeRef.of(node)));
    }

    public void registerTableForView(Table tableReference, QualifiedObjectName name, boolean isMaterializedView)
    {
        tablesForView.push(requireNonNull(tableReference, "tableReference is null"));
        BaseViewReferenceInfo referenceInfo;
        if (isMaterializedView) {
            referenceInfo = new MaterializedViewReferenceInfo(name.catalogName(), name.schemaName(), name.objectName());
        }
        else {
            referenceInfo = new ViewReferenceInfo(name.catalogName(), name.schemaName(), name.objectName());
        }
        referenceChain.push(referenceInfo);
    }

    public void unregisterTableForView()
    {
        tablesForView.pop();
        referenceChain.pop();
    }

    public boolean hasTableInView(Table tableReference)
    {
        return tablesForView.contains(tableReference);
    }

    public void setSampleRatio(SampledRelation relation, double ratio)
    {
        sampleRatios.put(NodeRef.of(relation), ratio);
    }

    public double getSampleRatio(SampledRelation relation)
    {
        NodeRef key = NodeRef.of(relation);
        checkState(sampleRatios.containsKey(key), "Sample ratio missing for %s. Broken analysis?", relation);
        return sampleRatios.get(key);
    }

    public void setGroupingOperations(QuerySpecification querySpecification, List groupingOperations)
    {
        this.groupingOperations.put(NodeRef.of(querySpecification), ImmutableList.copyOf(groupingOperations));
    }

    public List getGroupingOperations(QuerySpecification querySpecification)
    {
        return Optional.ofNullable(groupingOperations.get(NodeRef.of(querySpecification)))
                .orElse(emptyList());
    }

    public Map, Expression> getParameters()
    {
        return parameters;
    }

    public QueryType getQueryType()
    {
        return queryType;
    }

    public boolean isDescribe()
    {
        return queryType == DESCRIBE;
    }

    public void setJoinUsing(Join node, JoinUsingAnalysis analysis)
    {
        joinUsing.put(NodeRef.of(node), analysis);
    }

    public JoinUsingAnalysis getJoinUsing(Join node)
    {
        return joinUsing.get(NodeRef.of(node));
    }

    public void setUnnest(Unnest node, UnnestAnalysis analysis)
    {
        unnestAnalysis.put(NodeRef.of(node), analysis);
    }

    public UnnestAnalysis getUnnest(Unnest node)
    {
        return unnestAnalysis.get(NodeRef.of(node));
    }

    public void addTableColumnReferences(AccessControl accessControl, Identity identity, Multimap tableColumnMap)
    {
        AccessControlInfo accessControlInfo = new AccessControlInfo(accessControl, identity);
        Map> references = tableColumnReferences.computeIfAbsent(accessControlInfo, k -> new LinkedHashMap<>());
        tableColumnMap.asMap()
                .forEach((key, value) -> references.computeIfAbsent(key, k -> new HashSet<>()).addAll(value));
    }

    public void addEmptyColumnReferencesForTable(AccessControl accessControl, Identity identity, QualifiedObjectName table)
    {
        AccessControlInfo accessControlInfo = new AccessControlInfo(accessControl, identity);
        tableColumnReferences.computeIfAbsent(accessControlInfo, k -> new LinkedHashMap<>()).computeIfAbsent(table, k -> new HashSet<>());
    }

    public void addLabels(Map, Optional> labels)
    {
        this.labels.putAll(labels);
    }

    public void addPatternRecognitionInputs(Map, List> functions)
    {
        patternInputsAnalysis.putAll(functions);

        functions.values().stream()
                .flatMap(List::stream)
                .map(PatternInputAnalysis::expression)
                .filter(FunctionCall.class::isInstance)
                .map(FunctionCall.class::cast)
                .map(NodeRef::of)
                .forEach(patternRecognitionFunctionCalls::add);
    }

    public void addPatternNavigationFunctions(Set> functions)
    {
        patternNavigationFunctions.addAll(functions);
    }

    public Optional getLabel(Expression expression)
    {
        return labels.get(NodeRef.of(expression));
    }

    public boolean isPatternRecognitionFunction(FunctionCall functionCall)
    {
        return patternRecognitionFunctionCalls.contains(NodeRef.of(functionCall));
    }

    public void setRanges(Map, Range> quantifierRanges)
    {
        ranges.putAll(quantifierRanges);
    }

    public Range getRange(RangeQuantifier quantifier)
    {
        Range range = ranges.get(NodeRef.of(quantifier));
        checkNotNull(range, "missing range for quantifier %s", quantifier);
        return range;
    }

    public void setUndefinedLabels(RowPattern pattern, Set labels)
    {
        undefinedLabels.put(NodeRef.of(pattern), labels);
    }

    public void setUndefinedLabels(Map, Set> labels)
    {
        undefinedLabels.putAll(labels);
    }

    public Set getUndefinedLabels(RowPattern pattern)
    {
        Set labels = undefinedLabels.get(NodeRef.of(pattern));
        checkNotNull(labels, "missing undefined labels for %s", pattern);
        return labels;
    }

    public void setMeasureDefinitions(Map, MeasureDefinition> definitions)
    {
        measureDefinitions.putAll(definitions);
    }

    public MeasureDefinition getMeasureDefinition(WindowOperation measure)
    {
        return measureDefinitions.get(NodeRef.of(measure));
    }

    public void setJsonPathAnalyses(Map, JsonPathAnalysis> pathAnalyses)
    {
        jsonPathAnalyses.putAll(pathAnalyses);
    }

    public void setJsonPathAnalysis(Node node, JsonPathAnalysis pathAnalysis)
    {
        jsonPathAnalyses.put(NodeRef.of(node), pathAnalysis);
    }

    public JsonPathAnalysis getJsonPathAnalysis(Node node)
    {
        return jsonPathAnalyses.get(NodeRef.of(node));
    }

    public void setJsonInputFunctions(Map, ResolvedFunction> functions)
    {
        jsonInputFunctions.putAll(functions);
    }

    public ResolvedFunction getJsonInputFunction(Expression expression)
    {
        return jsonInputFunctions.get(NodeRef.of(expression));
    }

    public void setJsonOutputFunctions(Map, ResolvedFunction> functions)
    {
        jsonOutputFunctions.putAll(functions);
    }

    public ResolvedFunction getJsonOutputFunction(Node node)
    {
        return jsonOutputFunctions.get(NodeRef.of(node));
    }

    public void addJsonTableAnalysis(JsonTable jsonTable, JsonTableAnalysis analysis)
    {
        jsonTableAnalyses.put(NodeRef.of(jsonTable), analysis);
    }

    public JsonTableAnalysis getJsonTableAnalysis(JsonTable jsonTable)
    {
        return jsonTableAnalyses.get(NodeRef.of(jsonTable));
    }

    public Map>> getTableColumnReferences()
    {
        return tableColumnReferences;
    }

    public void markRedundantOrderBy(OrderBy orderBy)
    {
        redundantOrderBy.add(NodeRef.of(orderBy));
    }

    public boolean isOrderByRedundant(OrderBy orderBy)
    {
        return redundantOrderBy.contains(NodeRef.of(orderBy));
    }

    public boolean hasRowFilter(QualifiedObjectName table, String identity)
    {
        return rowFilterScopes.contains(new RowFilterScopeEntry(table, identity));
    }

    public void registerTableForRowFiltering(QualifiedObjectName table, String identity, String filterExpression)
    {
        rowFilterScopes.add(new RowFilterScopeEntry(table, identity));
        referenceChain.push(new RowFilterReferenceInfo(filterExpression, table.catalogName(), table.schemaName(), table.objectName()));
    }

    public void unregisterTableForRowFiltering(QualifiedObjectName table, String identity)
    {
        rowFilterScopes.remove(new RowFilterScopeEntry(table, identity));
        referenceChain.pop();
    }

    public void addRowFilter(Table table, Expression filter)
    {
        rowFilters.computeIfAbsent(NodeRef.of(table), node -> new ArrayList<>())
                .add(filter);
    }

    public void addCheckConstraints(Table table, Expression constraint)
    {
        checkConstraints.computeIfAbsent(NodeRef.of(table), node -> new ArrayList<>())
                .add(constraint);
    }

    public List getRowFilters(Table node)
    {
        return unmodifiableList(rowFilters.getOrDefault(NodeRef.of(node), ImmutableList.of()));
    }

    public List getCheckConstraints(Table node)
    {
        return unmodifiableList(checkConstraints.getOrDefault(NodeRef.of(node), ImmutableList.of()));
    }

    public boolean hasColumnMask(QualifiedObjectName table, String column, String identity)
    {
        return columnMaskScopes.contains(new ColumnMaskScopeEntry(table, column, identity));
    }

    public void registerTableForColumnMasking(QualifiedObjectName table, String column, String identity, String maskExpression)
    {
        columnMaskScopes.add(new ColumnMaskScopeEntry(table, column, identity));
        referenceChain.push(new ColumnMaskReferenceInfo(maskExpression, table.catalogName(), table.schemaName(), table.objectName(), column));
    }

    public void unregisterTableForColumnMasking(QualifiedObjectName table, String column, String identity)
    {
        columnMaskScopes.remove(new ColumnMaskScopeEntry(table, column, identity));
        referenceChain.pop();
    }

    public void addColumnMask(Table table, String column, Expression mask)
    {
        Map masks = columnMasks.computeIfAbsent(NodeRef.of(table), node -> new LinkedHashMap<>());
        checkArgument(!masks.containsKey(column), "Mask already exists for column %s", column);

        masks.put(column, mask);
    }

    public Map getColumnMasks(Table table)
    {
        return unmodifiableMap(columnMasks.getOrDefault(NodeRef.of(table), ImmutableMap.of()));
    }

    public List getReferencedTables()
    {
        return tables.entrySet().stream()
                .filter(entry -> isInputTable(entry.getKey().getNode()))
                .map(entry -> {
                    NodeRef table = entry.getKey();

                    QualifiedObjectName tableName = entry.getValue().getName();
                    List columns = tableColumnReferences.values().stream()
                            .map(tablesToColumns -> tablesToColumns.get(tableName))
                            .filter(Objects::nonNull)
                            .flatMap(Collection::stream)
                            .distinct()
                            .map(fieldName -> new ColumnInfo(
                                    fieldName,
                                    Optional.ofNullable(columnMasks.getOrDefault(table, ImmutableMap.of()).get(fieldName))
                                            .map(Expression::toString)))
                            .collect(toImmutableList());

                    TableEntry info = entry.getValue();
                    return new TableInfo(
                            info.getName().catalogName(),
                            info.getName().schemaName(),
                            info.getName().objectName(),
                            info.getAuthorization(),
                            rowFilters.getOrDefault(table, ImmutableList.of()).stream()
                                    .map(Expression::toString)
                                    .collect(toImmutableList()),
                            columns,
                            info.isDirectlyReferenced(),
                            info.getViewText(),
                            info.getReferenceChain());
                })
                .collect(toImmutableList());
    }

    public List getRoutines()
    {
        return resolvedFunctions.values().stream()
                .map(value -> new RoutineInfo(value.function.signature().getName().getFunctionName(), value.getAuthorization()))
                .collect(toImmutableList());
    }

    public void addSourceColumns(Field field, Set sourceColumn)
    {
        originColumnDetails.putAll(field, sourceColumn);
    }

    public Set getSourceColumns(Field field)
    {
        return ImmutableSet.copyOf(originColumnDetails.get(field));
    }

    public void addExpressionFields(Expression expression, Collection fields)
    {
        fieldLineage.putAll(NodeRef.of(expression), fields);
    }

    public Set getExpressionSourceColumns(Expression expression)
    {
        return fieldLineage.get(NodeRef.of(expression)).stream()
                .flatMap(field -> getSourceColumns(field).stream())
                .collect(toImmutableSet());
    }

    public void setRowIdField(Table table, FieldReference field)
    {
        rowIdField.put(NodeRef.of(table), field);
    }

    public FieldReference getRowIdField(Table table)
    {
        return rowIdField.get(NodeRef.of(table));
    }

    public Scope getAccessControlScope(Table node)
    {
        return tables.get(NodeRef.of(node)).getAccessControlScope();
    }

    public void setImplicitFromScope(QuerySpecification node, Scope scope)
    {
        implicitFromScopes.put(NodeRef.of(node), scope);
    }

    public Scope getImplicitFromScope(QuerySpecification node)
    {
        return implicitFromScopes.get(NodeRef.of(node));
    }

    public void addPredicateCoercions(Map, PredicateCoercions> coercions)
    {
        predicateCoercions.putAll(coercions);
    }

    public PredicateCoercions getPredicateCoercions(Expression expression)
    {
        return predicateCoercions.get(NodeRef.of(expression));
    }

    public void setTableExecuteHandle(TableExecuteHandle tableExecuteHandle)
    {
        requireNonNull(tableExecuteHandle, "tableExecuteHandle is null");
        checkState(this.tableExecuteHandle.isEmpty(), "tableExecuteHandle already set");
        this.tableExecuteHandle = Optional.of(tableExecuteHandle);
    }

    public Optional getTableExecuteHandle()
    {
        return tableExecuteHandle;
    }

    public void setTableFunctionAnalysis(TableFunctionInvocation node, TableFunctionInvocationAnalysis analysis)
    {
        tableFunctionAnalyses.put(NodeRef.of(node), analysis);
    }

    public TableFunctionInvocationAnalysis getTableFunctionAnalysis(TableFunctionInvocation node)
    {
        return tableFunctionAnalyses.get(NodeRef.of(node));
    }

    public Set> getPolymorphicTableFunctions()
    {
        return ImmutableSet.copyOf(polymorphicTableFunctions);
    }

    public void setRelationName(Relation relation, QualifiedName name)
    {
        relationNames.put(NodeRef.of(relation), name);
    }

    public QualifiedName getRelationName(Relation relation)
    {
        return relationNames.get(NodeRef.of(relation));
    }

    public void addAliased(Relation relation)
    {
        aliasedRelations.add(NodeRef.of(relation));
    }

    public boolean isAliased(Relation relation)
    {
        return aliasedRelations.contains(NodeRef.of(relation));
    }

    public void addPolymorphicTableFunction(TableFunctionInvocation invocation)
    {
        polymorphicTableFunctions.add(NodeRef.of(invocation));
    }

    public boolean isPolymorphicTableFunction(TableFunctionInvocation invocation)
    {
        return polymorphicTableFunctions.contains(NodeRef.of(invocation));
    }

    private boolean isInputTable(Table table)
    {
        return !(isUpdateTarget(table) || isInsertTarget(table));
    }

    private boolean isInsertTarget(Table table)
    {
        requireNonNull(table, "table is null");
        return insert
                .map(Insert::getTable)
                .map(tableReference -> tableReference == table) // intentional comparison by reference
                .orElse(FALSE);
    }

    public List getPatternInputsAnalysis(Expression expression)
    {
        return patternInputsAnalysis.get(NodeRef.of(expression));
    }

    public boolean isPatternNavigationFunction(FunctionCall node)
    {
        return patternNavigationFunctions.contains(NodeRef.of(node));
    }

    public String getResolvedLabel(Identifier identifier)
    {
        return resolvedLabels.get(NodeRef.of(identifier));
    }

    public Set getLabels(SubsetDefinition subset)
    {
        return subsets.get(NodeRef.of(subset));
    }

    public void addSubsetLabels(SubsetDefinition subset, Set labels)
    {
        subsets.put(NodeRef.of(subset), labels);
    }

    public void addSubsetLabels(Map, Set> subsets)
    {
        this.subsets.putAll(subsets);
    }

    public void addResolvedLabel(Identifier label, String resolved)
    {
        resolvedLabels.put(NodeRef.of(label), resolved);
    }

    public void addResolvedLabels(Map, String> labels)
    {
        resolvedLabels.putAll(labels);
    }

    public List getMaterializedViewStorageTableFields(Table node)
    {
        return materializedViewStorageTableFields.get(NodeRef.of(node));
    }

    public void setMaterializedViewStorageTableFields(Table node, List fields)
    {
        materializedViewStorageTableFields.put(NodeRef.of(node), fields);
    }

    @Immutable
    public static final class SelectExpression
    {
        // expression refers to a select item, either to be returned directly, or unfolded by all-fields reference
        // unfoldedExpressions applies to the latter case, and is a list of subscript expressions
        // referencing each field of the row.
        private final Expression expression;
        private final Optional> unfoldedExpressions;

        public SelectExpression(Expression expression, Optional> unfoldedExpressions)
        {
            this.expression = requireNonNull(expression, "expression is null");
            this.unfoldedExpressions = requireNonNull(unfoldedExpressions);
        }

        public Expression getExpression()
        {
            return expression;
        }

        public Optional> getUnfoldedExpressions()
        {
            return unfoldedExpressions;
        }
    }

    @Immutable
    public static final class Create
    {
        private final Optional destination;
        private final Optional metadata;
        private final Optional layout;
        private final boolean createTableAsSelectWithData;
        private final boolean createTableAsSelectNoOp;
        private final boolean replace;

        public Create(
                Optional destination,
                Optional metadata,
                Optional layout,
                boolean createTableAsSelectWithData,
                boolean createTableAsSelectNoOp,
                boolean replace)
        {
            this.destination = requireNonNull(destination, "destination is null");
            this.metadata = requireNonNull(metadata, "metadata is null");
            this.layout = requireNonNull(layout, "layout is null");
            this.createTableAsSelectWithData = createTableAsSelectWithData;
            this.createTableAsSelectNoOp = createTableAsSelectNoOp;
            this.replace = replace;
        }

        public Optional getDestination()
        {
            return destination;
        }

        public Optional getMetadata()
        {
            return metadata;
        }

        public Optional getLayout()
        {
            return layout;
        }

        public boolean isCreateTableAsSelectWithData()
        {
            return createTableAsSelectWithData;
        }

        public boolean isCreateTableAsSelectNoOp()
        {
            return createTableAsSelectNoOp;
        }

        public boolean isReplace()
        {
            return replace;
        }
    }

    @Immutable
    public static final class Insert
    {
        private final Table table;
        private final TableHandle target;
        private final List columns;
        private final Optional newTableLayout;

        public Insert(Table table, TableHandle target, List columns, Optional newTableLayout)
        {
            this.table = requireNonNull(table, "table is null");
            this.target = requireNonNull(target, "target is null");
            this.columns = requireNonNull(columns, "columns is null");
            checkArgument(columns.size() > 0, "No columns given to insert");
            this.newTableLayout = requireNonNull(newTableLayout, "newTableLayout is null");
        }

        public Table getTable()
        {
            return table;
        }

        public List getColumns()
        {
            return columns;
        }

        public TableHandle getTarget()
        {
            return target;
        }

        public Optional getNewTableLayout()
        {
            return newTableLayout;
        }
    }

    @Immutable
    public static final class RefreshMaterializedViewAnalysis
    {
        private final Table table;
        private final TableHandle target;
        private final Query query;
        private final List columns;

        public RefreshMaterializedViewAnalysis(Table table, TableHandle target, Query query, List columns)
        {
            this.table = requireNonNull(table, "table is null");
            this.target = requireNonNull(target, "target is null");
            this.query = query;
            this.columns = requireNonNull(columns, "columns is null");
            checkArgument(columns.size() > 0, "No columns given to refresh materialized view");
        }

        public Query getQuery()
        {
            return query;
        }

        public List getColumns()
        {
            return columns;
        }

        public TableHandle getTarget()
        {
            return target;
        }

        public Table getTable()
        {
            return table;
        }
    }

    public static final class JoinUsingAnalysis
    {
        private final List leftJoinFields;
        private final List rightJoinFields;
        private final List otherLeftFields;
        private final List otherRightFields;

        JoinUsingAnalysis(List leftJoinFields, List rightJoinFields, List otherLeftFields, List otherRightFields)
        {
            this.leftJoinFields = ImmutableList.copyOf(leftJoinFields);
            this.rightJoinFields = ImmutableList.copyOf(rightJoinFields);
            this.otherLeftFields = ImmutableList.copyOf(otherLeftFields);
            this.otherRightFields = ImmutableList.copyOf(otherRightFields);

            checkArgument(leftJoinFields.size() == rightJoinFields.size(), "Expected join fields for left and right to have the same size");
        }

        public List getLeftJoinFields()
        {
            return leftJoinFields;
        }

        public List getRightJoinFields()
        {
            return rightJoinFields;
        }

        public List getOtherLeftFields()
        {
            return otherLeftFields;
        }

        public List getOtherRightFields()
        {
            return otherRightFields;
        }
    }

    public static class GroupingSetAnalysis
    {
        private final List originalExpressions;

        private final List>> cubes;
        private final List>> rollups;
        private final List>> ordinarySets;
        private final List complexExpressions;

        public GroupingSetAnalysis(
                List originalExpressions,
                List>> cubes,
                List>> rollups,
                List>> ordinarySets,
                List complexExpressions)
        {
            this.originalExpressions = ImmutableList.copyOf(originalExpressions);
            this.cubes = ImmutableList.copyOf(cubes);
            this.rollups = ImmutableList.copyOf(rollups);
            this.ordinarySets = ImmutableList.copyOf(ordinarySets);
            this.complexExpressions = ImmutableList.copyOf(complexExpressions);
        }

        public List getOriginalExpressions()
        {
            return originalExpressions;
        }

        public List>> getCubes()
        {
            return cubes;
        }

        public List>> getRollups()
        {
            return rollups;
        }

        public List>> getOrdinarySets()
        {
            return ordinarySets;
        }

        public List getComplexExpressions()
        {
            return complexExpressions;
        }

        public Set getAllFields()
        {
            return Streams.concat(
                    cubes.stream()
                            .flatMap(Collection::stream)
                            .flatMap(Collection::stream),
                    rollups.stream()
                            .flatMap(Collection::stream)
                            .flatMap(Collection::stream),
                    ordinarySets.stream()
                            .flatMap(Collection::stream)
                            .flatMap(Collection::stream))
                    .collect(toImmutableSet());
        }
    }

    public static class UnnestAnalysis
    {
        private final Map, List> mappings;
        private final Optional ordinalityField;

        public UnnestAnalysis(Map, List> mappings, Optional ordinalityField)
        {
            requireNonNull(mappings, "mappings is null");
            this.mappings = mappings.entrySet().stream()
                    .collect(toImmutableMap(Map.Entry::getKey, entry -> ImmutableList.copyOf(entry.getValue())));

            this.ordinalityField = requireNonNull(ordinalityField, "ordinalityField is null");
        }

        public Map, List> getMappings()
        {
            return mappings;
        }

        public Optional getOrdinalityField()
        {
            return ordinalityField;
        }
    }

    public static class SubqueryAnalysis
    {
        private final List inPredicatesSubqueries = new ArrayList<>();
        private final List subqueries = new ArrayList<>();
        private final List existsSubqueries = new ArrayList<>();
        private final List quantifiedComparisonSubqueries = new ArrayList<>();

        public void addInPredicates(List expressions)
        {
            inPredicatesSubqueries.addAll(expressions);
        }

        public void addSubqueries(List expressions)
        {
            subqueries.addAll(expressions);
        }

        public void addExistsSubqueries(List expressions)
        {
            existsSubqueries.addAll(expressions);
        }

        public void addQuantifiedComparisons(List expressions)
        {
            quantifiedComparisonSubqueries.addAll(expressions);
        }

        public List getInPredicatesSubqueries()
        {
            return unmodifiableList(inPredicatesSubqueries);
        }

        public List getSubqueries()
        {
            return unmodifiableList(subqueries);
        }

        public List getExistsSubqueries()
        {
            return unmodifiableList(existsSubqueries);
        }

        public List getQuantifiedComparisonSubqueries()
        {
            return unmodifiableList(quantifiedComparisonSubqueries);
        }
    }

    /**
     * Analysis for predicates such as x IN (subquery) or x = SOME (subquery)
     */
    public static class PredicateCoercions
    {
        private final Type valueType;
        private final Optional valueCoercion;
        private final Optional subqueryCoercion;

        public PredicateCoercions(Type valueType, Optional valueCoercion, Optional subqueryCoercion)
        {
            this.valueType = requireNonNull(valueType, "valueType is null");
            this.valueCoercion = requireNonNull(valueCoercion, "valueCoercion is null");
            this.subqueryCoercion = requireNonNull(subqueryCoercion, "subqueryCoercion is null");
        }

        public Type getValueType()
        {
            return valueType;
        }

        public Optional getValueCoercion()
        {
            return valueCoercion;
        }

        public Optional getSubqueryCoercion()
        {
            return subqueryCoercion;
        }
    }

    public static class ResolvedWindow
    {
        private final List partitionBy;
        private final Optional orderBy;
        private final Optional frame;
        private final boolean partitionByInherited;
        private final boolean orderByInherited;
        private final boolean frameInherited;

        public ResolvedWindow(List partitionBy, Optional orderBy, Optional frame, boolean partitionByInherited, boolean orderByInherited, boolean frameInherited)
        {
            this.partitionBy = requireNonNull(partitionBy, "partitionBy is null");
            this.orderBy = requireNonNull(orderBy, "orderBy is null");
            this.frame = requireNonNull(frame, "frame is null");
            this.partitionByInherited = partitionByInherited;
            this.orderByInherited = orderByInherited;
            this.frameInherited = frameInherited;
        }

        public List getPartitionBy()
        {
            return partitionBy;
        }

        public Optional getOrderBy()
        {
            return orderBy;
        }

        public Optional getFrame()
        {
            return frame;
        }

        public boolean isPartitionByInherited()
        {
            return partitionByInherited;
        }

        public boolean isOrderByInherited()
        {
            return orderByInherited;
        }

        public boolean isFrameInherited()
        {
            return frameInherited;
        }

        @Override
        public boolean equals(Object o)
        {
            if (this == o) {
                return true;
            }
            if (o == null || getClass() != o.getClass()) {
                return false;
            }
            ResolvedWindow that = (ResolvedWindow) o;
            return partitionByInherited == that.partitionByInherited &&
                    orderByInherited == that.orderByInherited &&
                    frameInherited == that.frameInherited &&
                    partitionBy.equals(that.partitionBy) &&
                    orderBy.equals(that.orderBy) &&
                    frame.equals(that.frame);
        }

        @Override
        public int hashCode()
        {
            return Objects.hash(partitionBy, orderBy, frame, partitionByInherited, orderByInherited, frameInherited);
        }
    }

    public static class MergeAnalysis
    {
        private final Table targetTable;
        private final List dataColumnSchemas;
        private final List dataColumnHandles;
        private final List redistributionColumnHandles;
        private final List> mergeCaseColumnHandles;
        private final Set nonNullableColumnHandles;
        private final Map columnHandleFieldNumbers;
        private final RowType mergeRowType;
        private final List insertPartitioningArgumentIndexes;
        private final Optional insertLayout;
        private final Optional updateLayout;
        private final Scope targetTableScope;
        private final Scope joinScope;

        public MergeAnalysis(
                Table targetTable,
                List dataColumnSchemas,
                List dataColumnHandles,
                List redistributionColumnHandles,
                List> mergeCaseColumnHandles,
                Set nonNullableColumnHandles,
                Map columnHandleFieldNumbers,
                RowType mergeRowType,
                List insertPartitioningArgumentIndexes,
                Optional insertLayout,
                Optional updateLayout,
                Scope targetTableScope,
                Scope joinScope)
        {
            this.targetTable = requireNonNull(targetTable, "targetTable is null");
            this.dataColumnSchemas = requireNonNull(dataColumnSchemas, "dataColumnSchemas is null");
            this.dataColumnHandles = requireNonNull(dataColumnHandles, "dataColumnHandles is null");
            this.redistributionColumnHandles = requireNonNull(redistributionColumnHandles, "redistributionColumnHandles is null");
            this.mergeCaseColumnHandles = requireNonNull(mergeCaseColumnHandles, "mergeCaseColumnHandles is null");
            this.nonNullableColumnHandles = requireNonNull(nonNullableColumnHandles, "nonNullableColumnHandles is null");
            this.columnHandleFieldNumbers = requireNonNull(columnHandleFieldNumbers, "columnHandleFieldNumbers is null");
            this.mergeRowType = requireNonNull(mergeRowType, "mergeRowType is null");
            this.insertLayout = requireNonNull(insertLayout, "insertLayout is null");
            this.updateLayout = requireNonNull(updateLayout, "updateLayout is null");
            this.insertPartitioningArgumentIndexes = requireNonNull(insertPartitioningArgumentIndexes, "insertPartitioningArgumentIndexes is null");
            this.targetTableScope = requireNonNull(targetTableScope, "targetTableScope is null");
            this.joinScope = requireNonNull(joinScope, "joinScope is null");
        }

        public Table getTargetTable()
        {
            return targetTable;
        }

        public List getDataColumnSchemas()
        {
            return dataColumnSchemas;
        }

        public List getDataColumnHandles()
        {
            return dataColumnHandles;
        }

        public List getRedistributionColumnHandles()
        {
            return redistributionColumnHandles;
        }

        public List> getMergeCaseColumnHandles()
        {
            return mergeCaseColumnHandles;
        }

        public Set getNonNullableColumnHandles()
        {
            return nonNullableColumnHandles;
        }

        public Map getColumnHandleFieldNumbers()
        {
            return columnHandleFieldNumbers;
        }

        public RowType getMergeRowType()
        {
            return mergeRowType;
        }

        public List getInsertPartitioningArgumentIndexes()
        {
            return insertPartitioningArgumentIndexes;
        }

        public Optional getInsertLayout()
        {
            return insertLayout;
        }

        public Optional getUpdateLayout()
        {
            return updateLayout;
        }

        public Scope getJoinScope()
        {
            return joinScope;
        }

        public Scope getTargetTableScope()
        {
            return targetTableScope;
        }
    }

    public static final class AccessControlInfo
    {
        private final AccessControl accessControl;
        private final Identity identity;

        public AccessControlInfo(AccessControl accessControl, Identity identity)
        {
            this.accessControl = requireNonNull(accessControl, "accessControl is null");
            this.identity = requireNonNull(identity, "identity is null");
        }

        public AccessControl getAccessControl()
        {
            return accessControl;
        }

        public SecurityContext getSecurityContext(TransactionId transactionId, QueryId queryId, Instant queryStart)
        {
            return new SecurityContext(transactionId, identity, queryId, queryStart);
        }

        @Override
        public boolean equals(Object o)
        {
            if (this == o) {
                return true;
            }
            if (o == null || getClass() != o.getClass()) {
                return false;
            }

            AccessControlInfo that = (AccessControlInfo) o;
            return Objects.equals(accessControl, that.accessControl) &&
                    Objects.equals(identity, that.identity);
        }

        @Override
        public int hashCode()
        {
            return Objects.hash(accessControl, identity);
        }

        @Override
        public String toString()
        {
            return format("AccessControl: %s, Identity: %s", accessControl.getClass(), identity);
        }
    }

    private static class RowFilterScopeEntry
    {
        private final QualifiedObjectName table;
        private final String identity;

        public RowFilterScopeEntry(QualifiedObjectName table, String identity)
        {
            this.table = requireNonNull(table, "table is null");
            this.identity = requireNonNull(identity, "identity is null");
        }

        @Override
        public boolean equals(Object o)
        {
            if (this == o) {
                return true;
            }
            if (o == null || getClass() != o.getClass()) {
                return false;
            }
            RowFilterScopeEntry that = (RowFilterScopeEntry) o;
            return table.equals(that.table) &&
                    identity.equals(that.identity);
        }

        @Override
        public int hashCode()
        {
            return Objects.hash(table, identity);
        }
    }

    private static class ColumnMaskScopeEntry
    {
        private final QualifiedObjectName table;
        private final String column;
        private final String identity;

        public ColumnMaskScopeEntry(QualifiedObjectName table, String column, String identity)
        {
            this.table = requireNonNull(table, "table is null");
            this.column = requireNonNull(column, "column is null");
            this.identity = requireNonNull(identity, "identity is null");
        }

        @Override
        public boolean equals(Object o)
        {
            if (this == o) {
                return true;
            }
            if (o == null || getClass() != o.getClass()) {
                return false;
            }
            ColumnMaskScopeEntry that = (ColumnMaskScopeEntry) o;
            return table.equals(that.table) &&
                    column.equals(that.column) &&
                    identity.equals(that.identity);
        }

        @Override
        public int hashCode()
        {
            return Objects.hash(table, column, identity);
        }
    }

    private static class TableEntry
    {
        private final Optional handle;
        private final QualifiedObjectName name;
        private final String authorization;
        private final Scope accessControlScope; // synthetic scope for analysis of row filters and masks
        private final boolean directlyReferenced;
        private final Optional viewText;
        private final List referenceChain;

        public TableEntry(
                Optional handle,
                QualifiedObjectName name,
                String authorization,
                Scope accessControlScope,
                boolean directlyReferenced,
                Optional viewText,
                Iterable referenceChain)
        {
            this.handle = requireNonNull(handle, "handle is null");
            this.name = requireNonNull(name, "name is null");
            this.authorization = requireNonNull(authorization, "authorization is null");
            this.accessControlScope = requireNonNull(accessControlScope, "accessControlScope is null");
            this.directlyReferenced = directlyReferenced;
            this.viewText = requireNonNull(viewText, "viewText is null");
            this.referenceChain = ImmutableList.copyOf(requireNonNull(referenceChain, "referenceChain is null"));
        }

        public Optional getHandle()
        {
            return handle;
        }

        public QualifiedObjectName getName()
        {
            return name;
        }

        public String getAuthorization()
        {
            return authorization;
        }

        public Scope getAccessControlScope()
        {
            return accessControlScope;
        }

        public boolean isDirectlyReferenced()
        {
            return directlyReferenced;
        }

        public Optional getViewText()
        {
            return viewText;
        }

        public List getReferenceChain()
        {
            return referenceChain;
        }
    }

    public static class SourceColumn
    {
        private final QualifiedObjectName tableName;
        private final String columnName;

        @JsonCreator
        public SourceColumn(@JsonProperty("tableName") QualifiedObjectName tableName, @JsonProperty("columnName") String columnName)
        {
            this.tableName = requireNonNull(tableName, "tableName is null");
            this.columnName = requireNonNull(columnName, "columnName is null");
        }

        @JsonProperty
        public QualifiedObjectName getTableName()
        {
            return tableName;
        }

        @JsonProperty
        public String getColumnName()
        {
            return columnName;
        }

        public ColumnDetail getColumnDetail()
        {
            return new ColumnDetail(tableName.catalogName(), tableName.schemaName(), tableName.objectName(), columnName);
        }

        @Override
        public int hashCode()
        {
            return Objects.hash(tableName, columnName);
        }

        @Override
        public boolean equals(Object obj)
        {
            if (obj == this) {
                return true;
            }
            if ((obj == null) || (getClass() != obj.getClass())) {
                return false;
            }
            SourceColumn entry = (SourceColumn) obj;
            return Objects.equals(tableName, entry.tableName) &&
                    Objects.equals(columnName, entry.columnName);
        }

        @Override
        public String toString()
        {
            return toStringHelper(this)
                    .add("tableName", tableName)
                    .add("columnName", columnName)
                    .toString();
        }
    }

    private static class RoutineEntry
    {
        private final ResolvedFunction function;
        private final String authorization;

        public RoutineEntry(ResolvedFunction function, String authorization)
        {
            this.function = requireNonNull(function, "function is null");
            this.authorization = requireNonNull(authorization, "authorization is null");
        }

        public ResolvedFunction getFunction()
        {
            return function;
        }

        public String getAuthorization()
        {
            return authorization;
        }
    }

    private static class UpdateTarget
    {
        private final CatalogVersion catalogVersion;
        private final QualifiedObjectName name;
        private final Optional table;
        private final Optional> columns;

        public UpdateTarget(CatalogVersion catalogVersion, QualifiedObjectName name, Optional table, Optional> columns)
        {
            this.catalogVersion = requireNonNull(catalogVersion, "catalogVersion is null");
            this.name = requireNonNull(name, "name is null");
            this.table = requireNonNull(table, "table is null");
            this.columns = columns.map(ImmutableList::copyOf);
        }

        private CatalogVersion getCatalogVersion()
        {
            return catalogVersion;
        }

        public QualifiedObjectName getName()
        {
            return name;
        }

        public Optional getTable()
        {
            return table;
        }

        public Optional> getColumns()
        {
            return columns;
        }
    }

    public static class Range
    {
        private final Optional atLeast;
        private final Optional atMost;

        public Range(Optional atLeast, Optional atMost)
        {
            this.atLeast = requireNonNull(atLeast, "atLeast is null");
            this.atMost = requireNonNull(atMost, "atMost is null");
        }

        public Optional getAtLeast()
        {
            return atLeast;
        }

        public Optional getAtMost()
        {
            return atMost;
        }
    }

    public static class TableArgumentAnalysis
    {
        private final String argumentName;
        private final Optional name;
        private final Relation relation;
        private final Optional> partitionBy; // it is allowed to partition by empty list
        private final Optional orderBy;
        private final boolean pruneWhenEmpty;
        private final boolean rowSemantics;
        private final boolean passThroughColumns;

        private TableArgumentAnalysis(
                String argumentName,
                Optional name,
                Relation relation,
                Optional> partitionBy,
                Optional orderBy,
                boolean pruneWhenEmpty,
                boolean rowSemantics,
                boolean passThroughColumns)
        {
            this.argumentName = requireNonNull(argumentName, "argumentName is null");
            this.name = requireNonNull(name, "name is null");
            this.relation = requireNonNull(relation, "relation is null");
            this.partitionBy = requireNonNull(partitionBy, "partitionBy is null").map(ImmutableList::copyOf);
            this.orderBy = requireNonNull(orderBy, "orderBy is null");
            this.pruneWhenEmpty = pruneWhenEmpty;
            this.rowSemantics = rowSemantics;
            this.passThroughColumns = passThroughColumns;
        }

        public String getArgumentName()
        {
            return argumentName;
        }

        public Optional getName()
        {
            return name;
        }

        public Relation getRelation()
        {
            return relation;
        }

        public Optional> getPartitionBy()
        {
            return partitionBy;
        }

        public Optional getOrderBy()
        {
            return orderBy;
        }

        public boolean isPruneWhenEmpty()
        {
            return pruneWhenEmpty;
        }

        public boolean isRowSemantics()
        {
            return rowSemantics;
        }

        public boolean isPassThroughColumns()
        {
            return passThroughColumns;
        }

        public static Builder builder()
        {
            return new Builder();
        }

        public static final class Builder
        {
            private String argumentName;
            private Optional name = Optional.empty();
            private Relation relation;
            private Optional> partitionBy = Optional.empty();
            private Optional orderBy = Optional.empty();
            private boolean pruneWhenEmpty;
            private boolean rowSemantics;
            private boolean passThroughColumns;

            private Builder() {}

            @CanIgnoreReturnValue
            public Builder withArgumentName(String argumentName)
            {
                this.argumentName = argumentName;
                return this;
            }

            @CanIgnoreReturnValue
            public Builder withName(QualifiedName name)
            {
                this.name = Optional.of(name);
                return this;
            }

            @CanIgnoreReturnValue
            public Builder withRelation(Relation relation)
            {
                this.relation = relation;
                return this;
            }

            @CanIgnoreReturnValue
            public Builder withPartitionBy(List partitionBy)
            {
                this.partitionBy = Optional.of(partitionBy);
                return this;
            }

            @CanIgnoreReturnValue
            public Builder withOrderBy(OrderBy orderBy)
            {
                this.orderBy = Optional.of(orderBy);
                return this;
            }

            @CanIgnoreReturnValue
            public Builder withPruneWhenEmpty(boolean pruneWhenEmpty)
            {
                this.pruneWhenEmpty = pruneWhenEmpty;
                return this;
            }

            @CanIgnoreReturnValue
            public Builder withRowSemantics(boolean rowSemantics)
            {
                this.rowSemantics = rowSemantics;
                return this;
            }

            @CanIgnoreReturnValue
            public Builder withPassThroughColumns(boolean passThroughColumns)
            {
                this.passThroughColumns = passThroughColumns;
                return this;
            }

            public TableArgumentAnalysis build()
            {
                return new TableArgumentAnalysis(argumentName, name, relation, partitionBy, orderBy, pruneWhenEmpty, rowSemantics, passThroughColumns);
            }
        }
    }

    public static class TableFunctionInvocationAnalysis
    {
        private final CatalogHandle catalogHandle;
        private final String functionName;
        private final Map arguments;
        private final List tableArgumentAnalyses;
        private final Map> requiredColumns;
        private final List> copartitioningLists;
        private final int properColumnsCount;
        private final ConnectorTableFunctionHandle connectorTableFunctionHandle;
        private final ConnectorTransactionHandle transactionHandle;

        public TableFunctionInvocationAnalysis(
                CatalogHandle catalogHandle,
                String functionName,
                Map arguments,
                List tableArgumentAnalyses,
                Map> requiredColumns,
                List> copartitioningLists,
                int properColumnsCount,
                ConnectorTableFunctionHandle connectorTableFunctionHandle,
                ConnectorTransactionHandle transactionHandle)
        {
            this.catalogHandle = requireNonNull(catalogHandle, "catalogHandle is null");
            this.functionName = requireNonNull(functionName, "functionName is null");
            this.arguments = ImmutableMap.copyOf(arguments);
            this.tableArgumentAnalyses = ImmutableList.copyOf(tableArgumentAnalyses);
            this.requiredColumns = requiredColumns.entrySet().stream()
                    .collect(toImmutableMap(Map.Entry::getKey, entry -> ImmutableList.copyOf(entry.getValue())));
            this.copartitioningLists = ImmutableList.copyOf(copartitioningLists);
            this.properColumnsCount = properColumnsCount;
            this.connectorTableFunctionHandle = requireNonNull(connectorTableFunctionHandle, "connectorTableFunctionHandle is null");
            this.transactionHandle = requireNonNull(transactionHandle, "transactionHandle is null");
        }

        public CatalogHandle getCatalogHandle()
        {
            return catalogHandle;
        }

        public String getFunctionName()
        {
            return functionName;
        }

        public Map getArguments()
        {
            return arguments;
        }

        public List getTableArgumentAnalyses()
        {
            return tableArgumentAnalyses;
        }

        public Map> getRequiredColumns()
        {
            return requiredColumns;
        }

        public List> getCopartitioningLists()
        {
            return copartitioningLists;
        }

        /**
         * Proper columns are the columns produced by the table function, as opposed to pass-through columns from input tables.
         * Proper columns should be considered the actual result of the table function.
         *
         * @return the number of table function's proper columns
         */
        public int getProperColumnsCount()
        {
            return properColumnsCount;
        }

        public ConnectorTableFunctionHandle getConnectorTableFunctionHandle()
        {
            return connectorTableFunctionHandle;
        }

        public ConnectorTransactionHandle getTransactionHandle()
        {
            return transactionHandle;
        }
    }

    public record JsonTableAnalysis(
            CatalogHandle catalogHandle,
            ConnectorTransactionHandle transactionHandle,
            RowType parametersType,
            List> orderedOutputColumns)
    {
        public JsonTableAnalysis
        {
            requireNonNull(catalogHandle, "catalogHandle is null");
            requireNonNull(transactionHandle, "transactionHandle is null");
            requireNonNull(parametersType, "parametersType is null");
            requireNonNull(orderedOutputColumns, "orderedOutputColumns is null");
        }
    }
}
    

    







    
© 2015 - 2025 Weber Informatics LLC | Privacy Policy