Re: [PR] [doc](show table)Optimize the documentation of show table statements. [doris-website]

2025-01-23 Thread via GitHub


KassieZ merged PR #1898:
URL: https://github.com/apache/doris-website/pull/1898


-- 
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: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


-
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]



Re: [PR] [doc](show table)Optimize the documentation of show table statements. [doris-website]

2025-01-23 Thread via GitHub


morrySnow commented on code in PR #1898:
URL: https://github.com/apache/doris-website/pull/1898#discussion_r1928023365


##
docs/sql-manual/sql-statements/table-and-view/table/SHOW-TABLE-STATUS.md:
##
@@ -43,26 +43,26 @@ SHOW TABLE STATUS [ FROM [ .] ] [ 
LIKE  ]
 
 ## Return value
 
-| Column  | Data Type | Notes  
  |
-|:|:--|:-|
-| Name| String| Table name 
  |
-| Engine  | String| Table engine   
  |
-| Version | String| Table version  
  |
-| Row_format  | String| table row's format 
  |
-| Rows| String| Number of rows in the table
  |
-| Avg_row_length  | Integer   | Average length of each row of data 
  |
-| Data_length | Integer   | Data size of the table 
  |
-| Max_data_length | Integer   | Maximum length of the data row 
  |
-| Index_length| Integer   | Length of the index
  |
-| Data_free   |   |
  |
-| Auto_increment  |   |
  |
-| Create_time | Datetime  | Creation time  
  |
-| Update_time | Datetime  | Update time
  |
-| Check_time  | Datetime  | Check time 
  |
-| Collation   | Character set | Character set, currently only supports 
utf-8 |
-| Checksum| String| Table Checksum 
  |
-| Create_options  | string| Table options  
  |
-| Comment | string| Table comment  
  |
+| Column  | DataType| Notes


 |
+|:|:|:--|
+| Name| String  | Table name   


 |
+| Engine  | String  | Storage engine for the table 


 |
+| Version | String  | Version  


 |
+| Row_format  | String  | Row format. For the MyISAM engine, 
this may be Dynamic, Fixed, or Compressed. Dynamic rows have variable length, 
such as Varchar or Blob type fields. Fixed rows have fixed length, such as Char 
and Integer type fields. |
+| Rows| String  | Number of rows in the table. For 
non-transactional tables, this value is exact, for transactional engines, this 
value is usually estimated. 
  |
+| Avg_row_length  | Integer | Average number of bytes per row  


 |
+| Data_length | Integer | The amount of data in the entire 
table (in bytes)

 |
+| Max_data_length | Integer | The maximum amount of data that a 
table can hold  

|
+| Index_length| Integer | The amount of disk space occupied by 
an index

 |
+| Data_free   | Integer | For the MyISAM engine, identifi

Re: [PR] [doc](show table)Optimize the documentation of show table statements. [doris-website]

2025-01-22 Thread via GitHub


morrySnow commented on code in PR #1898:
URL: https://github.com/apache/doris-website/pull/1898#discussion_r1925157731


##
docs/sql-manual/sql-statements/table-and-view/table/SHOW-CONVERT-LIGHT-SCHEMA-CHANGE-PROCESS.md:
##
@@ -24,34 +24,43 @@ specific language governing permissions and limitations
 under the License.
 -->
 
-
 ## Description
 
-This statement is used to show the process of converting light schema change 
process. should enable config `enable_convert_light_weight_schema_change`.
+Used to view the conversion of non-light schema change olpa tables to light 
schema change tables.

Review Comment:
   ```suggestion
   Used to view the conversion process of non-light schema change OLAP tables 
to light schema change tables.
   ```



##
docs/sql-manual/sql-statements/table-and-view/table/SHOW-TABLE-ID.md:
##
@@ -24,28 +24,49 @@ specific language governing permissions and limitations
 under the License.
 -->
 
-
 ### Description
 
-This statement is used to find the corresponding database name, table name 
according to the table id (only for administrators)
+This statement is used to find the corresponding database name, table name 
according to table id (only for administrators).

Review Comment:
   ```suggestion
   This statement is used to find the corresponding database name, table name 
according to table id.
   ```



