You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by "imback82 (via GitHub)" <gi...@apache.org> on 2024/02/10 00:36:09 UTC
[PR] [SPARK-45789] Support DESCRIBE TABLE for clustering columns [spark]
imback82 opened a new pull request, #45077:
URL: https://github.com/apache/spark/pull/45077
<!--
Thanks for sending a pull request! Here are some tips for you:
1. If this is your first time, please read our contributor guidelines: https://spark.apache.org/contributing.html
2. Ensure you have added or run the appropriate tests for your PR: https://spark.apache.org/developer-tools.html
3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][SPARK-XXXX] Your PR title ...'.
4. Be sure to keep the PR description updated to reflect all changes.
5. Please write your PR title to summarize what this PR proposes.
6. If possible, provide a concise example to reproduce the issue for a faster review.
7. If you want to add a new configuration, please read the guideline first for naming configurations in
'core/src/main/scala/org/apache/spark/internal/config/ConfigEntry.scala'.
8. If you want to add or modify an error type or message, please read the guideline first in
'common/utils/src/main/resources/error/README.md'.
-->
### What changes were proposed in this pull request?
This PR proposes to add clustering column info as the output of `DESCRIBE TABLE`.
### Why are the changes needed?
<!--
Please clarify why the changes are needed. For instance,
1. If you propose a new API, clarify the use case for a new API.
2. If you fix a bug, you can clarify why it is a bug.
-->
Currently, it's not easy to retrieve clustering column info; you can do it via catalog APIs.
### Does this PR introduce _any_ user-facing change?
<!--
Note that it means *any* user-facing change including all aspects such as the documentation fix.
If yes, please clarify the previous behavior and the change this PR proposes - provide the console output, description and/or an example to show the behavior difference if possible.
If possible, please also clarify if this is a user-facing change compared to the released Spark versions or within the unreleased branches such as master.
If no, write 'No'.
-->
Yes. Now, when you run `DESCRIBE TABLE` on clustered tables, you will see the "Clustering Information" as follows:
```
CREATE TABLE tbl (col1 STRING, col2 INT) using parquet CLUSTER BY (col1, col2);
DESC tbl;
+------------------------+---------+-------+
|col_name |data_type|comment|
+------------------------+---------+-------+
|col1 |string |NULL |
|col2 |int |NULL |
|# Clustering Information| | |
|# col_name |data_type|comment|
|col1 |string |NULL |
|col2 |int |NULL |
+------------------------+---------+-------+
```
### How was this patch tested?
<!--
If tests were added, say they were added here. Please make sure to add some test cases that check the changes thoroughly including negative and positive cases if possible.
If it was tested in a way different from regular unit tests, please clarify how you tested step by step, ideally copy and paste-able, so that other reviewers can test and check, and descendants can verify in the future.
If tests were not added, please describe why they were not added and/or why it was difficult to add.
If benchmark tests were added, please run the benchmarks in GitHub Actions for the consistent environment, and the instructions could accord to: https://spark.apache.org/developer-tools.html#github-workflow-benchmarks.
-->
Added new unit tests.
### Was this patch authored or co-authored using generative AI tooling?
<!--
If generative AI tooling has been used in the process of authoring this patch, please include the
phrase: 'Generated-by: ' followed by the name of the tool and its version.
If no, write 'No'.
Please refer to the [ASF Generative Tooling Guidance](https://www.apache.org/legal/generative-tooling.html) for details.
-->
No
--
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-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-45789] Support DESCRIBE TABLE for clustering columns [spark]
Posted by "imback82 (via GitHub)" <gi...@apache.org>.
imback82 commented on PR #45077:
URL: https://github.com/apache/spark/pull/45077#issuecomment-1936775250
cc @cloud-fan
--
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-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-45789][SQL] Support DESCRIBE TABLE for clustering columns [spark]
Posted by "imback82 (via GitHub)" <gi...@apache.org>.
imback82 commented on code in PR #45077:
URL: https://github.com/apache/spark/pull/45077#discussion_r1495160039
##########
sql/core/src/test/scala/org/apache/spark/sql/execution/command/DescribeTableSuiteBase.scala:
##########
@@ -178,4 +178,43 @@ trait DescribeTableSuiteBase extends QueryTest with DDLCommandTestUtils {
assert(errMsg === "DESC TABLE COLUMN does not support nested column: col.x.")
}
}
+
+ test("describe a clustered table") {
+ withNamespaceAndTable("ns", "tbl") { tbl =>
+ sql(s"CREATE TABLE $tbl (col1 STRING, col2 INT) $defaultUsing CLUSTER BY (col1, col2)")
+ val descriptionDf = sql(s"DESC $tbl")
+ assert(descriptionDf.schema.map(field => (field.name, field.dataType)) === Seq(
+ ("col_name", StringType),
+ ("data_type", StringType),
+ ("comment", StringType)))
+ QueryTest.checkAnswer(
+ descriptionDf,
+ Seq(
+ Row("col1", "string", null),
+ Row("col2", "int", null),
+ Row("# Clustering Information", "", ""),
+ Row("# col_name", "data_type", "comment"),
+ Row("col1", "string", null),
+ Row("col2", "int", null)))
+ }
+ }
+
+ test("describe a clustered table with comments on clustering columns") {
+ withNamespaceAndTable("ns", "tbl") { tbl =>
+ sql(s"CREATE TABLE $tbl (col1 STRING) $defaultUsing CLUSTER BY (col1)")
+ sql(s"ALTER TABLE $tbl ALTER COLUMN col1 COMMENT 'this is comment';")
Review Comment:
done. also added a nested column case.
--
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-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-45789][SQL] Support DESCRIBE TABLE for clustering columns [spark]
Posted by "cloud-fan (via GitHub)" <gi...@apache.org>.
cloud-fan closed pull request #45077: [SPARK-45789][SQL] Support DESCRIBE TABLE for clustering columns
URL: https://github.com/apache/spark/pull/45077
--
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-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-45789][SQL] Support DESCRIBE TABLE for clustering columns [spark]
Posted by "cloud-fan (via GitHub)" <gi...@apache.org>.
cloud-fan commented on PR #45077:
URL: https://github.com/apache/spark/pull/45077#issuecomment-1953583284
thanks, merging to master!
--
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-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-45789][SQL] Support DESCRIBE TABLE for clustering columns [spark]
Posted by "cloud-fan (via GitHub)" <gi...@apache.org>.
cloud-fan commented on code in PR #45077:
URL: https://github.com/apache/spark/pull/45077#discussion_r1490980421
##########
sql/core/src/test/scala/org/apache/spark/sql/execution/command/DescribeTableSuiteBase.scala:
##########
@@ -178,4 +178,43 @@ trait DescribeTableSuiteBase extends QueryTest with DDLCommandTestUtils {
assert(errMsg === "DESC TABLE COLUMN does not support nested column: col.x.")
}
}
+
+ test("describe a clustered table") {
+ withNamespaceAndTable("ns", "tbl") { tbl =>
+ sql(s"CREATE TABLE $tbl (col1 STRING, col2 INT) $defaultUsing CLUSTER BY (col1, col2)")
+ val descriptionDf = sql(s"DESC $tbl")
+ assert(descriptionDf.schema.map(field => (field.name, field.dataType)) === Seq(
+ ("col_name", StringType),
+ ("data_type", StringType),
+ ("comment", StringType)))
+ QueryTest.checkAnswer(
+ descriptionDf,
+ Seq(
+ Row("col1", "string", null),
+ Row("col2", "int", null),
+ Row("# Clustering Information", "", ""),
+ Row("# col_name", "data_type", "comment"),
+ Row("col1", "string", null),
+ Row("col2", "int", null)))
+ }
+ }
+
+ test("describe a clustered table with comments on clustering columns") {
+ withNamespaceAndTable("ns", "tbl") { tbl =>
+ sql(s"CREATE TABLE $tbl (col1 STRING) $defaultUsing CLUSTER BY (col1)")
+ sql(s"ALTER TABLE $tbl ALTER COLUMN col1 COMMENT 'this is comment';")
Review Comment:
since we only want to test DESCRIBE TABLE, not ATLER COLUMN, shall we specify the column comment in CREATE TABLE? then we don't need to exclude this test case in the hive test.
--
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-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org