Skip to content

Spark 3.4: Create non-existing Tag/Branch when using CREATE OR REPLACE #8086

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
danielcweeks merged 1 commit into from
Jul 20, 2023
Merged

Spark 3.4: Create non-existing Tag/Branch when using CREATE OR REPLACE #8086

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions ...cala/org/apache/spark/sql/catalyst/parser/extensions/IcebergSqlExtensionsAstBuilder.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,7 @@ class IcebergSqlExtensionsAstBuilder(delegate: ParserInterface) extends IcebergS
val branchRetention = branchOptionsContext.flatMap(branchOptions => Option(branchOptions.refRetain()))
val branchRefAgeMs = branchRetention.map(retain =>
TimeUnit.valueOf(retain.timeUnit().getText.toUpperCase(Locale.ENGLISH)).toMillis(retain.number().getText.toLong))
val create = createOrReplaceBranchClause.CREATE() != null
val replace = ctx.createReplaceBranchClause().REPLACE() != null
val ifNotExists = createOrReplaceBranchClause.EXISTS() != null

Expand All @@ -130,6 +131,7 @@ class IcebergSqlExtensionsAstBuilder(delegate: ParserInterface) extends IcebergS
typedVisit[Seq[String]](ctx.multipartIdentifier),
branchName.getText,
branchOptions,
create,
replace,
ifNotExists)
}
Expand All @@ -153,12 +155,14 @@ class IcebergSqlExtensionsAstBuilder(delegate: ParserInterface) extends IcebergS
tagRefAgeMs
)

val create = createTagClause.CREATE() != null
val replace = createTagClause.REPLACE() != null
val ifNotExists = createTagClause.EXISTS() != null

