ShreelekhyaG commented on a change in pull request #4113:
URL: https://github.com/apache/carbondata/pull/4113#discussion_r613171410



##########
File path: docs/ddl-of-carbondata.md
##########
@@ -646,6 +647,69 @@ CarbonData DDL statements are documented here,which 
includes:
 
 ## TABLE MANAGEMENT  
 
+### DESCRIBE COMMAND
+
+Describe column of table and visualize its structure with child fields.
+  ```
+  [DESCRIBE | DESC] COLUMN fieldname[.nestedFieldNames] ON 
[db_name.]table_name;
+
+  Examples: 
+  
+    DESCRIBE COLUMN locationinfo on complexcarbontable;
+    
+    
+------------------------------+--------------------------------------------------------------------------------------------------------------------+-------+
+    |col_name                      |data_type                                  
                                                                         
|comment|
+    
+------------------------------+--------------------------------------------------------------------------------------------------------------------+-------+
+    |locationinfo                  |array                                      
                                                                         |null  
 |
+    |## Children of locationinfo:  |                                           
                                                                         |      
 |
+    |item                          
|struct<activeprovince:string,activecity:map<string,string>,activedistrict:string,activestreet:array<string>>
        |null   |
+    
+------------------------------+--------------------------------------------------------------------------------------------------------------------+-------+
+    
+    DESCRIBE COLUMN locationinfo.item on complexcarbontable
+    
+    +-----------------------------------+------------------+-------+
+    |col_name                           |data_type         |comment|
+    +-----------------------------------+------------------+-------+
+    |locationinfo.item                  |struct            |null   |

Review comment:
       updated the example where the comment is not null.




-- 
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.

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


Reply via email to