Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc](show table)Optimize the documentation of show table statements. #1898

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

smallhibiscus
Copy link
Contributor

@smallhibiscus smallhibiscus commented Jan 22, 2025

Versions

  • dev
  • 3.0
  • 2.1
  • 2.0

Languages

  • Chinese
  • English

Docs Checklist

  • Checked by AI
  • Test Cases Built

Copy link
Contributor

@morrySnow morrySnow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

在参数和返回值章节,存在类似的问题。,麻烦修改一下所有文档对应的地方

## 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Used to view the conversion of non-light schema change olpa tables to light schema change tables.
Used to view the conversion process of non-light schema change OLAP tables to light schema change tables.

## Example
## Optional parameters

**1. `FROM clause`**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**1. `FROM clause`**
**1. `<db_name>`**

### 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).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This statement is used to find the corresponding database name, table name according to table id (only for administrators).
This statement is used to find the corresponding database name, table name according to table id.

## 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

information 太笼统了

## Best Practice
## Optional parameters

**1. `FROM clause`**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**1. `FROM clause`**
**1. `FROM [ <catalog_name>.]<db_name>`**

**1. `FROM clause`**
> The catalog name and database name to be queried can be specified in the FROM clause.

**2. `LIKE clause`**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**2. `LIKE clause`**
**2. `<like_condition>`**


## Return value

| Column name (Column) | Type (DataType) | Notes (Notes) |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| Column name (Column) | Type (DataType) | Notes (Notes) |
| Column | Data Type | Notes |

| Create_time | Datetime | Creation time |
| Update_time | Datetime | Update time |
| Check_time | Datetime | |
| Collation | Character set | Character set, currently only supports utf-8 |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| Collation | Character set | Character set, currently only supports utf-8 |
| Collation | string | Character set, currently only supports utf-8 |

Comment on lines 57 to 58
| Data_free | | |
| Auto_increment | | |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这俩忘记写数据类型了?

Comment on lines 63 to 64
| Checksum | String | |
| Create_options | string | |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

缺少说明

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants