morningman commented on code in PR #69194: URL: https://github.com/apache/doris/pull/69194#discussion_r4294352508
########## fe/fe-core/src/main/java/org/apache/doris/datasource/VariantWritePlanValidator.java: ########## @@ -0,0 +1,448 @@ +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + +package org.apache.doris.datasource; + +import org.apache.doris.catalog.Column; +import org.apache.doris.nereids.CTEContext; +import org.apache.doris.nereids.exceptions.AnalysisException; +import org.apache.doris.nereids.trees.expressions.CTEId; +import org.apache.doris.nereids.trees.expressions.Cast; +import org.apache.doris.nereids.trees.expressions.ExprId; +import org.apache.doris.nereids.trees.expressions.Expression; +import org.apache.doris.nereids.trees.expressions.NamedExpression; +import org.apache.doris.nereids.trees.expressions.ScalarSubquery; +import org.apache.doris.nereids.trees.expressions.Slot; +import org.apache.doris.nereids.trees.expressions.SlotReference; +import org.apache.doris.nereids.trees.expressions.WhenClause; +import org.apache.doris.nereids.trees.expressions.functions.scalar.If; +import org.apache.doris.nereids.trees.plans.Plan; +import org.apache.doris.nereids.trees.plans.algebra.RecursiveCte; +import org.apache.doris.nereids.trees.plans.algebra.SetOperation; +import org.apache.doris.nereids.trees.plans.logical.LogicalCTEConsumer; +import org.apache.doris.nereids.trees.plans.logical.LogicalCTEProducer; +import org.apache.doris.nereids.trees.plans.logical.LogicalGenerate; +import org.apache.doris.nereids.trees.plans.logical.LogicalUnion; +import org.apache.doris.nereids.types.ArrayType; +import org.apache.doris.nereids.types.DataType; +import org.apache.doris.nereids.types.MapType; +import org.apache.doris.nereids.types.StructField; +import org.apache.doris.nereids.types.StructType; +import org.apache.doris.nereids.types.VariantType; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.Set; + +/** Shared source-plan validation for external Variant sinks. */ +public final class VariantWritePlanValidator { + private VariantWritePlanValidator() { + } + + /** + * Rejects an implicit Variant-to-non-Variant cast in the lineage of a Variant target column. + * + * <p>Common-type analysis for UNION, IF and CASE runs before sink binding. Without this + * check, an object or array Variant can become SQL NULL while being cast to a scalar, and the + * sink will only see that scalar/NULL and encode it back as Variant. Explicit casts remain an + * intentional user conversion and are not rejected. Only the expressions whose values can reach + * the target are inspected: the condition of an IF or of a CASE branch only chooses a value, so a + * Variant path compared with a scalar there loses nothing that is written.</p> + */ + public static void validateNoLossyCoercion(List<Column> targetColumns, Plan sourcePlan) { + validateNoLossyCoercion(targetColumns, sourcePlan, Optional.empty()); + } + + /** Validates a sink while its enclosing CTE producers still live in the analyzer context. */ + public static void validateNoLossyCoercion( + List<Column> targetColumns, Plan sourcePlan, CTEContext cteContext) { + validateNoLossyCoercion(targetColumns, sourcePlan, Optional.of(cteContext)); + } + + private static void validateNoLossyCoercion( + List<Column> targetColumns, Plan sourcePlan, Optional<CTEContext> cteContext) { + if (targetColumns.size() != sourcePlan.getOutput().size()) { + throw new AnalysisException("VARIANT write target and source columns are not aligned"); + } + List<Integer> sourceOrdinals = new ArrayList<>(targetColumns.size()); + for (int i = 0; i < targetColumns.size(); i++) { + sourceOrdinals.add(i); + } + validateNoLossyCoercion(targetColumns, sourcePlan, sourceOrdinals, cteContext); + } + + /** + * Validates target columns that are embedded in a wider source output, such as row-level DML + * where the operation and row-id routing columns precede the table data columns. + */ + public static void validateNoLossyCoercion( + List<Column> targetColumns, Plan sourcePlan, List<Integer> sourceOrdinals) { + validateNoLossyCoercion(targetColumns, sourcePlan, sourceOrdinals, Optional.empty()); + } + + /** Validates mapped source ordinals with analyzer-time CTE producer visibility. */ + public static void validateNoLossyCoercion( + List<Column> targetColumns, Plan sourcePlan, List<Integer> sourceOrdinals, + CTEContext cteContext) { + validateNoLossyCoercion(targetColumns, sourcePlan, sourceOrdinals, Optional.of(cteContext)); + } + + private static void validateNoLossyCoercion( + List<Column> targetColumns, Plan sourcePlan, List<Integer> sourceOrdinals, + Optional<CTEContext> cteContext) { + if (targetColumns.size() != sourceOrdinals.size()) { + throw new AnalysisException("VARIANT write target and source columns are not aligned"); + } + + List<Integer> variantTargetOrdinals = new ArrayList<>(); + for (int i = 0; i < targetColumns.size(); i++) { + DataType targetType = DataType.fromCatalogType(targetColumns.get(i).getType()); + if (VariantType.containsVariant(targetType)) { + variantTargetOrdinals.add(i); + } + } + if (variantTargetOrdinals.isEmpty()) { + return; + } + + TraceContext traceContext = new TraceContext(sourcePlan, cteContext); + List<Slot> sourceOutputs = sourcePlan.getOutput(); + for (int targetOrdinal : variantTargetOrdinals) { + int sourceOrdinal = sourceOrdinals.get(targetOrdinal); + if (sourceOrdinal < 0 || sourceOrdinal >= sourceOutputs.size()) { + throw new AnalysisException("VARIANT write target and source columns are not aligned"); + } + Column targetColumn = targetColumns.get(targetOrdinal); + traceOutputLineage( + sourcePlan, + Collections.singleton(sourceOutputs.get(sourceOrdinal).getExprId()), + targetColumn.getName(), + traceContext); + } + } + + /** + * Validates the requested outputs and returns lineage ExprIds supplied by an outer scope. + * Scalar subqueries use the returned IDs to continue tracing correlated columns in the + * enclosing plan. + */ + private static Set<ExprId> traceOutputLineage( + Plan plan, Set<ExprId> requiredExprIds, String targetColumn, TraceContext context) { + if (requiredExprIds.isEmpty()) { + return Collections.emptySet(); + } + if (plan instanceof SetOperation) { + return traceSetOperation(plan, (SetOperation) plan, requiredExprIds, targetColumn, context); + } + if (plan instanceof RecursiveCte) { + return traceRecursiveCte(plan, (RecursiveCte) plan, requiredExprIds, targetColumn, context); + } + if (plan instanceof LogicalGenerate) { + return traceGenerate((LogicalGenerate<?>) plan, requiredExprIds, targetColumn, context); + } + if (plan instanceof LogicalCTEConsumer) { + return traceCteConsumer((LogicalCTEConsumer) plan, requiredExprIds, targetColumn, context); + } + + Set<ExprId> unresolvedExprIds = new HashSet<>(requiredExprIds); + Set<ExprId> inputExprIds = new HashSet<>(); + for (Expression expression : plan.getExpressions()) { + if (!(expression instanceof NamedExpression)) { + continue; + } + NamedExpression namedExpression = (NamedExpression) expression; + if (!requiredExprIds.contains(namedExpression.getExprId())) { + continue; + } + inputExprIds.addAll(validateExpression(namedExpression, targetColumn, context)); + unresolvedExprIds.remove(namedExpression.getExprId()); + } + inputExprIds.addAll(unresolvedExprIds); + + Set<ExprId> externalExprIds = new HashSet<>(inputExprIds); + for (Plan child : plan.children()) { + Set<ExprId> childOutputExprIds = child.getOutputExprIdSet(); + Set<ExprId> childRequiredExprIds = new HashSet<>(inputExprIds); + childRequiredExprIds.retainAll(childOutputExprIds); + externalExprIds.removeAll(childOutputExprIds); + externalExprIds.addAll(traceOutputLineage(child, childRequiredExprIds, targetColumn, context)); + } + return externalExprIds; + } + + private static Set<ExprId> traceRecursiveCte( + Plan plan, RecursiveCte recursiveCte, Set<ExprId> requiredExprIds, + String targetColumn, TraceContext context) { + Set<ExprId> externalExprIds = new HashSet<>(); + Set<Integer> requiredOrdinals = requiredOutputOrdinals(plan, requiredExprIds); + for (int childIndex = 0; childIndex < plan.arity(); childIndex++) { + List<SlotReference> childOutputs = recursiveCte.getRegularChildOutput(childIndex); + Set<ExprId> childRequiredExprIds = new HashSet<>(); + for (int ordinal : requiredOrdinals) { + if (ordinal < childOutputs.size()) { + childRequiredExprIds.add(childOutputs.get(ordinal).getExprId()); + } + } + externalExprIds.addAll(traceOutputLineage( + plan.child(childIndex), childRequiredExprIds, targetColumn, context)); + } + return externalExprIds; + } + + private static Set<ExprId> traceGenerate( + LogicalGenerate<?> generate, Set<ExprId> requiredExprIds, + String targetColumn, TraceContext context) { + Set<ExprId> childRequiredExprIds = new HashSet<>(requiredExprIds); + List<Slot> generatorOutputs = generate.getGeneratorOutput(); + List<? extends Expression> generators = generate.getGenerators(); + for (int ordinal = 0; ordinal < generatorOutputs.size(); ordinal++) { + Slot generatorOutput = generatorOutputs.get(ordinal); + if (!requiredExprIds.contains(generatorOutput.getExprId())) { + continue; + } + childRequiredExprIds.remove(generatorOutput.getExprId()); + childRequiredExprIds.addAll(validateExpression(generators.get(ordinal), targetColumn, context)); + } + Set<ExprId> childOutputExprIds = generate.child().getOutputExprIdSet(); + Set<ExprId> externalExprIds = new HashSet<>(childRequiredExprIds); + externalExprIds.removeAll(childOutputExprIds); + childRequiredExprIds.retainAll(childOutputExprIds); + externalExprIds.addAll(traceOutputLineage( + generate.child(), childRequiredExprIds, targetColumn, context)); + return externalExprIds; + } + + private static Set<ExprId> traceSetOperation( + Plan plan, SetOperation setOperation, Set<ExprId> requiredExprIds, + String targetColumn, TraceContext context) { + Set<ExprId> externalExprIds = new HashSet<>(); + Set<Integer> requiredOrdinals = requiredOutputOrdinals(plan, requiredExprIds); + + if (plan instanceof LogicalUnion) { + for (List<NamedExpression> constantRow : ((LogicalUnion) plan).getConstantExprsList()) { + for (int ordinal : requiredOrdinals) { + if (ordinal < constantRow.size()) { + externalExprIds.addAll(validateExpression(constantRow.get(ordinal), targetColumn, context)); + } + } + } + } + + for (int childIndex = 0; childIndex < setOperation.getArity(); childIndex++) { Review Comment: Fixed in `4a6b39396e5`. Agreed. This is the same split as for IF and CASE conditions, between the values written and the inputs that only choose them: EXCEPT and INTERSECT return rows of their first input, and the later inputs only decide which of those rows stay. `traceSetOperation` now traces only the first input of `LogicalExcept` and `LogicalIntersect`. Every UNION input is still traced, and a lossy cast in the first input is still rejected. Tests: `testLaterExceptAndIntersectInputsAreNotWrittenValues` accepts `SELECT 1, CAST(1 AS DECIMAL(38, 9)) AS payload EXCEPT SELECT 1, IF(TRUE, parse_to_variant('{"lost":true}'), 1)` and its INTERSECT form, and still rejects both with the inputs swapped. Tracing every input turns it red. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
