Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions system-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -1922,6 +1922,10 @@ Assume that you have a cluster with 4 TiDB nodes and multiple TiKV nodes. In thi
>
> 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.

> **Note:**
>
> 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).

- Scope: SESSION
- Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): Yes
- Type: String
Expand Down
1 change: 1 addition & 0 deletions tidb-cloud/limited-sql-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,7 @@ TiDB Cloud works with almost all workloads that TiDB supports, but there are som
| `tidb_ddl_reorg_batch_size` | No limitation | Read-only [^10] |
| `tidb_ddl_reorg_priority` | No limitation | Read-only [^10] |
| `tidb_ddl_reorg_worker_cnt` | No limitation | Read-only [^10] |
| `tidb_dml_type` | No limitation | Read-only [^10] |
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

This correctly adds the limitation for tidb_dml_type. To ensure documentation completeness and consistency, please also add a note in system-variables.md indicating that this variable is read-only for TiDB Cloud Starter and Essential clusters. This helps users who might only read that document and avoids potential confusion.

References
  1. The style guide emphasizes completeness in documentation (line 14). A corresponding note in system-variables.md is needed to make the documentation about this limitation complete. (link)
  2. The style guide suggests making changes if something might confuse a new user (line 63). The lack of a note in system-variables.md could be confusing. (link)

| `tidb_enable_1pc` | No limitation | Read-only [^10] |
| `tidb_enable_async_commit` | No limitation | Read-only [^10] |
| `tidb_enable_auto_analyze` | No limitation | Read-only [^10] |
Expand Down