[SPARK-53840][SQL] Add AS JSON output support for SHOW TABLES and SHOW TABLE EXTENDED #54824
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
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
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,115 @@ | ||
| /* | ||
| * 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 | ||
|
|
||
| import scala.collection.mutable.ArrayBuffer | ||
|
|
||
| import org.json4s._ | ||
| import org.json4s.jackson.JsonMethods._ | ||
|
|
||
| import org.apache.spark.sql.catalyst.InternalRow | ||
| import org.apache.spark.sql.catalyst.expressions.Attribute | ||
| import org.apache.spark.sql.catalyst.util.StringUtils | ||
| import org.apache.spark.sql.connector.catalog.{CatalogV2Util, Identifier, TableCatalog, TableViewCatalog} | ||
| import org.apache.spark.sql.execution.LeafExecNode | ||
|
|
||
| /** | ||
| * Physical plan node for `SHOW TABLES AS JSON` and `SHOW TABLE EXTENDED AS JSON`. | ||
| * | ||
| * For a [[TableViewCatalog]] (non-extended only), listing is done via | ||
| * [[TableViewCatalog#listTableAndViewSummaries]] so that views appear alongside tables, | ||
| * matching the v1 `SHOW TABLES` semantics. | ||
| */ | ||
| case class ShowTablesJsonExec( | ||
| output: Seq[Attribute], | ||
| catalog: TableCatalog, | ||
| namespace: Seq[String], | ||
| pattern: String, | ||
| isExtended: Boolean) extends V2CommandExec with LeafExecNode { | ||
|
|
||
| override protected def run(): Seq[InternalRow] = { | ||
| val identifiers: Array[Identifier] = if (!isExtended) { | ||
| catalog match { | ||
| case mc: TableViewCatalog => | ||
| mc.listTableAndViewSummaries(namespace.toArray).map(_.identifier()) | ||
| case _ => catalog.listTables(namespace.toArray) | ||
| } | ||
| } else { | ||
| catalog.listTables(namespace.toArray) | ||
| } | ||
|
|
||
| val filteredIdents = identifiers.filter { ident => | ||
| StringUtils.filterPattern(Seq(ident.name()), pattern).nonEmpty | ||
| } | ||
|
|
||
| val jsonRows = new ArrayBuffer[JObject]() | ||
| filteredIdents.foreach { ident => | ||
| jsonRows += toJsonEntry(ident.name(), ident.namespace(), isTempView(ident)) | ||
| } | ||
|
|
||
| // For non-session V2 catalogs that don't surface temp views via listTables() or | ||
| // listTableAndViewSummaries(), fetch them separately. For V2SessionCatalog, | ||
| // listTables() already includes local temp views, so we skip this to avoid duplicates. | ||
| // For TableViewCatalog (non-extended path), views come from listTableAndViewSummaries(). | ||
| if (!CatalogV2Util.isSessionCatalog(catalog) && | ||
|
Contributor
There was a problem hiding this comment. This non-session V2 catalog branch
Suggestion: Remove the branch |
||
| (isExtended || !catalog.isInstanceOf[TableViewCatalog])) { | ||
| val sessionCatalog = session.sessionState.catalog | ||
| val db = namespace match { | ||
| case Seq(db) => db | ||
| case _ => "" | ||
| } | ||
| sessionCatalog.listTempViews(db, pattern).foreach { tempView => | ||
| jsonRows += toJsonEntry( | ||
| tempView.identifier.table, | ||
| tempView.identifier.database.toArray, | ||
| isTemporary = true) | ||
| } | ||
| } | ||
|
|
||
| val jsonOutput = JObject("tables" -> JArray(jsonRows.toList)) | ||
| Seq(toCatalystRow(compact(render(jsonOutput)))) | ||
| } | ||
|
|
||
| private def toJsonEntry( | ||
| name: String, | ||
| namespace: Array[String], | ||
| isTemporary: Boolean): JObject = { | ||
| val nsArray = JArray(namespace.map(JString(_)).toList) | ||
| if (isExtended) { | ||
| JObject( | ||
| "name" -> JString(name), | ||
| "catalog" -> JString(catalog.name()), | ||
| "namespace" -> nsArray, | ||
| "type" -> JString(if (isTemporary) "VIEW" else "TABLE"), | ||
| "isTemporary" -> JBool(isTemporary) | ||
| ) | ||
| } else { | ||
| JObject( | ||
| "name" -> JString(name), | ||
| "namespace" -> nsArray, | ||
| "isTemporary" -> JBool(isTemporary) | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| private def isTempView(ident: Identifier): Boolean = { | ||
| if (CatalogV2Util.isSessionCatalog(catalog)) { | ||
| session.sessionState.catalog.isTempView((ident.namespace() :+ ident.name()).toSeq) | ||
| } else false | ||
| } | ||
| } | ||
Oops, something went wrong.
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.
Currently have duplicated JSON emission code across Exec classes. Consider a ShowTablesJsonCommand which takes the resolved namespace/catalog and handles all variants centrally, similar to DescribeRelationJsonCommand
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.
Addressed. We extracted a single ShowTablesJsonExec physical plan node covering both SHOW TABLES AS JSON and SHOW TABLE EXTENDED AS JSON, controlled by an isExtended: Boolean flag.