CreateOrReplaceTag(typedVisit[Seq[String]](ctx.multipartIdentifier),
tagName,
tagOptions,
create,
replace,
ifNotExists)
}
Expand Down
1 change: 1 addition & 0 deletions ...ns/src/main/scala/org/apache/spark/sql/catalyst/plans/logical/CreateOrReplaceBranch.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ case class CreateOrReplaceBranch(
table: Seq[String],
branch: String,
branchOptions: BranchOptions,
create: Boolean,
replace: Boolean,
ifNotExists: Boolean) extends LeafCommand {

Expand Down
1 change: 1 addition & 0 deletions ...sions/src/main/scala/org/apache/spark/sql/catalyst/plans/logical/CreateOrReplaceTag.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ case class CreateOrReplaceTag(
table: Seq[String],
tag: String,
tagOptions: TagOptions,
create: Boolean,
replace: Boolean,
ifNotExists: Boolean) extends LeafCommand {

Expand Down
14 changes: 9 additions & 5 deletions .../main/scala/org/apache/spark/sql/execution/datasources/v2/CreateOrReplaceBranchExec.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ case class CreateOrReplaceBranchExec(
ident: Identifier,
branch: String,
branchOptions: BranchOptions,
create: Boolean,
replace: Boolean,
ifNotExists: Boolean) extends LeafV2CommandExec {

Expand All @@ -51,15 +52,18 @@ case class CreateOrReplaceBranchExec(
"Cannot complete create or replace branch operation on %s, main has no snapshot", ident)

val manageSnapshots = iceberg.table().manageSnapshots()
if (!replace) {
val ref = iceberg.table().refs().get(branch)
if (ref != null && ifNotExists) {
val refExists = null != iceberg.table().refs().get(branch)

if (create && replace && !refExists) {
manageSnapshots.createBranch(branch, snapshotId)
} else if (replace) {
manageSnapshots.replaceBranch(branch, snapshotId)
} else {
if (refExists && ifNotExists) {
return Nil
}

manageSnapshots.createBranch(branch, snapshotId)
} else {
manageSnapshots.replaceBranch(branch, snapshotId)
}

if (branchOptions.numSnapshots.nonEmpty) {
Expand Down
14 changes: 9 additions & 5 deletions ...src/main/scala/org/apache/spark/sql/execution/datasources/v2/CreateOrReplaceTagExec.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ case class CreateOrReplaceTagExec(
ident: Identifier,
tag: String,
tagOptions: TagOptions,
create: Boolean,
replace: Boolean,
ifNotExists: Boolean) extends LeafV2CommandExec {

Expand All @@ -50,15 +51,18 @@ case class CreateOrReplaceTagExec(
"Cannot complete create or replace tag operation on %s, main has no snapshot", ident)

val manageSnapshot = iceberg.table.manageSnapshots()
if (!replace) {
val ref = iceberg.table().refs().get(tag)
if (ref != null && ifNotExists) {
val refExists = null != iceberg.table().refs().get(tag)

if (create && replace && !refExists) {
manageSnapshot.createTag(tag, snapshotId)
} else if (replace) {
manageSnapshot.replaceTag(tag, snapshotId)
} else {
if (refExists && ifNotExists) {
return Nil
}

manageSnapshot.createTag(tag, snapshotId)
} else {
manageSnapshot.replaceTag(tag, snapshotId)
}

if (tagOptions.snapshotRefRetain.nonEmpty) {
Expand Down
9 changes: 5 additions & 4 deletions ...in/scala/org/apache/spark/sql/execution/datasources/v2/ExtendedDataSourceV2Strategy.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,11 +63,12 @@ case class ExtendedDataSourceV2Strategy(spark: SparkSession) extends Strategy wi
AddPartitionFieldExec(catalog, ident, transform, name) :: Nil

case CreateOrReplaceBranch(
IcebergCatalogAndIdentifier(catalog, ident), branch, branchOptions, replace, ifNotExists) =>
CreateOrReplaceBranchExec(catalog, ident, branch, branchOptions, replace, ifNotExists) :: Nil
IcebergCatalogAndIdentifier(catalog, ident), branch, branchOptions, create, replace, ifNotExists) =>
CreateOrReplaceBranchExec(catalog, ident, branch, branchOptions, create, replace, ifNotExists) :: Nil

case CreateOrReplaceTag(IcebergCatalogAndIdentifier(catalog, ident), tag, tagOptions, replace, ifNotExists) =>
CreateOrReplaceTagExec(catalog, ident, tag, tagOptions, replace, ifNotExists) :: Nil
case CreateOrReplaceTag(
IcebergCatalogAndIdentifier(catalog, ident), tag, tagOptions, create, replace, ifNotExists) =>
CreateOrReplaceTagExec(catalog, ident, tag, tagOptions, create, replace, ifNotExists) :: Nil

case DropBranch(IcebergCatalogAndIdentifier(catalog, ident), branch, ifExists) =>
DropBranchExec(catalog, ident, branch, ifExists) :: Nil
Expand Down
67 changes: 67 additions & 0 deletions ...3.4/spark-extensions/src/test/java/org/apache/iceberg/spark/extensions/TestBranchDDL.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
*/
package org.apache.iceberg.spark.extensions;

import static org.assertj.core.api.Assertions.assertThat;

import java.util.List;
import java.util.Map;
import java.util.concurrent.TimeUnit;
Expand Down Expand Up @@ -289,4 +291,69 @@ private Table insertRows() throws NoSuchTableException {
df.writeTo(tableName).append();
return validationCatalog.loadTable(tableIdent);
}

@Test
public void createOrReplace() throws NoSuchTableException {
Table table = insertRows();
long first = table.currentSnapshot().snapshotId();
String branchName = "b1";
insertRows();
long second = table.currentSnapshot().snapshotId();
table.manageSnapshots().createBranch(branchName, second).commit();

sql(
"ALTER TABLE %s CREATE OR REPLACE BRANCH %s AS OF VERSION %d",
tableName, branchName, first);
table.refresh();
assertThat(table.refs().get(branchName).snapshotId()).isEqualTo(second);
}

@Test
public void createOrReplaceWithNonExistingBranch() throws NoSuchTableException {
Table table = insertRows();
String branchName = "b1";
insertRows();
long snapshotId = table.currentSnapshot().snapshotId();

sql(
"ALTER TABLE %s CREATE OR REPLACE BRANCH %s AS OF VERSION %d",
tableName, branchName, snapshotId);
table.refresh();
assertThat(table.refs().get(branchName).snapshotId()).isEqualTo(snapshotId);
}

@Test
public void replaceBranch() throws NoSuchTableException {
Copy link
Contributor Author

@nastra nastra Jul 17, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there was a test gap for branches where a pure replace and a replace on a non-existing branch wasn't exercised, therefore I added replaceBranch() / replaceBranchDoesNotExist() / createOrReplace() (similar tests already exist in TestTagDDL)

Table table = insertRows();
long first = table.currentSnapshot().snapshotId();
String branchName = "b1";
long expectedMaxRefAgeMs = 1000;
table
.manageSnapshots()
.createBranch(branchName, first)
.setMaxRefAgeMs(branchName, expectedMaxRefAgeMs)
.commit();

insertRows();
long second = table.currentSnapshot().snapshotId();

sql("ALTER TABLE %s REPLACE BRANCH %s AS OF VERSION %d", tableName, branchName, second);
table.refresh();
SnapshotRef ref = table.refs().get(branchName);
assertThat(ref.snapshotId()).isEqualTo(second);
assertThat(ref.maxRefAgeMs()).isEqualTo(expectedMaxRefAgeMs);
}

@Test
public void replaceBranchDoesNotExist() throws NoSuchTableException {
Table table = insertRows();

Assertions.assertThatThrownBy(
() ->
sql(
"ALTER TABLE %s REPLACE BRANCH %s AS OF VERSION %d",
tableName, "someBranch", table.currentSnapshot().snapshotId()))
.isInstanceOf(IllegalArgumentException.class)
.hasMessage("Branch does not exist: someBranch");
}
}
14 changes: 14 additions & 0 deletions ...k/v3.4/spark-extensions/src/test/java/org/apache/iceberg/spark/extensions/TestTagDDL.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
*/
package org.apache.iceberg.spark.extensions;

import static org.assertj.core.api.Assertions.assertThat;

import java.util.List;
import java.util.Locale;
import java.util.Map;
Expand Down Expand Up @@ -364,6 +366,18 @@ public void testDropTagIfExists() throws NoSuchTableException {
Assert.assertNull("The tag needs to be dropped.", table.refs().get(tagName));
}

@Test
public void createOrReplaceWithNonExistingTag() throws NoSuchTableException {
Table table = insertRows();
String tagName = "t1";
insertRows();
long snapshotId = table.currentSnapshot().snapshotId();

sql("ALTER TABLE %s CREATE OR REPLACE TAG %s AS OF VERSION %d", tableName, tagName, snapshotId);
table.refresh();
assertThat(table.refs().get(tagName).snapshotId()).isEqualTo(snapshotId);
}

private Table insertRows() throws NoSuchTableException {
List<SimpleRecord> records =
ImmutableList.of(new SimpleRecord(1, "a"), new SimpleRecord(2, "b"));
Expand Down