cloud-fan commented on code in PR #57962: URL: https://github.com/apache/spark/pull/57962#discussion_r3784772747
########## sql/core/src/main/scala/org/apache/spark/sql/catalyst/parser/ParseSqlResult.scala: ########## @@ -0,0 +1,371 @@ +/* + * 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.parser + +import scala.collection.mutable + +import org.json4s._ +import org.json4s.jackson.JsonMethods.{compact, parse => parseJson, render} + +import org.apache.spark.{ErrorMessageFormat, SparkThrowable, SparkThrowableHelper} +import org.apache.spark.sql.catalyst.analysis._ +import org.apache.spark.sql.catalyst.expressions._ +import org.apache.spark.sql.catalyst.plans.logical._ +import org.apache.spark.sql.catalyst.trees.{CurrentOrigin, Origin, SQLQueryContext} +import org.apache.spark.sql.exceptions.SqlScriptingException +import org.apache.spark.sql.execution.SparkSqlParser +import org.apache.spark.sql.execution.command.{CreateViewCommand, DescribeQueryCommand, ExplainCommand} +import org.apache.spark.sql.execution.datasources.CreateTempViewUsing + +/** + * Parses a SQL statement string and returns a compact JSON description of the + * unresolved plan (parse-only; no catalog resolution). + * + * Uses a stock [[SparkSqlParser]] (ThreadLocal) so statement coverage matches + * the default production parser (EXPLAIN / SET / ADD JAR / temp views / etc.). + * Session-specific [[org.apache.spark.sql.SparkSessionExtensions]] parser + * wrappers are intentionally not applied: `parse_sql` must evaluate on + * executors without a session, so only the stock parser is available under + * distributed eval. + * + * On success the JSON always includes `parse_success`, the statement + * identifier/code (ISO/IEC 9075-2:2023 Table 39), and omits unused optional + * fields (`table_references`, `function_references`, `select_list`, + * `parameter_markers`) when empty. On parse failure it returns + * `parse_success: false` with source location and a nested STANDARD-format + * error object, and does not throw. Only [[ParseException]] / + * [[SqlScriptingException]] are converted to JSON; unexpected / internal + * failures propagate so the function fails. + */ +object ParseSqlResult { + + private val parser: ThreadLocal[SparkSqlParser] = + ThreadLocal.withInitial(() => new SparkSqlParser()) + + /** Parse `sql` and render the JSON result string. */ + def fromSql(sql: String): String = { + try { + // Do not inherit the outer query's origin from the parse_sql expression. + // Errors and parsed nodes must refer to the SQL string passed to this function. + val origin = if (sql.nonEmpty) { + Origin(startIndex = Some(0), stopIndex = Some(sql.length - 1), sqlText = Some(sql)) + } else { + Origin(sqlText = Some(sql)) + } + CurrentOrigin.withOrigin(origin) { + val plan = parser.get().parsePlan(sql) + fromPlan(plan) + } + } catch { + // User-facing parse / scripting failures become JSON; everything else fails. + case e: ParseException => + errorJson(e) + case e: SqlScriptingException => + errorJson(e) + } + } + + /** Build success JSON from an already-parsed unresolved plan. */ + def fromPlan(plan: LogicalPlan): String = { + val classification = SqlStatementCodes.classify(plan) + val fields = mutable.ListBuffer.empty[JField] + fields += "parse_success" -> JBool(true) + fields += "statement_identifier" -> JString(classification.statementIdentifier) + fields += "statement_code" -> JInt(classification.statementCode) + // Omit unused collections / markers so consumers can treat absence as empty. + val tables = collectTableReferences(plan) + if (tables.nonEmpty) { + fields += "table_references" -> JArray(tables.map(partsToJArray).toList) + } + val functions = collectFunctionReferences(plan) + if (functions.nonEmpty) { + fields += "function_references" -> JArray(functions.map(partsToJArray).toList) + } + val selectList = collectSelectList(plan) + if (selectList.nonEmpty) { + fields += "select_list" -> JArray(selectList.toList) + } + parameterMarkersJson(plan).foreach(markers => fields += "parameter_markers" -> markers) Review Comment: **Non-blocking:** Each input row currently performs four full deep-plan walks: two for tables, one for functions, and one here for parameters. Since this API is intended for batch evaluation, please keep the CTE-name pass and collect tables, functions, and parameters together in one subsequent walk while preserving first-seen order. ########## sql/core/src/main/scala/org/apache/spark/sql/catalyst/parser/ParseSqlResult.scala: ########## @@ -0,0 +1,371 @@ +/* + * 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.parser + +import scala.collection.mutable + +import org.json4s._ +import org.json4s.jackson.JsonMethods.{compact, parse => parseJson, render} + +import org.apache.spark.{ErrorMessageFormat, SparkThrowable, SparkThrowableHelper} +import org.apache.spark.sql.catalyst.analysis._ +import org.apache.spark.sql.catalyst.expressions._ +import org.apache.spark.sql.catalyst.plans.logical._ +import org.apache.spark.sql.catalyst.trees.{CurrentOrigin, Origin, SQLQueryContext} +import org.apache.spark.sql.exceptions.SqlScriptingException +import org.apache.spark.sql.execution.SparkSqlParser +import org.apache.spark.sql.execution.command.{CreateViewCommand, DescribeQueryCommand, ExplainCommand} +import org.apache.spark.sql.execution.datasources.CreateTempViewUsing + +/** + * Parses a SQL statement string and returns a compact JSON description of the + * unresolved plan (parse-only; no catalog resolution). + * + * Uses a stock [[SparkSqlParser]] (ThreadLocal) so statement coverage matches + * the default production parser (EXPLAIN / SET / ADD JAR / temp views / etc.). + * Session-specific [[org.apache.spark.sql.SparkSessionExtensions]] parser + * wrappers are intentionally not applied: `parse_sql` must evaluate on + * executors without a session, so only the stock parser is available under + * distributed eval. + * + * On success the JSON always includes `parse_success`, the statement + * identifier/code (ISO/IEC 9075-2:2023 Table 39), and omits unused optional + * fields (`table_references`, `function_references`, `select_list`, + * `parameter_markers`) when empty. On parse failure it returns + * `parse_success: false` with source location and a nested STANDARD-format + * error object, and does not throw. Only [[ParseException]] / + * [[SqlScriptingException]] are converted to JSON; unexpected / internal + * failures propagate so the function fails. + */ +object ParseSqlResult { + + private val parser: ThreadLocal[SparkSqlParser] = + ThreadLocal.withInitial(() => new SparkSqlParser()) + + /** Parse `sql` and render the JSON result string. */ + def fromSql(sql: String): String = { + try { + // Do not inherit the outer query's origin from the parse_sql expression. + // Errors and parsed nodes must refer to the SQL string passed to this function. + val origin = if (sql.nonEmpty) { + Origin(startIndex = Some(0), stopIndex = Some(sql.length - 1), sqlText = Some(sql)) + } else { + Origin(sqlText = Some(sql)) + } + CurrentOrigin.withOrigin(origin) { + val plan = parser.get().parsePlan(sql) + fromPlan(plan) + } + } catch { + // User-facing parse / scripting failures become JSON; everything else fails. + case e: ParseException => + errorJson(e) + case e: SqlScriptingException => + errorJson(e) + } + } + + /** Build success JSON from an already-parsed unresolved plan. */ + def fromPlan(plan: LogicalPlan): String = { + val classification = SqlStatementCodes.classify(plan) + val fields = mutable.ListBuffer.empty[JField] + fields += "parse_success" -> JBool(true) + fields += "statement_identifier" -> JString(classification.statementIdentifier) + fields += "statement_code" -> JInt(classification.statementCode) + // Omit unused collections / markers so consumers can treat absence as empty. + val tables = collectTableReferences(plan) + if (tables.nonEmpty) { + fields += "table_references" -> JArray(tables.map(partsToJArray).toList) + } + val functions = collectFunctionReferences(plan) + if (functions.nonEmpty) { + fields += "function_references" -> JArray(functions.map(partsToJArray).toList) + } + val selectList = collectSelectList(plan) + if (selectList.nonEmpty) { + fields += "select_list" -> JArray(selectList.toList) + } + parameterMarkersJson(plan).foreach(markers => fields += "parameter_markers" -> markers) + compact(render(JObject(fields.toList))) + } + + private def errorJson(e: SparkThrowable with Throwable): String = { + val errorObj = parseJson( + SparkThrowableHelper.getMessage(e, ErrorMessageFormat.STANDARD)).asInstanceOf[JObject] + val origin = e match { + case p: ParseException => Some(p.start) + case s: SqlScriptingException => Some(s.origin) + case _ => None + } + val locationFields = origin.toSeq.flatMap(originFields) + val contextFields = if (errorObj.obj.exists(_._1 == "queryContext")) { + Nil + } else { + origin.toSeq.flatMap(queryContextField) + } + compact(render(JObject( + "parse_success" -> JBool(false), + "error" -> JObject(errorObj.obj ++ contextFields ++ locationFields) + ))) + } + + private def queryContextField(origin: Origin): Option[JField] = origin.context match { + case context: SQLQueryContext if context.isValid => + Some("queryContext" -> JArray(List(JObject( + "objectType" -> JString(context.objectType), + "objectName" -> JString(context.objectName), + "startIndex" -> JInt(context.startIndex + 1), + "stopIndex" -> JInt(context.stopIndex + 1), + "fragment" -> JString(context.fragment) + )))) + case _ => None + } + + private def originFields(origin: Origin): Seq[JField] = Seq( + origin.line.map(line => "line" -> JInt(line)), + origin.startPosition.map(position => "position" -> JInt(position))).flatten + + private def partsToJArray(parts: Seq[String]): JArray = + JArray(parts.map(JString).toList) + + /** + * Walk expressions in all product fields, including wrappers such as column + * definitions that [[LogicalPlan.expressions]] does not descend into. + */ + private def foreachExpressionDeep(plan: LogicalPlan)(f: Expression => Unit): Unit = { + def visit(value: Any): Unit = value match { + case e: Expression => f(e) + case _: LogicalPlan => + case values: Iterable[_] => values.foreach(visit) + case value: Product => value.productIterator.foreach(visit) + case _ => + } + plan.productIterator.foreach(visit) + } + + /** + * Deep plan walk covering tree slots that standard `collect` / + * `collectWithSubqueries` miss: + * - [[UnresolvedWith]] CTE definitions (`innerChildren`, not `children`) + * - [[InsertIntoStatement]].table (non-child plan slot) + * - [[SingleStatement]].parsedPlan (children expose only nested children) + * - [[CompoundBody]].handlers (not in `children`) + * - [[SimpleCaseStatement]].elseBody (not in `children`) + * Nested expression subqueries are still covered by `foreachWithSubqueries`. + */ + private def foreachPlanDeep(plan: LogicalPlan)(f: LogicalPlan => Unit): Unit = { + plan.foreachWithSubqueries { p => + f(p) + p match { + case w: UnresolvedWith => + w.cteRelations.foreach { case (_, ctePlan, _) => + foreachPlanDeep(ctePlan)(f) + } + case InsertIntoStatement(table, _, _, _, _, _, _, _, _) => + foreachPlanDeep(table)(f) + case s: SingleStatement => + // Root of the wrapped statement is skipped by SingleStatement.children. + foreachPlanDeep(s.parsedPlan)(f) Review Comment: **Blocking:** This re-traverses children that `SingleStatement.children` already exposed to the outer `foreachWithSubqueries` walk. Named markers hide the duplicate visit in a set, but every `PosParameter` increments `unnamedCount`, so `BEGIN SELECT * FROM t WHERE a = ?; END` reports too many markers. Please visit the wrapped root without revisiting its children, and add a scripting test with `?` below the root. ########## sql/core/src/main/scala/org/apache/spark/sql/catalyst/parser/ParseSqlResult.scala: ########## @@ -0,0 +1,371 @@ +/* + * 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.parser + +import scala.collection.mutable + +import org.json4s._ +import org.json4s.jackson.JsonMethods.{compact, parse => parseJson, render} + +import org.apache.spark.{ErrorMessageFormat, SparkThrowable, SparkThrowableHelper} +import org.apache.spark.sql.catalyst.analysis._ +import org.apache.spark.sql.catalyst.expressions._ +import org.apache.spark.sql.catalyst.plans.logical._ +import org.apache.spark.sql.catalyst.trees.{CurrentOrigin, Origin, SQLQueryContext} +import org.apache.spark.sql.exceptions.SqlScriptingException +import org.apache.spark.sql.execution.SparkSqlParser +import org.apache.spark.sql.execution.command.{CreateViewCommand, DescribeQueryCommand, ExplainCommand} +import org.apache.spark.sql.execution.datasources.CreateTempViewUsing + +/** + * Parses a SQL statement string and returns a compact JSON description of the + * unresolved plan (parse-only; no catalog resolution). + * + * Uses a stock [[SparkSqlParser]] (ThreadLocal) so statement coverage matches + * the default production parser (EXPLAIN / SET / ADD JAR / temp views / etc.). + * Session-specific [[org.apache.spark.sql.SparkSessionExtensions]] parser + * wrappers are intentionally not applied: `parse_sql` must evaluate on + * executors without a session, so only the stock parser is available under + * distributed eval. + * + * On success the JSON always includes `parse_success`, the statement + * identifier/code (ISO/IEC 9075-2:2023 Table 39), and omits unused optional + * fields (`table_references`, `function_references`, `select_list`, + * `parameter_markers`) when empty. On parse failure it returns + * `parse_success: false` with source location and a nested STANDARD-format + * error object, and does not throw. Only [[ParseException]] / + * [[SqlScriptingException]] are converted to JSON; unexpected / internal + * failures propagate so the function fails. + */ +object ParseSqlResult { + + private val parser: ThreadLocal[SparkSqlParser] = + ThreadLocal.withInitial(() => new SparkSqlParser()) + + /** Parse `sql` and render the JSON result string. */ + def fromSql(sql: String): String = { + try { + // Do not inherit the outer query's origin from the parse_sql expression. + // Errors and parsed nodes must refer to the SQL string passed to this function. + val origin = if (sql.nonEmpty) { + Origin(startIndex = Some(0), stopIndex = Some(sql.length - 1), sqlText = Some(sql)) + } else { + Origin(sqlText = Some(sql)) + } + CurrentOrigin.withOrigin(origin) { + val plan = parser.get().parsePlan(sql) + fromPlan(plan) + } + } catch { + // User-facing parse / scripting failures become JSON; everything else fails. + case e: ParseException => + errorJson(e) + case e: SqlScriptingException => + errorJson(e) + } + } + + /** Build success JSON from an already-parsed unresolved plan. */ + def fromPlan(plan: LogicalPlan): String = { + val classification = SqlStatementCodes.classify(plan) + val fields = mutable.ListBuffer.empty[JField] + fields += "parse_success" -> JBool(true) + fields += "statement_identifier" -> JString(classification.statementIdentifier) + fields += "statement_code" -> JInt(classification.statementCode) + // Omit unused collections / markers so consumers can treat absence as empty. + val tables = collectTableReferences(plan) + if (tables.nonEmpty) { + fields += "table_references" -> JArray(tables.map(partsToJArray).toList) + } + val functions = collectFunctionReferences(plan) + if (functions.nonEmpty) { + fields += "function_references" -> JArray(functions.map(partsToJArray).toList) + } + val selectList = collectSelectList(plan) + if (selectList.nonEmpty) { + fields += "select_list" -> JArray(selectList.toList) + } + parameterMarkersJson(plan).foreach(markers => fields += "parameter_markers" -> markers) + compact(render(JObject(fields.toList))) + } + + private def errorJson(e: SparkThrowable with Throwable): String = { + val errorObj = parseJson( + SparkThrowableHelper.getMessage(e, ErrorMessageFormat.STANDARD)).asInstanceOf[JObject] + val origin = e match { + case p: ParseException => Some(p.start) + case s: SqlScriptingException => Some(s.origin) + case _ => None + } + val locationFields = origin.toSeq.flatMap(originFields) + val contextFields = if (errorObj.obj.exists(_._1 == "queryContext")) { + Nil + } else { + origin.toSeq.flatMap(queryContextField) + } + compact(render(JObject( + "parse_success" -> JBool(false), + "error" -> JObject(errorObj.obj ++ contextFields ++ locationFields) + ))) + } + + private def queryContextField(origin: Origin): Option[JField] = origin.context match { + case context: SQLQueryContext if context.isValid => + Some("queryContext" -> JArray(List(JObject( + "objectType" -> JString(context.objectType), + "objectName" -> JString(context.objectName), + "startIndex" -> JInt(context.startIndex + 1), + "stopIndex" -> JInt(context.stopIndex + 1), + "fragment" -> JString(context.fragment) + )))) + case _ => None + } + + private def originFields(origin: Origin): Seq[JField] = Seq( + origin.line.map(line => "line" -> JInt(line)), + origin.startPosition.map(position => "position" -> JInt(position))).flatten + + private def partsToJArray(parts: Seq[String]): JArray = + JArray(parts.map(JString).toList) + + /** + * Walk expressions in all product fields, including wrappers such as column + * definitions that [[LogicalPlan.expressions]] does not descend into. + */ + private def foreachExpressionDeep(plan: LogicalPlan)(f: Expression => Unit): Unit = { + def visit(value: Any): Unit = value match { + case e: Expression => f(e) + case _: LogicalPlan => + case values: Iterable[_] => values.foreach(visit) + case value: Product => value.productIterator.foreach(visit) + case _ => + } + plan.productIterator.foreach(visit) + } + + /** + * Deep plan walk covering tree slots that standard `collect` / + * `collectWithSubqueries` miss: + * - [[UnresolvedWith]] CTE definitions (`innerChildren`, not `children`) + * - [[InsertIntoStatement]].table (non-child plan slot) + * - [[SingleStatement]].parsedPlan (children expose only nested children) + * - [[CompoundBody]].handlers (not in `children`) + * - [[SimpleCaseStatement]].elseBody (not in `children`) + * Nested expression subqueries are still covered by `foreachWithSubqueries`. + */ + private def foreachPlanDeep(plan: LogicalPlan)(f: LogicalPlan => Unit): Unit = { + plan.foreachWithSubqueries { p => + f(p) + p match { + case w: UnresolvedWith => + w.cteRelations.foreach { case (_, ctePlan, _) => + foreachPlanDeep(ctePlan)(f) + } + case InsertIntoStatement(table, _, _, _, _, _, _, _, _) => + foreachPlanDeep(table)(f) + case s: SingleStatement => + // Root of the wrapped statement is skipped by SingleStatement.children. + foreachPlanDeep(s.parsedPlan)(f) + case c: CompoundBody => + c.handlers.foreach(h => foreachPlanDeep(h)(f)) + case s: SimpleCaseStatement => + s.elseBody.foreach(b => foreachPlanDeep(b)(f)) + case ExplainCommand(logicalPlan, _) => + foreachPlanDeep(logicalPlan)(f) + case DescribeQueryCommand(_, queryPlan) => + foreachPlanDeep(queryPlan)(f) + case _ => + } + } + } + + /** Multipart name from a table/view-shaped plan node, if any. */ + private def tableOrViewParts(plan: LogicalPlan): Option[Seq[String]] = plan match { + case u: UnresolvedRelation => Some(u.multipartIdentifier) + case u: UnresolvedTable => Some(u.multipartIdentifier) + case u: UnresolvedView => Some(u.multipartIdentifier) + case u: UnresolvedTableOrView => Some(u.multipartIdentifier) + case u: UnresolvedIdentifier => Some(u.nameParts) + case _ => None + } + + private def tableIdentifierParts(id: org.apache.spark.sql.catalyst.TableIdentifier): Seq[String] = + id.catalog.toSeq ++ id.database.toSeq :+ id.table + + /** + * Collect multipart table/view identifiers for lineage (as written in the + * SQL). CTE definition names and correlation aliases are omitted; tables + * referenced inside CTE bodies are still included. Function / variable + * identifiers are not collected. Deduplicates while preserving first-seen + * order. + */ + private def collectTableReferences(plan: LogicalPlan): Seq[Seq[String]] = { + val seen = mutable.LinkedHashSet.empty[Seq[String]] + // CTE names are always single-part in the grammar; UnresolvedRelation refs + // to CTEs are likewise single-part, so filtering matches that shape. + val cteNames = mutable.HashSet.empty[String] + + def addCteNames(w: UnresolvedWith): Unit = { + w.cteRelations.foreach { case (name, _, _) => + cteNames += name.toLowerCase(java.util.Locale.ROOT) + } + } + + def isCteName(parts: Seq[String]): Boolean = parts match { + case Seq(name) => cteNames.contains(name.toLowerCase(java.util.Locale.ROOT)) + case _ => false + } + + def add(parts: Seq[String]): Unit = { + if (parts.nonEmpty && !isCteName(parts)) seen += parts + } + + // First pass: gather CTE names in scope (including nested). + foreachPlanDeep(plan) { + case w: UnresolvedWith => addCteNames(w) + case _ => + } + + foreachPlanDeep(plan) { + case u: UnresolvedRelation => add(u.multipartIdentifier) + case u: UnresolvedTable => add(u.multipartIdentifier) + case u: UnresolvedView => add(u.multipartIdentifier) + case u: UnresolvedTableOrView => add(u.multipartIdentifier) + // Table/view DDL targets only — not CreateFunction / CreateVariable names. Review Comment: **Nit:** The repository guidance requires ASCII punctuation in code comments. ```suggestion // Table/view DDL targets only -- not CreateFunction / CreateVariable names. ``` -- 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]
