You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/logical-operators/DescribeColumnCommand.md
+19-25Lines changed: 19 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,24 @@ title: DescribeColumnCommand
4
4
5
5
# DescribeColumnCommand Logical Command
6
6
7
+
`DescribeColumnCommand` is a [LeafRunnableCommand](LeafRunnableCommand.md) that represents a `DescribeColumn` logical operator with the default [spark_catalog](../connector/catalog/CatalogManager.md#SESSION_CATALOG_NAME) at execution.
8
+
9
+
## Creating Instance
10
+
11
+
`DescribeColumnCommand` takes the following to be created:
*[ResolveSessionCatalog](../logical-analysis-rules/ResolveSessionCatalog.md) logical resolution rule is executed (to resolve `DescribeColumn` logical operators with the default [spark_catalog](../connector/catalog/CatalogManager.md#SESSION_CATALOG_NAME))
21
+
22
+
<!---
23
+
## Review Me
24
+
7
25
`DescribeColumnCommand` is a RunnableCommand.md[logical command] for spark-sql-SparkSqlAstBuilder.md#DescribeColumnCommand[DESCRIBE TABLE] SQL command with a single column only (i.e. no `PARTITION` specification).
`DescribeColumnCommand` defines the Command.md#output[output schema] with the following columns:
72
-
73
-
*`info_name` with "name of the column info" comment
74
-
*`info_value` with "value of the column info" comment
75
-
76
88
## describeTable Labeled Alternative { #describeTable }
77
89
78
90
`DescribeColumnCommand` is described by `describeTable` labeled alternative in `statement` expression in [SqlBaseParser.g4](../sql/AstBuilder.md#grammar) and parsed using [SparkSqlParser](../sql/SparkSqlParser.md#visitDescribeTable).
@@ -115,22 +127,4 @@ If `DescribeColumnCommand` command was executed with <<isExtended, EXTENDED or F
115
127
. <<histogramDescription, histogram>>
116
128
117
129
`run` gives `NULL` for the value of the comment and statistics if not available.
`DescribeColumnCommand` takes the following when created:
133
-
134
-
*[[table]]`TableIdentifier`
135
-
*[[colNameParts]] Column name
136
-
*[[isExtended]]`isExtended` flag that indicates whether spark-sql-SparkSqlAstBuilder.md#DescribeColumnCommand[EXTENDED or FORMATTED option] was used or not
0 commit comments