##
docs/sql-manual/sql-statements/table-and-view/table/SHOW-CONVERT-LIGHT-SCHEMA-CHANGE-PROCESS.md:
##
@@ -24,34 +24,43 @@ specific language governing permissions and limitations
 under the License.
 -->
 
-
 ## Description
 
-This statement is used to show the process of converting light schema change 
process. should enable config `enable_convert_light_weight_schema_change`.
+Used to view the conversion of non-light schema change olpa tables to light 
schema change tables.
 
-grammar:
+## Syntax
 
 ```sql
-SHOW CONVERT_LIGHT_SCHEMA_CHANGE_PROCESS [FROM db]
+SHOW CONVERT_LIGHT_SCHEMA_CHANGE_PROCESS [ FROM  ]
 ```
 
-## Example
+## Optional parameters
+
+**1. `FROM clause`**

Review Comment:
   ```suggestion
   **1. ``**
   ```



##
docs/sql-manual/sql-statements/table-and-view/table/SHOW-TABLE-STATUS.md:
##
@@ -24,39 +24,87 @@ specific language governing permissions and limitations
 under the License.
 -->
 
-
 ## Description
 
-This statement is used to view some information about the Table.
+This statement is used to display some information about a table or view.

Review Comment:
   information 太笼统了



##
docs/sql-manual/sql-statements/table-and-view/table/SHOW-TABLE-STATUS.md:
##
@@ -24,39 +24,87 @@ specific language governing permissions and limitations
 under the License.
 -->
 
-
 ## Description
 
-This statement is used to view some information about the Table.
+This statement is used to display some information about a table or view.
 
-grammar:
+## Syntax
 
 ```sql
-SHOW TABLE STATUS
-[FROM db] [LIKE "pattern"]
+SHOW TABLE STATUS [ FROM [ .] ] [ LIKE  
]
 ```
-
-illustrate:
-
-1. This statement is mainly used to be compatible with MySQL syntax, currently 
only a small amount of information such as Comment is displayed
-
-## Example
-
-  1. View the information of all tables under the current database
-
- ```sql
- SHOW TABLE STATUS;
- ```
-
-  2. View the information of the table whose name contains example under the 
specified database
-
- ```sql
- SHOW TABLE STATUS FROM db LIKE "%example%";
- ```
-
-## Keywords
-
-SHOW, TABLE, STATUS
-
-## Best Practice
+## Optional parameters
+
+**1. `FROM clause`**
+> The catalog name and database name to be queried can be specified in the 
FROM clause.
+
+**2. `LIKE clause`**
+> The LIKE clause can perform fuzzy queries based on the table name.
+
+## Return value
+
+| Column name (Column) | Type (DataType) | Notes (Notes) |
+|:|:-|:|
+| Name | String | Table name |
+| Engine | String | Table engine |
+| Version | String | |
+| Row_format | String | |
+| Rows | String | Number of rows in the table |
+| Avg_row_length | Integer | Average length of each row of data |
+| Data_length | Integer | Data size of the table |
+| Max_data_length | Integer | Maximum length of the data row |
+| Index_length | Integer | Length of the index |
+| Data_free | | |
+| Auto_increment | | |
+| Create_time | Datetime | Creation time |
+| Update_time | Datetime | Update time |
+| Check_time | Datetime | |
+| Collation | Character set | Character set, currently only supports utf-8 |

Review Comment:
   ```suggestion
   | Collation | string | Character set, currently only supports utf-8 |
   ```



##
docs/sql-manual/sql-statements/table-and-view/table/SHOW-TABLE-STATUS.md:
##
@@ -24,39 +24,87 @@ specific language governing permissions and limitations
 under the License.
 -->
 
-
 ## Description
 
-This statement is used to view some information about the Table.
+This statement is u

[PR] [doc](show table)Optimize the documentation of show table statements. [doris-website]

2025-01-21 Thread via GitHub


smallhibiscus opened a new pull request, #1898:
URL: https://github.com/apache/doris-website/pull/1898

   ## Versions 
   
   - [ ] dev
   - [ ] 3.0
   - [ ] 2.1
   - [ ] 2.0
   
   ## Languages
   
   - [ ] Chinese
   - [ ] English
   
   ## Docs Checklist
   
   - [ ] Checked by AI
   - [ ] Test Cases Built
   


-- 
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: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


-
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]