Skip to content

[SPARK-52142][SQL] Display table constraints in SHOW CREATE TABLE COMMAND #51541

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

Closed
wants to merge 6 commits into from
Closed

[SPARK-52142][SQL] Display table constraints in SHOW CREATE TABLE COMMAND #51541

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4da8613
show table
gengliangwang Jul 17, 2025
5b14f50
fix
gengliangwang Jul 17, 2025
aaa3f3a
add more test cases; add comment
gengliangwang Jul 17, 2025
35d251f
fix test failures
gengliangwang Jul 18, 2025
916c51c
Merge remote-tracking branch 'upstream/master' into showCreateTable
gengliangwang Jul 18, 2025
8d34efb
fix test failure
gengliangwang Jul 18, 2025
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
5 changes: 3 additions & 2 deletions ...lyst/src/main/java/org/apache/spark/sql/connector/catalog/constraints/BaseConstraint.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,12 +63,13 @@ public boolean rely() {

@Override
public String toDDL() {
// The validation status is not included in the DDL output as it's not part of
// the Spark SQL syntax for constraints.
return String.format(
"CONSTRAINT %s %s %s %s %s",
"CONSTRAINT %s %s %s %s",
name,
definition(),
enforced ? "ENFORCED" : "NOT ENFORCED",
validationStatus,
Copy link
Member Author

@gengliangwang gengliangwang Jul 17, 2025

Choose a reason for hiding this comment

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

cc @aokolnychyi

Copy link
Member

@dongjoon-hyun dongjoon-hyun Jul 17, 2025

Choose a reason for hiding this comment

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

For my understanding, where can we see the status after this, @gengliangwang ?

Copy link
Member Author

@gengliangwang gengliangwang Jul 17, 2025

Choose a reason for hiding this comment

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

No. We have to remove it since the validation status is not supported in the parser.
We can still display it in the "DESC TABLE" command

rely ? "RELY" : "NORELY");
}

Expand Down
30 changes: 20 additions & 10 deletions sql/catalyst/src/test/scala/org/apache/spark/sql/connector/catalog/ConstraintSuite.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ class ConstraintSuite extends SparkFunSuite {
.validationStatus(ValidationStatus.VALID)
.rely(true)
.build()
assert(con1.toDDL == "CONSTRAINT con1 CHECK (id > 10) ENFORCED VALID RELY")
assert(con1.toDDL == "CONSTRAINT con1 CHECK (id > 10) ENFORCED RELY")
assert(con1.validationStatus() == ValidationStatus.VALID)

val con2 = Constraint.check("con2")
.predicate(
Expand All @@ -46,7 +47,8 @@ class ConstraintSuite extends SparkFunSuite {
.validationStatus(ValidationStatus.VALID)
.rely(true)
.build()
assert(con2.toDDL == "CONSTRAINT con2 CHECK (a.`b.c`.d = 1) NOT ENFORCED VALID RELY")
assert(con2.toDDL == "CONSTRAINT con2 CHECK (a.`b.c`.d = 1) NOT ENFORCED RELY")
assert(con2.validationStatus() == ValidationStatus.VALID)

val con3 = Constraint.check("con3")
.predicateSql("a.b.c <=> 1")
Expand All @@ -60,10 +62,12 @@ class ConstraintSuite extends SparkFunSuite {
.validationStatus(ValidationStatus.INVALID)
.rely(false)
.build()
assert(con3.toDDL == "CONSTRAINT con3 CHECK (a.b.c <=> 1) NOT ENFORCED INVALID NORELY")
assert(con3.toDDL == "CONSTRAINT con3 CHECK (a.b.c <=> 1) NOT ENFORCED NORELY")
assert(con3.validationStatus() == ValidationStatus.INVALID)

val con4 = Constraint.check("con4").predicateSql("a = 1").build()
assert(con4.toDDL == "CONSTRAINT con4 CHECK (a = 1) ENFORCED UNVALIDATED NORELY")
assert(con4.toDDL == "CONSTRAINT con4 CHECK (a = 1) ENFORCED NORELY")
assert(con4.validationStatus() == ValidationStatus.UNVALIDATED)
}

test("UNIQUE constraint toDDL") {
Expand All @@ -74,7 +78,8 @@ class ConstraintSuite extends SparkFunSuite {
.validationStatus(ValidationStatus.UNVALIDATED)
.rely(true)
.build()
assert(con1.toDDL == "CONSTRAINT con1 UNIQUE (a.b.c, d) NOT ENFORCED UNVALIDATED RELY")
assert(con1.toDDL == "CONSTRAINT con1 UNIQUE (a.b.c, d) NOT ENFORCED RELY")
assert(con1.validationStatus() == ValidationStatus.UNVALIDATED)

val con2 = Constraint.unique(
"con2",
Expand All @@ -83,7 +88,8 @@ class ConstraintSuite extends SparkFunSuite {
.validationStatus(ValidationStatus.VALID)
.rely(true)
.build()
assert(con2.toDDL == "CONSTRAINT con2 UNIQUE (`a.b`.x.y, d) NOT ENFORCED VALID RELY")
assert(con2.toDDL == "CONSTRAINT con2 UNIQUE (`a.b`.x.y, d) NOT ENFORCED RELY")
assert(con2.validationStatus() == ValidationStatus.VALID)
}

test("PRIMARY KEY constraint toDDL") {
Expand All @@ -94,7 +100,8 @@ class ConstraintSuite extends SparkFunSuite {
.validationStatus(ValidationStatus.VALID)
.rely(true)
.build()
assert(pk1.toDDL == "CONSTRAINT pk1 PRIMARY KEY (a.b.c, d) ENFORCED VALID RELY")
assert(pk1.toDDL == "CONSTRAINT pk1 PRIMARY KEY (a.b.c, d) ENFORCED RELY")
assert(pk1.validationStatus() == ValidationStatus.VALID)

val pk2 = Constraint.primaryKey(
"pk2",
Expand All @@ -103,7 +110,8 @@ class ConstraintSuite extends SparkFunSuite {
.validationStatus(ValidationStatus.INVALID)
.rely(false)
.build()
assert(pk2.toDDL == "CONSTRAINT pk2 PRIMARY KEY (`x.y`.z, id) NOT ENFORCED INVALID NORELY")
assert(pk2.toDDL == "CONSTRAINT pk2 PRIMARY KEY (`x.y`.z, id) NOT ENFORCED NORELY")
assert(pk2.validationStatus() == ValidationStatus.INVALID)
}

test("FOREIGN KEY constraint toDDL") {
Expand All @@ -118,7 +126,8 @@ class ConstraintSuite extends SparkFunSuite {
.build()
assert(fk1.toDDL == "CONSTRAINT fk1 FOREIGN KEY (col1, col2) " +
"REFERENCES schema.table (ref_col1, ref_col2) " +
"ENFORCED VALID RELY")
"ENFORCED RELY")
assert(fk1.validationStatus() == ValidationStatus.VALID)

val fk2 = Constraint.foreignKey(
"fk2",
Expand All @@ -131,6 +140,7 @@ class ConstraintSuite extends SparkFunSuite {
.build()
assert(fk2.toDDL == "CONSTRAINT fk2 FOREIGN KEY (`x.y`.z) " +
"REFERENCES other_table (other_id) " +
"NOT ENFORCED INVALID NORELY")
"NOT ENFORCED NORELY")
assert(fk2.validationStatus() == ValidationStatus.INVALID)
}
}
3 changes: 2 additions & 1 deletion ...re/src/main/scala/org/apache/spark/sql/execution/datasources/v2/ShowCreateTableExec.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,8 @@ case class ShowCreateTableExec(
private def showTableDataColumns(table: Table, builder: StringBuilder): Unit = {
import org.apache.spark.sql.connector.catalog.CatalogV2Implicits._
val columns = CharVarcharUtils.getRawSchema(table.columns.asSchema, conf).fields.map(_.toDDL)
builder ++= concatByMultiLines(columns)
val constraints = table.constraints().map(_.toDDL)
builder ++= concatByMultiLines(columns ++ constraints)
}

private def showTableUsing(table: Table, builder: StringBuilder): Unit = {
Expand Down
24 changes: 12 additions & 12 deletions sql/core/src/test/scala/org/apache/spark/sql/execution/command/v2/CheckConstraintSuite.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,20 +134,20 @@ class CheckConstraintSuite extends QueryTest with CommandSuiteBase with DDLComma
val constraint = getCheckConstraint(table)
assert(constraint.name() == "c1")
assert(constraint.toDDL ==
"CONSTRAINT c1 CHECK (from_json(j, 'a INT').a > 1) ENFORCED VALID NORELY")
"CONSTRAINT c1 CHECK (from_json(j, 'a INT').a > 1) ENFORCED NORELY")
assert(constraint.predicateSql() == "from_json(j, 'a INT').a > 1")
assert(constraint.predicate() == null)
}
}

def getConstraintCharacteristics(): Seq[(String, String)] = {
Seq(
("", s"ENFORCED VALID NORELY"),
("NORELY", s"ENFORCED VALID NORELY"),
("RELY", s"ENFORCED VALID RELY"),
("ENFORCED", s"ENFORCED VALID NORELY"),
("ENFORCED NORELY", s"ENFORCED VALID NORELY"),
("ENFORCED RELY", s"ENFORCED VALID RELY")
("", s"ENFORCED NORELY"),
("NORELY", s"ENFORCED NORELY"),
("RELY", s"ENFORCED RELY"),
("ENFORCED", s"ENFORCED NORELY"),
("ENFORCED NORELY", s"ENFORCED NORELY"),
("ENFORCED RELY", s"ENFORCED RELY")
)
}

Expand Down Expand Up @@ -176,7 +176,7 @@ class CheckConstraintSuite extends QueryTest with CommandSuiteBase with DDLComma
val constraint = getCheckConstraint(table)
assert(constraint.name() == "c1")
assert(constraint.toDDL ==
s"CONSTRAINT c1 CHECK (LENGTH(name) > 0) ENFORCED VALID NORELY")
s"CONSTRAINT c1 CHECK (LENGTH(name) > 0) ENFORCED NORELY")
assert(constraint.predicateSql() == "LENGTH(name) > 0")
}
}
Expand Down Expand Up @@ -258,7 +258,7 @@ class CheckConstraintSuite extends QueryTest with CommandSuiteBase with DDLComma
val constraint = getCheckConstraint(table)
assert(constraint.name() == "valid_positive_num")
assert(constraint.toDDL ==
"CONSTRAINT valid_positive_num CHECK (s.num >= -1) ENFORCED VALID NORELY")
"CONSTRAINT valid_positive_num CHECK (s.num >= -1) ENFORCED NORELY")
}
}

Expand Down Expand Up @@ -288,7 +288,7 @@ class CheckConstraintSuite extends QueryTest with CommandSuiteBase with DDLComma
val constraint = getCheckConstraint(table)
assert(constraint.name() == "valid_map_val")
assert(constraint.toDDL ==
"CONSTRAINT valid_map_val CHECK (m['a'] >= -1) ENFORCED VALID NORELY")
"CONSTRAINT valid_map_val CHECK (m['a'] >= -1) ENFORCED NORELY")
}
}

