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]update trash statement #1953

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

yz-jayhua
Copy link

Versions

  • dev
  • 3.0
  • 2.1
  • 2.0

Languages

  • Chinese
  • English

Docs Checklist

  • Checked by AI
  • Test Cases Built

@KassieZ KassieZ requested a review from morrySnow February 6, 2025 06:43

grammar:
## Syntax

```sql
ADMIN CLEAN TRASH [ON ("BackendHost1:BackendHeartBeatPort1", "BackendHost2:BackendHeartBeatPort2", ...)];
Copy link
Contributor

Choose a reason for hiding this comment

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

  1. 参数需要尖括号包裹
  2. 重复的可选参数格式应为 [, ...]
  3. 参数应为小写,单词间下划线分隔
Suggested change
ADMIN CLEAN TRASH [ON ("BackendHost1:BackendHeartBeatPort1", "BackendHost2:BackendHeartBeatPort2", ...)];
ADMIN CLEAN TRASH [ON ("<be_host>:<be_heartbeat_port>" [, ...])];

Comment on lines +40 to +42
| Parameter | Description |
| ----- | ---- |
| ON | Specify the backend to be cleaned up. If you do not add ON, all backend is cleared by default. |
Copy link
Contributor

Choose a reason for hiding this comment

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

  1. 语句参数的格式不是表格。
  2. 应区分必选参数(Required Parameters)和可选参数章节(Optional Parameters)
Suggested change
| Parameter | Description |
| ----- | ---- |
| ON | Specify the backend to be cleaned up. If you do not add ON, all backend is cleared by default. |
** 1. [ON ("<be_host>:<be_heartbeat_port>" [, ...])] **
> 这里写参数描述


2. Clean up the junk data of '192.168.0.1:9050' and '192.168.0.2:9050'.
Copy link
Contributor

Choose a reason for hiding this comment

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

缺少权限章节

Copy link
Contributor

Choose a reason for hiding this comment

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

和 clean trash 类似的问题

@KassieZ KassieZ added the has comments Some comments not resolved yet label Feb 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
has comments Some comments not resolved yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants