Skip to content

Commit 4967a30

Browse files
authored
sql: update tidb specific link description (#692)
* sql: update tidb specific link description The title was renamed in #666 * Remove specific, improve readability * Update specific variables
1 parent 6615299 commit 4967a30

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

sql/tidb-server.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ You can set the service parameters using the command line or the configuration f
1414

1515
## TiDB system variable
1616

17-
TiDB is compatible with MySQL system variables, and defines some unique system variables to adjust the database behavior. For more information, see [The Proprietary System Variables and Syntaxes in TiDB](../sql/tidb-specific.md).
17+
TiDB is compatible with MySQL system variables, and defines some unique system variables to adjust the database behavior. For more information, see [TiDB Specific System Variables](../sql/tidb-specific.md).
1818

1919
## TiDB system table
2020

sql/tidb-specific.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ category: user guide
88

99
TiDB contains a number of system variables which are specific to its usage, and **do not** apply to MySQL. These variables start with a `tidb_` prefix, and can be tuned to optimize system performance.
1010

11-
## System variable
11+
## System variables
1212

1313
Variables can be set with the `SET` statement, for example:
1414

@@ -289,11 +289,11 @@ set @@global.tidb_distsql_scan_concurrency = 10
289289
- This variable is used to change the default priority for statements executed on a TiDB server. A use case is to ensure that a particular user that is performing OLAP queries receives lower priority than users performing OLTP queries.
290290
- You can set the value of this variable to `NO_PRIORITY`, `LOW_PRIORITY`, `DELAYED` or `HIGH_PRIORITY`.
291291

292-
## Optimizer Hint
292+
## Optimizer Hints
293293

294-
On the basis of MySQL’s `Optimizer Hint` Syntax, TiDB adds some proprietary `Hint` syntaxes. When using the `Hint` syntax, the TiDB optimizer will try to use the specific algorithm, which performs better than the default algorithm in some scenarios.
295-
296-
The `Hint` syntax is included in comments like `/*+ xxx */`, and in MySQL client versions earlier than 5.7.7, the comment is removed by default. If you want to use the `Hint` syntax in these earlier versions, add the `--comments` option when starting the client. For example: `mysql -h 127.0.0.1 -P 4000 -uroot --comments`.
294+
TiDB supports optimizer hints, based on the comment-like syntax introduced in MySQL 5.7. i.e. `/*+ TIDB_XX(t1, t2) */`. Use of optimizer hints is recommended in cases where the TiDB optimizer selects a less optimal query plan.
295+
296+
> **Note:** MySQL command-line clients earlier than 5.7.7 strip optimizer hints by default. If you want to use the `Hint` syntax in these earlier versions, add the `--comments` option when starting the client. For example: `mysql -h 127.0.0.1 -P 4000 -uroot --comments`.
297297
298298
### TIDB_SMJ(t1, t2)
299299

sql/variable.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,6 @@ The following MySQL system variables are fully supported in TiDB and have the sa
4545
| tx_isolation | GLOBAL \| SESSION | the isolation level of a transaction |
4646
| hostname | NONE | the hostname of the TiDB server |
4747

48-
## The proprietary system variables and syntaxes in TiDB
48+
## TiDB Specific System Variables
4949

50-
See [The Proprietary System Variables and Syntax in TiDB](../sql/tidb-specific.md).
50+
See [TiDB Specific System Variables](../sql/tidb-specific.md).

0 commit comments

Comments
 (0)