Skip to content

Commit cc34403

Browse files
committed
cloud: document Essential and Premium transaction limits
1 parent ebd9252 commit cc34403

4 files changed

Lines changed: 35 additions & 7 deletions

File tree

follower-read.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,14 @@ To enable TiDB's Follower Read feature, modify the value of the `tidb_replica_re
4646
set [session | global] tidb_replica_read = '<target value>';
4747
```
4848

49+
<CustomContent platform="tidb-cloud" plan="essential,premium">
50+
51+
> **Note:**
52+
>
53+
> For [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) and [{{{ .premium }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier/#premium), `tidb_replica_read` is read-only and fixed to `leader`. Other read modes are not supported.
54+
55+
</CustomContent>
56+
4957
Scope: SESSION | GLOBAL
5058

5159
Default: leader

pipelined-dml.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,14 @@ Currently, Pipelined DML has the following limitations:
4646
- When [foreign key constraints](/foreign-key.md) are enabled (`foreign_key_checks = ON`), target tables must not include foreign key relationships.
4747
- When executing `INSERT IGNORE ... ON DUPLICATE KEY UPDATE` statements, conflicting updates might result in `Duplicate entry` errors.
4848

49+
<CustomContent platform="tidb-cloud" plan="essential,premium">
50+
51+
> **Note:**
52+
>
53+
> Pipelined DML is not supported for [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) and [{{{ .premium }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier/#premium). You cannot enable Pipelined DML by setting [`tidb_dml_type`](/system-variables.md#tidb_dml_type-new-in-v800) to `"bulk"` or by using the [`SET_VAR`](/optimizer-hints.md#set_varvar_namevar_value) hint.
54+
55+
</CustomContent>
56+
4957
## Usage
5058

5159
This section describes how to enable Pipelined DML and verify whether it takes effect.

system-variables.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1934,9 +1934,21 @@ Assume that you have a cluster with 4 TiDB nodes and multiple TiKV nodes. In thi
19341934
>
19351935
> The bulk DML execution mode (`tidb_dml_type = "bulk"`) is an experimental feature. It is not recommended that you use it in the production environment. This feature might be changed or removed without prior notice. If you find a bug, you can report an [issue](https://github.com/pingcap/tidb/issues). In the current version, when TiDB performs large transactions using the bulk DML mode, it might affect the memory usage and execution efficiency of TiCDC, TiFlash, and the resolved-ts module of TiKV, and might cause OOM issues. Additionally, BR might be blocked and fail to process when encountering locks. Therefore, it is not recommended to use this mode when these components or features are enabled.
19361936
1937+
<CustomContent platform="tidb-cloud" plan="starter">
1938+
19371939
> **Note:**
19381940
>
1939-
> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential).
1941+
> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter).
1942+
1943+
</CustomContent>
1944+
1945+
<CustomContent platform="tidb-cloud" plan="essential,premium">
1946+
1947+
> **Note:**
1948+
>
1949+
> This variable is read-only for [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) and [{{{ .premium }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier/#premium). The value is fixed to `"standard"`, so Pipelined DML cannot be enabled by setting this variable to `"bulk"`.
1950+
1951+
</CustomContent>
19401952
19411953
- Scope: SESSION
19421954
- Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): Yes
@@ -5598,19 +5610,19 @@ SHOW WARNINGS;
55985610
55995611
### tidb_replica_read <span class="version-mark">New in v4.0</span>
56005612
5601-
<CustomContent platform="tidb-cloud" plan="starter,essential">
5613+
<CustomContent platform="tidb-cloud" plan="starter">
56025614
56035615
> **Note:**
56045616
>
5605-
> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential).
5617+
> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter).
56065618
56075619
</CustomContent>
56085620
5609-
<CustomContent platform="tidb-cloud" plan="premium">
5621+
<CustomContent platform="tidb-cloud" plan="essential,premium">
56105622
56115623
> **Note:**
56125624
>
5613-
> This variable is read-only for [{{{ .premium }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier/#premium).
5625+
> This variable is read-only for [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) and [{{{ .premium }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier/#premium). The value is fixed to `leader`, and other read modes are not supported.
56145626
56155627
</CustomContent>
56165628
@@ -6625,7 +6637,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md).
66256637
- Persists to cluster: Yes
66266638
- Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): No
66276639
- Type: Enumeration
6628-
- Default value: `FAST`
6640+
- Default value: `STRICT` for [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) and [{{{ .premium }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier/#premium); `FAST` for other deployment options
66296641
- Possible values: `OFF`, `FAST`, `STRICT`
66306642
- This variable is used to control the assertion level. Assertion is a consistency check between data and indexes, which checks whether a key being written exists in the transaction commit process. For more information, see [Troubleshoot Inconsistency Between Data and Indexes](/troubleshoot-data-inconsistency-errors.md).
66316643

tidb-configuration-file.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -882,7 +882,7 @@ For pessimistic transaction usage, refer to [TiDB Pessimistic Transaction Mode](
882882
+ For scenarios with conflicts, after enabling this configuration, TiDB includes auto-commit transactions into the global lock-waiting management, which avoids deadlocks and mitigates the latency spike brought by deadlock-causing conflicts.
883883
+ For scenarios with no conflicts, if there are many auto-commit transactions (the specific number is determined by the real scenarios. For example, the number of auto-commit transactions accounts for more than half of the total number of applications), and a single transaction operates a large data volume, enabling this configuration causes performance regression. For example, the auto-commit `INSERT INTO SELECT` statement.
884884
+ When the session-level system variable [`tidb_dml_type`](/system-variables.md#tidb_dml_type-new-in-v800) is set to `"bulk"`, the effect of this configuration in the session is equivalent to setting it to `false`.
885-
+ Default value: `false`
885+
+ Default value: `true` for [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) and [{{{ .premium }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier/#premium); `false` for other deployment options
886886

887887
### constraint-check-in-place-pessimistic <span class="version-mark">New in v6.4.0</span>
888888

0 commit comments

Comments
 (0)