Skip to content

Commit

Permalink
[docs]add key words for helps (apache#10263)
Browse files Browse the repository at this point in the history
* add key words for helps

* add key words for helps

* add key words for helps
  • Loading branch information
pengxiangyu authored Jun 22, 2022
1 parent b913d59 commit 98b3306
Show file tree
Hide file tree
Showing 52 changed files with 52 additions and 50 deletions.
1 change: 1 addition & 0 deletions docs/.vuepress/sidebar/en/docs.js
Original file line number Diff line number Diff line change
Expand Up @@ -608,6 +608,7 @@ module.exports = [
"ALTER-DATABASE",
"ALTER-RESOURCE",
"ALTER-SQL-BLOCK-RULE",
"ALTER-TABLE-BITMAP",
"ALTER-TABLE-COLUMN",
"ALTER-TABLE-PARTITION",
"ALTER-TABLE-PROPERTY",
Expand Down
1 change: 1 addition & 0 deletions docs/.vuepress/sidebar/zh-CN/docs.js
Original file line number Diff line number Diff line change
Expand Up @@ -608,6 +608,7 @@ module.exports = [
"ALTER-DATABASE",
"ALTER-RESOURCE",
"ALTER-SQL-BLOCK-RULE",
"ALTER-TABLE-BITMAP",
"ALTER-TABLE-COLUMN",
"ALTER-TABLE-PARTITION",
"ALTER-TABLE-PROPERTY",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ grammar:

### Keywords

ALTER, SYSTEM, ADD, BACKEND
ALTER, SYSTEM, ADD, BACKEND, ALTER SYSTEM

### Best Practice

Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ ALTER SYSTEM ADD BROKER broker_name "broker_host1:broker_ipc_port1","broker_host
### Keywords
ALTER, SYSTEM, ADD, FOLLOWER
ALTER, SYSTEM, ADD, FOLLOWER, ALTER SYSTEM
### Best Practice
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ illustrate:
### Keywords
ALTER, SYSTEM, ADD, FOLLOWER
ALTER, SYSTEM, ADD, FOLLOWER, ALTER SYSTEM
### Best Practice
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ illustrate:
### Keywords
ALTER, SYSTEM, ADD, OBSERVER
ALTER, SYSTEM, ADD, OBSERVER, ALTER SYSTEM
### Best Practice
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ ALTER SYSTEM DECOMMISSION BACKEND "host:heartbeat_port"[,"host:heartbeat_port"..
### Keywords
ALTER, SYSTEM, DECOMMISSION, BACKEND
ALTER, SYSTEM, DECOMMISSION, BACKEND, ALTER SYSTEM
### Best Practice
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ illustrate:
### Keywords
ALTER, SYSTEM, DROP, BACKEND
ALTER, SYSTEM, DROP, BACKEND, ALTER SYSTEM
### Best Practice
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ ALTER SYSTEM DROP BROKER broker_name "host:port"[,"host:port"...];

### Keywords

ALTER, SYSTEM, DROP, FOLLOWER
ALTER, SYSTEM, DROP, FOLLOWER, ALTER SYSTEM

### Best Practice

Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ illustrate:
### Keywords
ALTER, SYSTEM, DROP, FOLLOWER
ALTER, SYSTEM, DROP, FOLLOWER, ALTER SYSTEM
### Best Practice
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ illustrate:
### Keywords
ALTER, SYSTEM, DROP, OBSERVER
ALTER, SYSTEM, DROP, OBSERVER, ALTER SYSTEM
### Best Practice
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ ALTER SYSTEM MODIFY BACKEND "host:heartbeat_port" SET ("key" = "value"[, ...]);
### Keywords
ALTER, SYSTEM, ADD, BACKEND
ALTER, SYSTEM, ADD, BACKEND, ALTER SYSTEM
### Best Practice
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ under the License.

### Keywords

ALTER, SYSTEM, MODIFY, BROKER
ALTER, SYSTEM, MODIFY, BROKER, ALTER SYSTEM

### Best Practice

Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ CANCEL DECOMMISSION BACKEND "host:heartbeat_port"[,"host:heartbeat_port"...];
### Keywords
CANCEL, DECOMMISSION
CANCEL, DECOMMISSION, CANCEL ALTER
### Best Practice
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ ALTER TABLE table1 DROP INDEX [IF EXISTS] index_name;
### Keywords

```text
ALTER, TABLE, BITMAP
ALTER, TABLE, BITMAP, ALTER TABLE
```

### Best Practice
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ ORDER BY (k3,k1,k2,v2,v1) FROM example_rollup_index;
### Keywords

```text
ALTER, TABLE, COLUMN
ALTER, TABLE, COLUMN, ALTER TABLE
```

### Best Practice
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ ADD PARTITION p1 VALUES [("2014-01-01"), ("2014-02-01"));
### Keywords

```text
ALTER, TABLE, PARTITION
ALTER, TABLE, PARTITION, ALTER TABLE
```

### Best Practice
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ ALTER TABLE example_db.mysql_table MODIFY ENGINE TO odbc PROPERTIES("driver" = "
### Keywords

```text
ALTER, TABLE, PROPERTY
ALTER, TABLE, PROPERTY, ALTER TABLE
```

### Best Practice
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ ALTER TABLE example_table RENAME PARTITION p1 p2;
### Keywords

```text
ALTER, TABLE, RENAME
ALTER, TABLE, RENAME, ALTER TABLE
```

### Best Practice
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ MODIFY COLUMN val1 VARCHAR(64) REPLACE DEFAULT "abc";
### Keywords

```text
ALTER, TABLE, REPLACE
ALTER, TABLE, REPLACE, ALTER TABLE
```

### Best Practice
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ DROP ROLLUP example_rollup_index2;
### Keywords

```text
ALTER, TABLE, ROLLUP
ALTER, TABLE, ROLLUP, ALTER TABLE
```

### Best Practice
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ FROM example_db.my_table(12801,12802);

### Keywords

CANCEL, ALTER, TABLE
CANCEL, ALTER, TABLE, CANCEL ALTER

### Best Practice

Original file line number Diff line number Diff line change
Expand Up @@ -498,7 +498,7 @@ FROM data_source [data_source_properties]
### Keywords
CREATE, ROUTINE, LOAD
CREATE, ROUTINE, LOAD, CREATE LOAD
### Best Practice
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ The columns in the results have the following meanings:

### Keywords

ADMIN, SHOW, CONFIG
ADMIN, SHOW, CONFIG, ADMIN SHOW

### Best Practice

Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ illustrate:

### Keywords

ADMIN, SHOW, REPLICA, DISTRIBUTION
ADMIN, SHOW, REPLICA, DISTRIBUTION, ADMIN SHOW

### Best Practice

Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ illustrate
### Keywords
ADMIN, SHOW, REPLICA, STATUS
ADMIN, SHOW, REPLICA, STATUS, ADMIN SHOW
### Best Practice
Original file line number Diff line number Diff line change
Expand Up @@ -50,5 +50,5 @@ under the License.
4 rows in set (0.034 sec)

### keywords
ADMIN,SHOW,TABLET,STORAGE,FORMAT
ADMIN, SHOW, TABLET, STORAGE, FORMAT, ADMIN SHOW

Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ ALTER SYSTEM ADD BACKEND

### Keywords

ALTER, SYSTEM, ADD, BACKEND
ALTER, SYSTEM, ADD, BACKEND, ALTER SYSTEM

### Best Practice

Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ ALTER SYSTEM ADD BROKER broker_name "broker_host1:broker_ipc_port1","broker_host

### Keywords

ALTER, SYSTEM, ADD, FOLLOWER
ALTER, SYSTEM, ADD, FOLLOWER, ALTER SYSTEM

### Best Practice

Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ ALTER SYSTEM ADD FOLLOWER "follower_host:edit_log_port"

### Keywords

ALTER, SYSTEM, ADD, FOLLOWER
ALTER, SYSTEM, ADD, FOLLOWER, ALTER SYSTEM

### Best Practice

Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ ALTER SYSTEM ADD OBSERVER "follower_host:edit_log_port"

### Keywords

ALTER, SYSTEM, ADD, OBSERVER
ALTER, SYSTEM, ADD, OBSERVER, ALTER SYSTEM

### Best Practice

Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ ALTER SYSTEM DECOMMISSION BACKEND "host:heartbeat_port"[,"host:heartbeat_port"..

### Keywords

ALTER, SYSTEM, DECOMMISSION, BACKEND
ALTER, SYSTEM, DECOMMISSION, BACKEND, ALTER SYSTEM

### Best Practice

Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ ALTER SYSTEM DROP BACKEND "host:heartbeat_port"[,"host:heartbeat_port"...]

### Keywords

ALTER, SYSTEM, DROP, BACKEND
ALTER, SYSTEM, DROP, BACKEND, ALTER SYSTEM

### Best Practice

Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ ALTER SYSTEM DROP BROKER broker_name "host:port"[,"host:port"...];

### Keywords

ALTER, SYSTEM, DROP, FOLLOWER
ALTER, SYSTEM, DROP, FOLLOWER, ALTER SYSTEM

### Best Practice

Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ ALTER SYSTEM DROP FOLLOWER "follower_host:edit_log_port"

### Keywords

ALTER, SYSTEM, DROP, FOLLOWER
ALTER, SYSTEM, DROP, FOLLOWER, ALTER SYSTEM

### Best Practice

Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ ALTER SYSTEM DROP OBSERVER "follower_host:edit_log_port"

### Keywords

ALTER, SYSTEM, DROP, OBSERVER
ALTER, SYSTEM, DROP, OBSERVER, ALTER SYSTEM

### Best Practice

Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ ALTER SYSTEM MODIFY BACKEND "host:heartbeat_port" SET ("key" = "value"[, ...]);
```
### Keywords

ALTER, SYSTEM, ADD, BACKEND
ALTER, SYSTEM, ADD, BACKEND, ALTER SYSTEM

### Best Practice

Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ under the License.

### Keywords

ALTER, SYSTEM, MODIFY, BROKER
ALTER, SYSTEM, MODIFY, BROKER, ALTER SYSTEM

### Best Practice

Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ CANCEL DECOMMISSION BACKEND "host:heartbeat_port"[,"host:heartbeat_port"...];

### Keywords

CANCEL, DECOMMISSION
CANCEL, DECOMMISSION, CANCEL ALTER

### Best Practice

Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ ALTER TABLE table1 DROP INDEX [IF EXISTS] index_name;
### Keywords

```text
ALTER, TABLE, BITMAP
ALTER, TABLE, BITMAP, ALTER TABLE
```

### Best Practice
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ ORDER BY (k3,k1,k2,v2,v1) FROM example_rollup_index;
### Keywords

```text
ALTER, TABLE, COLUMN
ALTER, TABLE, COLUMN, ALTER TABLE
```

### Best Practice
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ ADD PARTITION p1 VALUES [("2014-01-01"), ("2014-02-01"));
### Keywords

```text
ALTER, TABLE, PARTITION
ALTER, TABLE, PARTITION, ALTER TABLE
```

### Best Practice
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ ALTER TABLE example_db.mysql_table MODIFY ENGINE TO odbc PROPERTIES("driver" = "
### Keywords

```text
ALTER, TABLE, PROPERTY
ALTER, TABLE, PROPERTY, ALTER TABLE
```

### Best Practice
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ ALTER TABLE example_table RENAME PARTITION p1 p2;
### Keywords

```text
ALTER, TABLE, RENAME
ALTER, TABLE, RENAME, ALTER TABLE
```

### Best Practice
Expand Down
Loading

0 comments on commit 98b3306

Please sign in to comment.