Expand Down Expand Up @@ -316,7 +316,7 @@ class CheckConstraintSuite extends QueryTest with CommandSuiteBase with DDLComma
val constraint = getCheckConstraint(table)
assert(constraint.name() == "valid_array")
assert(constraint.toDDL ==
"CONSTRAINT valid_array CHECK (a[1] >= -2) ENFORCED VALID NORELY")
"CONSTRAINT valid_array CHECK (a[1] >= -2) ENFORCED NORELY")
}
}

Expand All @@ -336,7 +336,7 @@ class CheckConstraintSuite extends QueryTest with CommandSuiteBase with DDLComma
condition = "CONSTRAINT_ALREADY_EXISTS",
sqlState = "42710",
parameters = Map("constraintName" -> "abc",
"oldConstraint" -> "CONSTRAINT abc CHECK (id > 0) ENFORCED VALID NORELY")
"oldConstraint" -> "CONSTRAINT abc CHECK (id > 0) ENFORCED NORELY")
)
}
}
Expand Down
16 changes: 8 additions & 8 deletions .../src/test/scala/org/apache/spark/sql/execution/command/v2/ForeignKeyConstraintSuite.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ class ForeignKeyConstraintSuite extends QueryTest with CommandSuiteBase with DDL
override protected def command: String = "FOREIGN KEY CONSTRAINT"

