cloud-fan commented on code in PR #41262: URL: https://github.com/apache/spark/pull/41262#discussion_r1205271858
########## sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/analysis/ResolveColumnDefaultInInsert.scala: ########## @@ -0,0 +1,142 @@ +/* + * 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.spark.sql.catalyst.analysis + +import org.apache.spark.sql.catalyst.SQLConfHelper +import org.apache.spark.sql.catalyst.expressions.{Alias, Literal} +import org.apache.spark.sql.catalyst.plans.logical._ +import org.apache.spark.sql.catalyst.trees.TreePattern.UNRESOLVED_ATTRIBUTE +import org.apache.spark.sql.catalyst.util.ResolveDefaultColumns.{containsExplicitDefaultColumn, getDefaultValueExpr, isExplicitDefaultColumn} +import org.apache.spark.sql.errors.QueryCompilationErrors +import org.apache.spark.sql.internal.SQLConf +import org.apache.spark.sql.types.StructField + +/** + * A virtual rule to resolve column "DEFAULT" in [[Project]] and [[UnresolvedInlineTable]] under + * [[InsertIntoStatement]]. It's only used by the real rule `ResolveReferences`. + * + * This virtual rule is triggered if: + * 1. The column "DEFAULT" can't be resolved normally by `ResolveReferences`. This is guaranteed as + * `ResolveReferences` resolves the query plan bottom up. This means that when we reach here to + * resolve [[InsertIntoStatement]], its child plans have already been resolved by + * `ResolveReferences`. + * 2. The plan nodes between [[Project]] and [[InsertIntoStatement]] are + * all unary nodes that inherit the output columns from its child. + * 3. The plan nodes between [[UnresolvedInlineTable]] and [[InsertIntoStatement]] are either + * [[Project]], or [[Aggregate]], or [[SubqueryAlias]]. + */ +case object ResolveColumnDefaultInInsert extends SQLConfHelper with ColumnResolutionHelper { + // TODO (SPARK-43752): support v2 write commands as well. + def apply(plan: LogicalPlan): LogicalPlan = plan match { + case i: InsertIntoStatement if conf.enableDefaultColumns && i.table.resolved && + i.query.containsPattern(UNRESOLVED_ATTRIBUTE) => + val staticPartCols = i.partitionSpec.filter(_._2.isDefined).keys.map(normalizeFieldName).toSet + val expectedQuerySchema = i.table.schema.filter { field => + !staticPartCols.contains(normalizeFieldName(field.name)) + } + if (i.userSpecifiedCols.isEmpty) { + i.withNewChildren(Seq(resolveColumnDefault(i.query, expectedQuerySchema))) + } else { + // Reorder the fields in `expectedQuerySchema` according to the user-specified column list + // of the INSERT command. + val colNamesToFields: Map[String, StructField] = expectedQuerySchema.map { field => + normalizeFieldName(field.name) -> field + }.toMap + val reorder = i.userSpecifiedCols.map { col => + colNamesToFields.get(normalizeFieldName(col)) + } + if (reorder.forall(_.isDefined)) { + i.withNewChildren(Seq(resolveColumnDefault(i.query, reorder.flatten))) + } else { + i + } + } + + case _ => plan + } + + private def resolveColumnDefault( + plan: LogicalPlan, + expectedQuerySchema: Seq[StructField], + acceptProject: Boolean = true, + acceptInlineTable: Boolean = true): LogicalPlan = { + plan match { + case _: SubqueryAlias => + plan.mapChildren( + resolveColumnDefault(_, expectedQuerySchema, acceptProject, acceptInlineTable)) + + case _: GlobalLimit | _: LocalLimit | _: Offset | _: Sort if acceptProject => + plan.mapChildren( + resolveColumnDefault(_, expectedQuerySchema, acceptInlineTable = false)) + + case p: Project if acceptProject && p.child.resolved && + p.containsPattern(UNRESOLVED_ATTRIBUTE) && + p.projectList.length <= expectedQuerySchema.length => + val newProjectList = p.projectList.zipWithIndex.map { Review Comment: I'll add doc for the `resolveColumnDefault` method. -- 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]
