Skip to content

Commit

Permalink
Update docs of SHARD_ROW_ID_BITS (#13519)
Browse files Browse the repository at this point in the history
  • Loading branch information
Oreoxmt authored Mar 27, 2023
1 parent 3f1e8cf commit 252fe9f
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 6 deletions.
2 changes: 1 addition & 1 deletion clustered-indexes.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ CREATE TABLE t (a BIGINT, b VARCHAR(255), PRIMARY KEY(a, b) /*T![clustered_index
CREATE TABLE t (a BIGINT, b VARCHAR(255), PRIMARY KEY(a, b) /*T![clustered_index] NONCLUSTERED */);
```

对于未显式指定该关键字的语句,默认行为受系统变量 `@@global.tidb_enable_clustered_index` 影响。该变量有三个取值:
对于未显式指定该关键字的语句,默认行为受系统变量 [`@@global.tidb_enable_clustered_index`](/system-variables.md#tidb_enable_clustered_index-从-v50-版本开始引入) 影响。该变量有三个取值:

- `OFF` 表示所有主键默认使用非聚簇索引。
- `ON` 表示所有主键默认使用聚簇索引。
Expand Down
15 changes: 12 additions & 3 deletions shard-row-id-bits.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,24 @@ aliases: ['/docs-cn/dev/shard-row-id-bits/']

## 基本概念

对于非[聚簇索引表](/clustered-indexes.md),TiDB 会使用一个隐式的自增 rowid。大量执行 `INSERT` 插入语句时会把数据集中写入单个 Region,造成写入热点。
对于非[聚簇索引](/clustered-indexes.md)主键或没有主键的表,TiDB 会使用一个隐式的自增 rowid。大量执行 `INSERT` 插入语句时会把数据集中写入单个 Region,造成写入热点。

通过设置 `SHARD_ROW_ID_BITS`,可以把 rowid 打散写入多个不同的 Region,缓解写入热点问题。

- `SHARD_ROW_ID_BITS = 4` 表示 16 个分片
- `SHARD_ROW_ID_BITS = 6` 表示 64 个分片
- `SHARD_ROW_ID_BITS = 0` 表示默认值 1 个分片

关于 `SHARD_ROW_ID_BITS` 的更多使用信息,可参考[使用 SHARD_ROW_ID_BITS 处理热点表](/troubleshoot-hot-spot-issues.md#使用-shard_row_id_bits-处理热点表)

## 语句示例

- `CREATE TABLE`: `CREATE TABLE t (c int) SHARD_ROW_ID_BITS = 4;`
- `ALTER TABLE`: `ALTER TABLE t SHARD_ROW_ID_BITS = 4;`
```sql
CREATE TABLE t (
id INT PRIMARY KEY NONCLUSTERED
) SHARD_ROW_ID_BITS = 4;
```

```sql
ALTER TABLE t SHARD_ROW_ID_BITS = 4;
```
4 changes: 2 additions & 2 deletions troubleshoot-hot-spot-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,9 @@ Value: null

## 使用 SHARD_ROW_ID_BITS 处理热点表

对于主键非整数或没有主键的表或者是联合主键,TiDB 会使用一个隐式的自增 RowID,大量 INSERT 时会把数据集中写入单个 Region,造成写入热点。
对于非聚簇索引主键或没有主键的表,TiDB 会使用一个隐式的自增 RowID,大量 `INSERT` 时会把数据集中写入单个 Region,造成写入热点。

通过设置 `SHARD_ROW_ID_BITS`,可以把 RowID 打散写入多个不同的 Region,缓解写入热点问题。
通过设置 [`SHARD_ROW_ID_BITS`](/shard-row-id-bits.md),可以把 RowID 打散写入多个不同的 Region,缓解写入热点问题。

```
SHARD_ROW_ID_BITS = 4 表示 16 个分片
Expand Down

0 comments on commit 252fe9f

Please sign in to comment.