Skip to content

Commit 786cae1

Browse files
ti-srebotTomShawn
ti-srebot
and
TomShawn
authored
Capitalize sql keywords in several files (#4862) (#4865)
* cherry pick #4862 to release-3.1 Signed-off-by: ti-srebot <[email protected]> * resolve conflicts Co-authored-by: TomShawn <[email protected]>
1 parent 2eb93bf commit 786cae1

5 files changed

+36
-36
lines changed

‎auto-random.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -18,29 +18,29 @@ aliases: ['/docs-cn/v3.1/auto-random/','/docs-cn/v3.1/reference/sql/attributes/a
1818
以下面语句建立的表为例：
1919

2020
```sql
21-
create table t (a int primary key auto_increment, b varchar(255))
21+
CREATE TABLE t (a int PRIMARY KEY AUTO_INCREMENT, b varchar(255))
2222
```
2323

2424
在以上语句所建的表上执行大量未指定主键值的 `INSERT` 语句，示例如下：
2525

2626
```sql
27-
insert into t(b) values ('a'), ('b'), ('c')
27+
INSERT INTO t(b) VALUES ('a'), ('b'), ('c')
2828
```
2929

3030
如以上语句，由于未指定主键列的值（`a` 列），TiDB 会使用连续自增的行值作为行 ID，可能导致单个 TiKV 节点上产生写入热点，进而影响对外提供服务的性能。要避免这种性能下降，可以在执行建表语句时为 `a` 列指定 `AUTO_RANDOM` 属性而不是 `AUTO_INCREMENT` 属性。示例如下：
3131

3232
{{< copyable "sql" >}}
3333

3434
```sql
35-
create table t (a int primary key auto_random, b varchar(255))
35+
CREATE TABLE t (a int PRIMARY KEY AUTO_RANDOM, b varchar(255))
3636
```
3737

3838
或者
3939

4040
{{< copyable "sql" >}}
4141

4242
```sql
43-
create table t (a int auto_random, b varchar(255), primary key (a))
43+
CREATE TABLE t (a int AUTO_RANDOM, b varchar(255), PRIMARY KEY (a))
4444
```
4545

4646
此时再执行形如 `INSERT INTO t(b) values...` 的 `INSERT` 语句。
@@ -57,7 +57,7 @@ create table t (a int auto_random, b varchar(255), primary key (a))
5757
{{< copyable "sql" >}}
5858

5959
```sql
60-
create table t (a int primary key auto_random(3), b varchar(255))
60+
CREATE TABLE t (a int PRIMARY KEY AUTO_RANDOM(3), b varchar(255))
6161
```
6262

6363
以上建表语句中，shard bits 的数量为 `3`。shard bits 的数量的取值范围是 `[1, field_max_bits)`，其中 `field_max_bits` 为整型主键列类型占用的位长度。
@@ -67,10 +67,10 @@ create table t (a int primary key auto_random(3), b varchar(255))
6767
{{< copyable "sql" >}}
6868

6969
```sql
70-
show warnings
70+
SHOW WARNINGS
7171
```
7272

73-
```
73+
```sql
7474
+-------+------+------------------------------------------------+
7575
| Level | Code | Message |
7676
+-------+------+------------------------------------------------+
@@ -80,19 +80,19 @@ show warnings
8080

8181
另外，含有 `AUTO_RANDOM` 属性的表在系统表 `information_schema.tables` 中 `TIDB_ROW_ID_SHARDING_INFO` 一列的值为 `PK_AUTO_RANDOM_BITS=x`，其中 `x` 为 shard bits 的数量。
8282

83-
要获取上一次 TiDB 隐式分配的 ID，可以使用 `select last_insert_id()` 查看，例如：
83+
要获取上一次 TiDB 隐式分配的 ID，可以使用 `SELECT last_insert_id()` 查看，例如：
8484

8585
{{< copyable "sql" >}}
8686

8787
```sql
88-
insert into t (b) values ("b")
89-
select * from t;
90-
select last_insert_id()
88+
INSERT INTO t (b) VALUES ("b")
89+
SELECT * FROM t;
90+
SELECT last_insert_id()
9191
```
9292

9393
可能得到的结果如下：
9494

95-
```
95+
```sql
9696
+------------+---+
9797
| a | b |
9898
+------------+---+
@@ -113,18 +113,18 @@ TiDB 支持解析版本注释语法。示例如下：
113113
{{< copyable "sql" >}}
114114

115115
```sql
116-
create table t (a bigint primary key /*T![auto_rand] auto_random */)
116+
CREATE TABLE t (a bigint PRIMARY KEY /*T![auto_rand] auto_random */)
117117
```
118118

119119
{{< copyable "sql" >}}
120120

121121
```sql
122-
create table t (a int primary key auto_random)
122+
CREATE TABLE t (a int PRIMARY KEY AUTO_RANDOM)
123123
```
124124

125125
以上两个语句含义相同。
126126

127-
在 `show create table` 的结果中，`AUTO_RANDOM` 属性会被注释掉。注释会附带一个特性标识符，例如 `/*T![auto_rand] auto_random */`。其中 `auto_rand` 表示 `AUTO_RANDOM` 的特性标识符，只有实现了该标识符对应特性的 TiDB 版本才能够正常解析 SQL 语句片段。
127+
在 `SHOW CREATE TABLE` 的结果中，`AUTO_RANDOM` 属性会被注释掉。注释会附带一个特性标识符，例如 `/*T![auto_rand] auto_random */`。其中 `auto_rand` 表示 `AUTO_RANDOM` 的特性标识符，只有实现了该标识符对应特性的 TiDB 版本才能够正常解析 SQL 语句片段。
128128

129129
该功能支持向前兼容，即降级兼容。没有实现对应特性的 TiDB 版本则会忽略表（带有上述注释）的 `AUTO_RANDOM` 属性，因此能够使用含有该属性的表。
130130

‎backup-and-restore-using-mydumper-lightning.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,15 +78,15 @@ aliases: ['/docs-cn/v3.1/backup-and-restore-using-mydumper-lightning/','/docs-cn
7878
{{< copyable "sql" >}}
7979

8080
```sql
81-
update mysql.tidb set VARIABLE_VALUE = '720h' where VARIABLE_NAME = 'tikv_gc_life_time';
81+
UPDATE mysql.tidb SET VARIABLE_VALUE = '720h' WHERE VARIABLE_NAME = 'tikv_gc_life_time';
8282
```
8383

8484
2. 执行 `mydumper` 命令后，将 TiDB 集群的 GC 值恢复到第 1 步中的初始值：
8585

8686
{{< copyable "sql" >}}
8787

8888
```sql
89-
update mysql.tidb set VARIABLE_VALUE = '10m' where VARIABLE_NAME = 'tikv_gc_life_time';
89+
UPDATE mysql.tidb SET VARIABLE_VALUE = '10m' WHERE VARIABLE_NAME = 'tikv_gc_life_time';
9090
```
9191

9292
## 向 TiDB 恢复数据

‎basic-sql-operations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ ALTER TABLE person ADD UNIQUE person_num (number);
156156
{{< copyable "sql" >}}
157157

158158
```sql
159-
SHOW INDEX from person;
159+
SHOW INDEX FROM person;
160160
```
161161

162162
使用 `ALTER TABLE` 或 `DROP INDEX` 语句来删除索引。与 `CREATE INDEX` 语句类似，`DROP INDEX` 也可以嵌入 `ALTER TABLE` 语句。例如：

‎blacklist-control-plan.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -43,27 +43,27 @@ aliases: ['/docs-cn/v3.1/blacklist-control-plan/']
4343
{{< copyable "sql" >}}
4444

4545
```sql
46-
insert into mysql.opt_rule_blacklist values("join_reorder"), ("topn_push_down");
46+
INSERT INTO mysql.opt_rule_blacklist VALUES("join_reorder"), ("topn_push_down");
4747
```
4848

4949
执行以下 SQL 语句可让禁用规则立即生效，包括相应 TiDB Server 的所有旧链接：
5050

5151
{{< copyable "sql" >}}
5252

5353
```sql
54-
admin reload opt_rule_blacklist;
54+
ADMIN reload opt_rule_blacklist;
5555
```
56-
56+
5757
> **注意：**
58-
>
58+
>
5959
> `admin reload opt_rule_blacklist` 只对执行该 SQL 语句的 TiDB server 生效。若需要集群中所有 TiDB server 生效，需要在每台 TiDB server 上执行该 SQL 语句。
6060

6161
- 需要解除一条规则的禁用时，需要删除表中禁用该条规则的相应数据，再执行 `admin reload`：
6262

6363
{{< copyable "sql" >}}
6464

6565
```sql
66-
delete from mysql.opt_rule_blacklist where name in ("join_reorder", "topn_push_down");
66+
DELETE FROM mysql.opt_rule_blacklist WHERE name IN ("join_reorder", "topn_push_down");
6767
admin reload opt_rule_blacklist;
6868
```
6969

@@ -83,15 +83,15 @@ aliases: ['/docs-cn/v3.1/blacklist-control-plan/']
8383
| [日期运算](/functions-and-operators/date-and-time-functions.md) | [`DATE_FORMAT()`](https://dev.mysql.com/doc/refman/5.7/en/date-and-time-functions.html#function_date-format) |
8484

8585
### 禁止特定表达式下推
86-
86+
8787
当函数的计算过程由于下推而出现异常时，可通过黑名单功能禁止其下推来快速恢复业务。具体而言，你可以将上述支持的函数或运算符名加入黑名单 `mysql.expr_pushdown_blacklist` 中，以禁止特定表达式下推。
8888

8989
`mysql.expr_pushdown_blacklist` 的 schema 如下：
9090

9191
{{< copyable "sql" >}}
9292

9393
```sql
94-
desc mysql.expr_pushdown_blacklist;
94+
DESC mysql.expr_pushdown_blacklist;
9595
```
9696

9797
```sql
@@ -147,7 +147,7 @@ desc mysql.expr_pushdown_blacklist;
147147
{{< copyable "sql" >}}
148148

149149
```sql
150-
explain select * from t where a < 2 and a > 2;
150+
EXPLAIN SELECT * FROM t WHERE a < 2 AND a > 2;
151151
```
152152

153153
```sql
@@ -166,7 +166,7 @@ desc mysql.expr_pushdown_blacklist;
166166
{{< copyable "sql" >}}
167167

168168
```sql
169-
insert into mysql.expr_pushdown_blacklist values('<','tikv',''), ('>','tikv','');
169+
INSERT INTO mysql.expr_pushdown_blacklist VALUES('<','tikv',''), ('>','tikv','');
170170
```
171171

172172
```sql
@@ -177,7 +177,7 @@ desc mysql.expr_pushdown_blacklist;
177177
{{< copyable "sql" >}}
178178

179179
```sql
180-
admin reload expr_pushdown_blacklist;
180+
ADMIN reload expr_pushdown_blacklist;
181181
```
182182

183183
```sql
@@ -189,7 +189,7 @@ desc mysql.expr_pushdown_blacklist;
189189
{{< copyable "sql" >}}
190190

191191
```sql
192-
explain select * from t where a < 2 and a > 2;
192+
EXPLAIN SELECT * FROM t WHERE a < 2 and a > 2;
193193
```
194194

195195
```sql
@@ -208,7 +208,7 @@ desc mysql.expr_pushdown_blacklist;
208208
{{< copyable "sql" >}}
209209

210210
```sql
211-
delete from mysql.expr_pushdown_blacklist where name = '>';
211+
DELETE FROM mysql.expr_pushdown_blacklist WHERE name = '>';
212212
```
213213

214214
```sql
@@ -218,7 +218,7 @@ desc mysql.expr_pushdown_blacklist;
218218
{{< copyable "sql" >}}
219219

220220
```sql
221-
admin reload expr_pushdown_blacklist;
221+
ADMIN reload expr_pushdown_blacklist;
222222
```
223223

224224
```sql
@@ -230,7 +230,7 @@ desc mysql.expr_pushdown_blacklist;
230230
{{< copyable "sql" >}}
231231

232232
```sql
233-
explain select * from t where a < 2 and a > 2;
233+
EXPLAIN SELECT * FROM t WHERE a < 2 AND a > 2;
234234
```
235235

236236
```sql

‎character-set-and-collation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ ALTER DATABASE db_name
130130
{{< copyable "sql" >}}
131131

132132
```sql
133-
create schema test1 character set utf8 COLLATE uft8_general_ci;
133+
CREATE SCHEMA test1 CHARACTER SET utf8 COLLATE uft8_general_ci;
134134
```
135135

136136
```
@@ -140,7 +140,7 @@ Query OK, 0 rows affected (0.09 sec)
140140
{{< copyable "sql" >}}
141141

142142
```sql
143-
use test1;
143+
USE test1;
144144
```
145145

146146
```
@@ -165,7 +165,7 @@ SELECT @@character_set_database, @@collation_database;
165165
{{< copyable "sql" >}}
166166

167167
```sql
168-
create schema test2 character set latin1 COLLATE latin1_general_ci;
168+
CREATE SCHEMA test2 CHARACTER SET latin1 COLLATE latin1_general_ci;
169169
```
170170

171171
```
@@ -175,7 +175,7 @@ Query OK, 0 rows affected (0.09 sec)
175175
{{< copyable "sql" >}}
176176

177177
```sql
178-
use test2;
178+
USE test2;
179179
```
180180

181181
```

0 commit comments

Comments
 (0)