io.trino.sql.planner.plan.GroupIdNode Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of trino-main Show documentation
Trino - Engine
There is a newer version: 465
/*
 * 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.plan;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Iterables;
import com.google.common.collect.Sets;
import com.google.errorprone.annotations.Immutable;
import io.trino.sql.planner.Symbol;

import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;

import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.collect.ImmutableSet.toImmutableSet;
import static io.trino.util.MoreLists.listOfListsCopy;
import static java.util.Objects.requireNonNull;

@Immutable
public class GroupIdNode
        extends PlanNode
{
    private final PlanNode source;

    // in terms of output symbols
    private final List> groupingSets;

    // tracks how each grouping set column is derived from an input column
    private final Map groupingColumns;
    private final List aggregationArguments;

    private final Symbol groupIdSymbol;

    @JsonCreator
    public GroupIdNode(
            @JsonProperty("id") PlanNodeId id,
            @JsonProperty("source") PlanNode source,
            @JsonProperty("groupingSets") List> groupingSets,
            @JsonProperty("groupingColumns") Map groupingColumns,
            @JsonProperty("aggregationArguments") List aggregationArguments,
            @JsonProperty("groupIdSymbol") Symbol groupIdSymbol)
    {
        super(id);
        this.source = requireNonNull(source, "source is null");
        this.groupingSets = listOfListsCopy(requireNonNull(groupingSets, "groupingSets is null"));
        this.groupingColumns = ImmutableMap.copyOf(requireNonNull(groupingColumns));
        this.aggregationArguments = ImmutableList.copyOf(aggregationArguments);
        this.groupIdSymbol = requireNonNull(groupIdSymbol);

        Set outputs = ImmutableSet.copyOf(source.getOutputSymbols());
        checkArgument(outputs.containsAll(groupingColumns.values()));
        checkArgument(outputs.containsAll(aggregationArguments));

        checkArgument(Sets.intersection(groupingColumns.keySet(), ImmutableSet.copyOf(aggregationArguments)).isEmpty(), "aggregation columns and grouping set columns must be a disjoint set");
    }

    @Override
    public List getOutputSymbols()
    {
        Set distinctGroupingSetSymbols = getDistinctGroupingSetSymbols();
        return ImmutableList.builderWithExpectedSize(distinctGroupingSetSymbols.size() + aggregationArguments.size() + 1)
                .addAll(distinctGroupingSetSymbols)
                .addAll(aggregationArguments)
                .add(groupIdSymbol)
                .build();
    }

    @Override
    public List getSources()
    {
        return ImmutableList.of(source);
    }

    @JsonProperty
    public PlanNode getSource()
    {
        return source;
    }

    @JsonProperty
    public List> getGroupingSets()
    {
        return groupingSets;
    }

    @JsonIgnore
    public Set getDistinctGroupingSetSymbols()
    {
        return groupingSets.stream()
                .flatMap(List::stream)
                .collect(toImmutableSet()); // Produce a stable ordering of grouping set symbols in the output
    }

    @JsonProperty
    public Map getGroupingColumns()
    {
        return groupingColumns;
    }

    @JsonProperty
    public List getAggregationArguments()
    {
        return aggregationArguments;
    }

    @JsonProperty
    public Symbol getGroupIdSymbol()
    {
        return groupIdSymbol;
    }

    @Override
    public  R accept(PlanVisitor visitor, C context)
    {
        return visitor.visitGroupId(this, context);
    }

    public Set getInputSymbols()
    {
        Set distinctGroupingSetSymbols = getDistinctGroupingSetSymbols();
        ImmutableSet.Builder builder = ImmutableSet.builderWithExpectedSize(aggregationArguments.size() + distinctGroupingSetSymbols.size());
        builder.addAll(aggregationArguments);
        for (Symbol groupingSetSymbol : distinctGroupingSetSymbols) {
            builder.add(groupingColumns.get(groupingSetSymbol));
        }
        return builder.build();
    }

    // returns the common grouping columns in terms of output symbols
    public Set getCommonGroupingColumns()
    {
        Set intersection = new LinkedHashSet<>(groupingSets.get(0));
        for (int i = 1; i < groupingSets.size(); i++) {
            intersection.retainAll(groupingSets.get(i));
        }
        return ImmutableSet.copyOf(intersection);
    }

    @Override
    public PlanNode replaceChildren(List newChildren)
    {
        return new GroupIdNode(getId(), Iterables.getOnlyElement(newChildren), groupingSets, groupingColumns, aggregationArguments, groupIdSymbol);
    }
}