anew commented on code in PR #56686: URL: https://github.com/apache/spark/pull/56686#discussion_r3553016187
########## sql/pipelines/src/main/scala/org/apache/spark/sql/pipelines/graph/AutoCdcAuxiliaryTable.scala: ########## @@ -0,0 +1,331 @@ +/* + * 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.pipelines.graph + +import scala.util.control.NonFatal + +import org.json4s.JsonAST.{JArray, JString} +import org.json4s.jackson.JsonMethods.{compact, parse} + +import org.apache.spark.SparkException +import org.apache.spark.sql.AnalysisException +import org.apache.spark.sql.catalyst.TableIdentifier +import org.apache.spark.sql.catalyst.analysis.Resolver +import org.apache.spark.sql.connector.catalog.{CatalogV2Util, Table => CatalogTable, TableCatalog} +import org.apache.spark.sql.pipelines.autocdc.{AutoCdcReservedNames, ScdType} +import org.apache.spark.sql.types.{StructField, StructType} + +/** + * Helpers to construct and validate an AutoCDC flow's auxiliary table within the context of a + * dataflow graph. + */ +object AutoCdcAuxiliaryTable { + /** + * Helper for deriving the auxiliary AutoCDC catalog table identifier from a target table. If a + * table exists with a name matching the name derived here, it is assumed to be an AutoCDC + * auxiliary table that should be managed by the pipeline. + */ + def identifier(destination: TableIdentifier): TableIdentifier = TableIdentifier( + table = s"${AutoCdcReservedNames.prefix}aux_state_${destination.table}", + database = destination.database, + catalog = destination.catalog + ) + + /** + * Reserved table property key set on the auxiliary table to record which SCD strategy it + * serves. + */ + val scdTypePropertyKey: String = s"${PipelinesTableProperties.pipelinesPrefix}autocdc.scdType" + + /** + * Table property recording the auxiliary table's unquoted AutoCDC key column names as a JSON + * string array (e.g. `["id","region"]`). Written once when the auxiliary table is created and is + * considered immutable; full-refresh is the only way to change it. + */ + val keyColumnNamesProperty: String = + s"${PipelinesTableProperties.pipelinesPrefix}autocdc.keyColumnNames" + + /** + * Serialize key column names to the JSON form stored at [[keyColumnNamesProperty]]. + * Round-trips an empty list as `[]`; callers are expected to enforce a non-empty key set + * upstream. + */ + def serializeKeyColumnNames(names: Seq[String]): String = { + compact(JArray(names.map(JString(_)).toList)) + } + + /** + * Parse a [[keyColumnNamesProperty]] value. `None` if it is not a JSON array of strings. + * Round-trips an empty list as `[]`; callers are expected to enforce a non-empty key set + * upstream. + */ + def parseKeyColumnNames(raw: String): Option[Seq[String]] = { + val parsed = try Some(parse(raw)) catch { case NonFatal(_) => None } Review Comment: never mind, the caller throws the error if this returns None. -- 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]