private val validConstraintCharacteristics = Seq(
("", "NOT ENFORCED UNVALIDATED NORELY"),
("NOT ENFORCED", "NOT ENFORCED UNVALIDATED NORELY"),
("NOT ENFORCED NORELY", "NOT ENFORCED UNVALIDATED NORELY"),
("NORELY NOT ENFORCED", "NOT ENFORCED UNVALIDATED NORELY"),
("NORELY", "NOT ENFORCED UNVALIDATED NORELY"),
("RELY", "NOT ENFORCED UNVALIDATED RELY")
("", "NOT ENFORCED NORELY"),
("NOT ENFORCED", "NOT ENFORCED NORELY"),
("NOT ENFORCED NORELY", "NOT ENFORCED NORELY"),
("NORELY NOT ENFORCED", "NOT ENFORCED NORELY"),
("NORELY", "NOT ENFORCED NORELY"),
("RELY", "NOT ENFORCED RELY")
)

test("Add foreign key constraint") {
Expand Down Expand Up @@ -104,7 +104,7 @@ class ForeignKeyConstraintSuite extends QueryTest with CommandSuiteBase with DDL
parameters = Map("constraintName" -> "fk1",
"oldConstraint" ->
("CONSTRAINT fk1 FOREIGN KEY (fk) " +
"REFERENCES test_catalog.ns.tbl_ref (id) NOT ENFORCED UNVALIDATED NORELY"))
"REFERENCES test_catalog.ns.tbl_ref (id) NOT ENFORCED NORELY"))
)
}
}
Expand All @@ -124,7 +124,7 @@ class ForeignKeyConstraintSuite extends QueryTest with CommandSuiteBase with DDL
assert(constraint.name() == "fk1")
assert(constraint.toDDL ==
s"CONSTRAINT fk1 FOREIGN KEY (fk1, fk2) " +
s"REFERENCES test_catalog.ns.tbl_ref (id1, id2) NOT ENFORCED UNVALIDATED NORELY")
s"REFERENCES test_catalog.ns.tbl_ref (id1, id2) NOT ENFORCED NORELY")
}
}
}
16 changes: 8 additions & 8 deletions .../src/test/scala/org/apache/spark/sql/execution/command/v2/PrimaryKeyConstraintSuite.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ class PrimaryKeyConstraintSuite extends QueryTest with CommandSuiteBase with DDL
override protected def command: String = "PRIMARY KEY CONSTRAINT"

