anishshri-db commented on code in PR #43425: URL: https://github.com/apache/spark/pull/43425#discussion_r1376943396
########## sql/core/src/main/scala/org/apache/spark/sql/execution/datasources/v2/state/StateTable.scala: ########## @@ -0,0 +1,100 @@ +/* + * 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.execution.datasources.v2.state + +import java.util + +import scala.jdk.CollectionConverters._ + +import org.apache.spark.sql.SparkSession +import org.apache.spark.sql.connector.catalog.{MetadataColumn, SupportsMetadataColumns, SupportsRead, Table, TableCapability} +import org.apache.spark.sql.connector.read.ScanBuilder +import org.apache.spark.sql.execution.datasources.v2.state.StateDataSource.{JoinSideValues, StateSourceOptions} +import org.apache.spark.sql.execution.datasources.v2.state.utils.SchemaUtil +import org.apache.spark.sql.execution.streaming.state.StateStoreConf +import org.apache.spark.sql.types.{DataType, IntegerType, StructType} +import org.apache.spark.sql.util.CaseInsensitiveStringMap + +/** An implementation of [[Table]] with [[SupportsRead]] for State Store data source. */ +class StateTable( + session: SparkSession, + override val schema: StructType, + sourceOptions: StateSourceOptions, + stateConf: StateStoreConf) + extends Table with SupportsRead with SupportsMetadataColumns { + + import StateTable._ + + if (!isValidSchema(schema)) { + throw new IllegalStateException(s"Invalid schema is provided. Provided schema: $schema for " + + s"checkpoint location: ${sourceOptions.stateCheckpointLocation} , operatorId: " + + s"${sourceOptions.operatorId} , storeName: ${sourceOptions.storeName}, " + + s"joinSide: ${sourceOptions.joinSide}") + } + + override def name(): String = { + val desc = s"StateTable " + + s"[stateCkptLocation=${sourceOptions.stateCheckpointLocation}]" + + s"[batchId=${sourceOptions.batchId}][operatorId=${sourceOptions.operatorId}]" + + s"[storeName=${sourceOptions.storeName}]" + + if (sourceOptions.joinSide != JoinSideValues.none) { + desc + s"[joinSide=${sourceOptions.joinSide}]" + } else { + desc + } + } + + override def capabilities(): util.Set[TableCapability] = CAPABILITY + + override def newScanBuilder(options: CaseInsensitiveStringMap): ScanBuilder = + new StateScanBuilder(session, schema, sourceOptions, stateConf) + + override def properties(): util.Map[String, String] = Map.empty[String, String].asJava + + private def isValidSchema(schema: StructType): Boolean = { + if (schema.fieldNames.toSeq != Seq("key", "value")) { + false + } else if (!SchemaUtil.getSchemaAsDataType(schema, "key").isInstanceOf[StructType]) { + false + } else if (!SchemaUtil.getSchemaAsDataType(schema, "value").isInstanceOf[StructType]) { + false + } else { + true + } + } + + override def metadataColumns(): Array[MetadataColumn] = METADATA_COLUMNS.toArray +} + +object StateTable { Review Comment: Maybe add a 1-2 line comment describing how/where this is used ? -- 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
