cloud-fan commented on code in PR #52334: URL: https://github.com/apache/spark/pull/52334#discussion_r2375139431
########## sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/parser/ParameterHandler.scala: ########## @@ -0,0 +1,350 @@ +/* + * 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 org.apache.spark.sql.catalyst.expressions.{Expression, Literal} +import org.apache.spark.sql.catalyst.trees.SQLQueryContext +import org.apache.spark.sql.catalyst.util.LiteralToSqlConverter + +/** + * Handler for parameter substitution across different Spark SQL contexts. + * + * This class consolidates the common parameter handling logic used by SparkSqlParser, + * SparkConnectPlanner, and ExecuteImmediate. It provides a single, consistent API + * for all parameter substitution operations in Spark SQL. + * + * Key features: + * - Automatic parameter type detection (named vs positional) + * - Automatic substitution rule selection (Statement vs CompoundOrSingleStatement) + * - Consistent error handling and validation + * - Support for complex data types (arrays, maps, nested structures) + * - Thread-safe operations + * + * The handler uses the Strategy pattern internally to delegate to appropriate + * parameter substitution strategies based on the parameter types detected in the SQL. + * + * @example Basic usage: + * {{{ + * val handler = new ParameterHandler() + * val context = NamedParameterContext(Map("param1" -> Literal(42))) + * val result = handler.substituteParameters("SELECT :param1", context) + * // result: "SELECT 42" + * }}} + * + * @example Automatic rule detection: + * {{{ + * val handler = new ParameterHandler() + * val context = NamedParameterContext(Map("param1" -> Literal(42))) + * + * // Regular statement + * val result1 = handler.substituteParametersWithAutoRule("SELECT :param1", context) + * + * // SQL scripting block - automatically uses CompoundOrSingleStatement rule + * val result2 = handler.substituteParametersWithAutoRule("BEGIN SELECT :param1; END", context) + * }}} + * + * @see [[SubstituteParamsParser]] for the underlying parameter substitution logic + * @since 4.0.0 + */ +class ParameterHandler { + + + // Thread-local storage for position mapper to ensure thread safety + private val positionMapperStorage = new ThreadLocal[Option[PositionMapper]]() { + override def initialValue(): Option[PositionMapper] = None + } + + /** + * Get the current position mapper for translating error positions. + * This mapper can translate positions from substituted text back to original text. + * + * @return The current position mapper, if available + */ + def getPositionMapper: Option[PositionMapper] = positionMapperStorage.get() + + /** + * Helper method to perform parameter substitution and store position mapper. + * + * @param sqlText The SQL text containing parameter markers + * @param rule The substitution rule to use + * @param namedParams Optional named parameters map + * @param positionalParams Optional positional parameters list + * @return The SQL text with parameters substituted + */ + private def performSubstitution( + sqlText: String, + rule: SubstitutionRule, Review Comment: are we going to extend it in the future, or a boolean `isScript` flag is sufficient? -- 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: reviews-unsubscr...@spark.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org For additional commands, e-mail: reviews-h...@spark.apache.org