private val validConstraintCharacteristics = Seq(
("", "NOT ENFORCED UNVALIDATED NORELY"),
("NOT ENFORCED", "NOT ENFORCED UNVALIDATED NORELY"),
("NOT ENFORCED NORELY", "NOT ENFORCED UNVALIDATED NORELY"),
("NORELY NOT ENFORCED", "NOT ENFORCED UNVALIDATED NORELY"),
("NORELY", "NOT ENFORCED UNVALIDATED NORELY"),
("RELY", "NOT ENFORCED UNVALIDATED RELY")
("", "NOT ENFORCED NORELY"),
("NOT ENFORCED", "NOT ENFORCED NORELY"),
("NOT ENFORCED NORELY", "NOT ENFORCED NORELY"),
("NORELY NOT ENFORCED", "NOT ENFORCED NORELY"),
("NORELY", "NOT ENFORCED NORELY"),
("RELY", "NOT ENFORCED RELY")
)

test("Add primary key constraint") {
Expand Down Expand Up @@ -92,7 +92,7 @@ class PrimaryKeyConstraintSuite extends QueryTest with CommandSuiteBase with DDL
condition = "CONSTRAINT_ALREADY_EXISTS",
sqlState = "42710",
parameters = Map("constraintName" -> "pk1",
"oldConstraint" -> "CONSTRAINT pk1 PRIMARY KEY (id) NOT ENFORCED UNVALIDATED NORELY")
"oldConstraint" -> "CONSTRAINT pk1 PRIMARY KEY (id) NOT ENFORCED NORELY")
)
}
}
Expand All @@ -109,7 +109,7 @@ class PrimaryKeyConstraintSuite extends QueryTest with CommandSuiteBase with DDL
val constraint = table.constraints.head
assert(constraint.name() == "pk1")
assert(constraint.toDDL ==
"CONSTRAINT pk1 PRIMARY KEY (id1, id2) NOT ENFORCED UNVALIDATED NORELY")
"CONSTRAINT pk1 PRIMARY KEY (id1, id2) NOT ENFORCED NORELY")
}
}
}
56 changes: 56 additions & 0 deletions sql/core/src/test/scala/org/apache/spark/sql/execution/command/v2/ShowCreateTableSuite.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,4 +181,60 @@ class ShowCreateTableSuite extends command.ShowCreateTableSuiteBase with Command
)
}
}

