cloud-fan commented on code in PR #52334: URL: https://github.com/apache/spark/pull/52334#discussion_r2435982265
########## sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/parser/ParameterHandler.scala: ########## @@ -0,0 +1,229 @@ +/* + * 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} + +/** + * Handler for parameter substitution across different Spark SQL contexts. + * + * This object 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) + * - Uses CompoundOrSingleStatement parsing for all SQL constructs + * - Consistent error handling and validation + * - Support for complex data types (arrays, maps, nested structures) + * - Thread-safe operations with position-aware error context + * + * The handler integrates with the parser through callback mechanisms stored in + * CurrentOrigin to ensure error positions are correctly mapped back to the original SQL text. + * + * @example Basic usage: + * {{{ + * val context = NamedParameterContext(Map("param1" -> Literal(42))) + * val result = ParameterHandler.substituteParameters("SELECT :param1", context) + * // result: "SELECT 42" + * }}} + * + * @see [[SubstituteParamsParser]] for the underlying parameter substitution logic + */ +object ParameterHandler { + + // Compiled regex pattern for efficient parameter marker detection. + private val parameterMarkerPattern = java.util.regex.Pattern.compile("[?:]") + + /** + * Performs parameter substitution and returns both the substituted SQL and the position mapper. + * The position mapper enables accurate error reporting by mapping positions in the + * substituted SQL back to the original SQL text. + * + * @param sqlText The SQL text containing parameter markers + * @param namedParams Optional named parameters map + * @param positionalParams Optional positional parameters list + * @return A tuple of (substituted SQL, optional position mapper) + */ + private def performSubstitution( + sqlText: String, + namedParams: Map[String, String] = Map.empty, + positionalParams: List[String] = List.empty): (String, Option[PositionMapper]) = { Review Comment: why `Option[PositionMapper]`? we always return a `Some` -- 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]
