[SPARK-28666] Support saveAsTable for V2 tables through Session Catalog #25402
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| /* | ||
| * 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.sources.v2.internal; | ||
|
|
||
| import org.apache.spark.sql.sources.v2.Table; | ||
|
|
||
| /** | ||
| * Internal interface used for table definitions, which we do not have complete information to | ||
| * resolve yet. This is primarily used by the `CatalogTableAsV2` wrapper returned by the | ||
| * V2SessionCatalog. When a `CatalogTableAsV2` is returned by the V2SessionCatalog, we defer | ||
| * planning to V1 data source code paths. | ||
| */ | ||
| public interface UnresolvedTable extends Table {} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,152 @@ | ||
| /* | ||
| * 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.sources.v2 | ||
|
|
||
| import java.util | ||
| import java.util.concurrent.ConcurrentHashMap | ||
|
|
||
| import scala.collection.JavaConverters._ | ||
|
|
||
| import org.scalatest.BeforeAndAfter | ||
|
|
||
| import org.apache.spark.sql.{DataFrame, QueryTest} | ||
| import org.apache.spark.sql.catalog.v2.Identifier | ||
| import org.apache.spark.sql.catalog.v2.expressions.Transform | ||
| import org.apache.spark.sql.catalyst.analysis.TableAlreadyExistsException | ||
| import org.apache.spark.sql.execution.datasources.v2.V2SessionCatalog | ||
| import org.apache.spark.sql.internal.SQLConf | ||
| import org.apache.spark.sql.test.SharedSQLContext | ||
| import org.apache.spark.sql.types.StructType | ||
| import org.apache.spark.sql.util.CaseInsensitiveStringMap | ||
|
|
||
| class DataSourceV2DataFrameSessionCatalogSuite | ||
| extends QueryTest | ||
| with SharedSQLContext | ||
| with BeforeAndAfter { | ||
| import testImplicits._ | ||
|
|
||
| private val v2Format = classOf[InMemoryTableProvider].getName | ||
|
|
||
| before { | ||
| spark.conf.set(SQLConf.V2_SESSION_CATALOG.key, classOf[TestV2SessionCatalog].getName) | ||
| } | ||
|
|
||
| override def afterEach(): Unit = { | ||
| super.afterEach() | ||
| spark.catalog("session").asInstanceOf[TestV2SessionCatalog].clearTables() | ||
| } | ||
|
|
||
| private def verifyTable(tableName: String, expected: DataFrame): Unit = { | ||
| checkAnswer(spark.table(tableName), expected) | ||
| checkAnswer(sql(s"SELECT * FROM $tableName"), expected) | ||
| checkAnswer(sql(s"TABLE $tableName"), expected) | ||
| } | ||
|
|
||
| test("saveAsTable and v2 table - table doesn't exist") { | ||
| val t1 = "tbl" | ||
| val df = Seq((1L, "a"), (2L, "b"), (3L, "c")).toDF("id", "data") | ||
| df.write.format(v2Format).saveAsTable(t1) | ||
| verifyTable(t1, df) | ||
| } | ||
|
|
||
| test("saveAsTable: v2 table - table exists") { | ||
| val t1 = "tbl" | ||
| val df = Seq((1L, "a"), (2L, "b"), (3L, "c")).toDF("id", "data") | ||
| spark.sql(s"CREATE TABLE $t1 (id bigint, data string) USING $v2Format") | ||
| intercept[TableAlreadyExistsException] { | ||
| df.select("id", "data").write.format(v2Format).saveAsTable(t1) | ||
| } | ||
| df.write.format(v2Format).mode("append").saveAsTable(t1) | ||
| verifyTable(t1, df) | ||
|
|
||
| // Check that appends are by name | ||
| df.select('data, 'id).write.format(v2Format).mode("append").saveAsTable(t1) | ||
|
Contributor
There was a problem hiding this comment. IIRC, in DS v1,
Contributor
Author
There was a problem hiding this comment. Since the provider isn't necessarily exposed by the table API, I'm not sure if such a check is required/possible. |
||
| verifyTable(t1, df.union(df)) | ||
| } | ||
|
|
||
| test("saveAsTable: v2 table - table overwrite and table doesn't exist") { | ||
| val t1 = "tbl" | ||
| val df = Seq((1L, "a"), (2L, "b"), (3L, "c")).toDF("id", "data") | ||
| df.write.format(v2Format).mode("overwrite").saveAsTable(t1) | ||
| verifyTable(t1, df) | ||
| } | ||
|
|
||
| test("saveAsTable: v2 table - table overwrite and table exists") { | ||
| val t1 = "tbl" | ||
| val df = Seq((1L, "a"), (2L, "b"), (3L, "c")).toDF("id", "data") | ||
| spark.sql(s"CREATE TABLE $t1 USING $v2Format AS SELECT 'c', 'd'") | ||
| df.write.format(v2Format).mode("overwrite").saveAsTable(t1) | ||
| verifyTable(t1, df) | ||
| } | ||
|
|
||
| test("saveAsTable: v2 table - ignore mode and table doesn't exist") { | ||
| val t1 = "tbl" | ||
| val df = Seq((1L, "a"), (2L, "b"), (3L, "c")).toDF("id", "data") | ||
| df.write.format(v2Format).mode("ignore").saveAsTable(t1) | ||
| verifyTable(t1, df) | ||
| } | ||
|
|
||
| test("saveAsTable: v2 table - ignore mode and table exists") { | ||
| val t1 = "tbl" | ||
| val df = Seq((1L, "a"), (2L, "b"), (3L, "c")).toDF("id", "data") | ||
| spark.sql(s"CREATE TABLE $t1 USING $v2Format AS SELECT 'c', 'd'") | ||
| df.write.format(v2Format).mode("ignore").saveAsTable(t1) | ||
| verifyTable(t1, Seq(("c", "d")).toDF("id", "data")) | ||
| } | ||
| } | ||
|
|
||
| class InMemoryTableProvider extends TableProvider { | ||
| override def getTable(options: CaseInsensitiveStringMap): Table = { | ||
| throw new UnsupportedOperationException("D'oh!") | ||
| } | ||
| } | ||
|
|
||
| /** A SessionCatalog that always loads an in memory Table, so we can test write code paths. */ | ||
| class TestV2SessionCatalog extends V2SessionCatalog { | ||
|
|
||
| protected val tables: util.Map[Identifier, InMemoryTable] = | ||
| new ConcurrentHashMap[Identifier, InMemoryTable]() | ||
|
|
||
| override def loadTable(ident: Identifier): Table = { | ||
| if (tables.containsKey(ident)) { | ||
| tables.get(ident) | ||
| } else { | ||
| // Table was created through the built-in catalog | ||
| val t = super.loadTable(ident) | ||
| val table = new InMemoryTable(t.name(), t.schema(), t.partitioning(), t.properties()) | ||
| tables.put(ident, table) | ||
| table | ||
| } | ||
| } | ||
|
|
||
| override def createTable( | ||
| ident: Identifier, | ||
| schema: StructType, | ||
| partitions: Array[Transform], | ||
| properties: util.Map[String, String]): Table = { | ||
| val t = new InMemoryTable(ident.name(), schema, partitions, properties) | ||
| tables.put(ident, t) | ||
| t | ||
| } | ||
|
|
||
| def clearTables(): Unit = { | ||
| assert(!tables.isEmpty, "Tables were empty, maybe didn't use the session catalog code path?") | ||
| tables.keySet().asScala.foreach(super.dropTable) | ||
| tables.clear() | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A +1 on this.