test("show table constraints") {
withNamespaceAndTable("ns", "tbl", nonPartitionCatalog) { t =>
withTable("other_table") {
sql(
s"""
|CREATE TABLE other_table (
| id STRING PRIMARY KEY
|)
|USING parquet
""".stripMargin)
sql(
s"""
|CREATE TABLE $t (
| a INT,
| b STRING,
| c STRING,
| PRIMARY KEY (a),
| CONSTRAINT uk_b UNIQUE (b),
| CONSTRAINT fk_c FOREIGN KEY (c) REFERENCES other_table(id) RELY,
| CONSTRAINT c1 CHECK (c IS NOT NULL),
| CONSTRAINT c2 CHECK (a > 0)
|)
|$defaultUsing
""".stripMargin)
var showDDL = getShowCreateDDL(t)
val expectedDDLPrefix = Array(
s"CREATE TABLE $nonPartitionCatalog.ns.tbl (",
"a INT NOT NULL,",
"b STRING,",
"c STRING,",
"CONSTRAINT tbl_pk PRIMARY KEY (a) NOT ENFORCED NORELY,",
"CONSTRAINT uk_b UNIQUE (b) NOT ENFORCED NORELY,",
"CONSTRAINT fk_c FOREIGN KEY (c) REFERENCES other_table (id) NOT ENFORCED RELY,",
"CONSTRAINT c1 CHECK (c IS NOT NULL) ENFORCED NORELY,"
)
assert(showDDL === expectedDDLPrefix ++ Array(
"CONSTRAINT c2 CHECK (a > 0) ENFORCED NORELY)",
defaultUsing))

sql(s"ALTER TABLE $t ADD CONSTRAINT c3 CHECK (b IS NOT NULL) ENFORCED RELY")
showDDL = getShowCreateDDL(t)
val expectedDDLArrayWithNewConstraint = expectedDDLPrefix ++ Array(
"CONSTRAINT c2 CHECK (a > 0) ENFORCED NORELY,",
"CONSTRAINT c3 CHECK (b IS NOT NULL) ENFORCED RELY)",
defaultUsing
)
assert(showDDL === expectedDDLArrayWithNewConstraint)
sql(s"ALTER TABLE $t DROP CONSTRAINT c1")
showDDL = getShowCreateDDL(t)
val expectedDDLArrayAfterDrop = expectedDDLArrayWithNewConstraint.filterNot(
_.contains("c1 CHECK (c IS NOT NULL) ENFORCED NORELY"))
assert(showDDL === expectedDDLArrayAfterDrop)
}
}
}
}
16 changes: 8 additions & 8 deletions ...core/src/test/scala/org/apache/spark/sql/execution/command/v2/UniqueConstraintSuite.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ class UniqueConstraintSuite extends QueryTest with CommandSuiteBase with DDLComm
override protected def command: String = "UNIQUE CONSTRAINT"

private val validConstraintCharacteristics = Seq(
("", "NOT ENFORCED UNVALIDATED NORELY"),
("NOT ENFORCED", "NOT ENFORCED UNVALIDATED NORELY"),
("NOT ENFORCED NORELY", "NOT ENFORCED UNVALIDATED NORELY"),
("NORELY NOT ENFORCED", "NOT ENFORCED UNVALIDATED NORELY"),
("NORELY", "NOT ENFORCED UNVALIDATED NORELY"),
("RELY", "NOT ENFORCED UNVALIDATED RELY")
("", "NOT ENFORCED NORELY"),
("NOT ENFORCED", "NOT ENFORCED NORELY"),
("NOT ENFORCED NORELY", "NOT ENFORCED NORELY"),
("NORELY NOT ENFORCED", "NOT ENFORCED NORELY"),
("NORELY", "NOT ENFORCED NORELY"),
("RELY", "NOT ENFORCED RELY")
)

test("Add unique constraint") {
Expand Down Expand Up @@ -92,7 +92,7 @@ class UniqueConstraintSuite extends QueryTest with CommandSuiteBase with DDLComm
condition = "CONSTRAINT_ALREADY_EXISTS",
sqlState = "42710",
parameters = Map("constraintName" -> "uk1",
"oldConstraint" -> "CONSTRAINT uk1 UNIQUE (id) NOT ENFORCED UNVALIDATED NORELY")
"oldConstraint" -> "CONSTRAINT uk1 UNIQUE (id) NOT ENFORCED NORELY")
)
}
}
Expand All @@ -109,7 +109,7 @@ class UniqueConstraintSuite extends QueryTest with CommandSuiteBase with DDLComm
val constraint = table.constraints.head
assert(constraint.name() == "uk1")
assert(constraint.toDDL ==
"CONSTRAINT uk1 UNIQUE (id1, id2) NOT ENFORCED UNVALIDATED NORELY")
"CONSTRAINT uk1 UNIQUE (id1, id2) NOT ENFORCED NORELY")
}
}
}