Skip to content

Commit

Permalink
releases: add tidb 5.0-rc release notes (#4600) (#4604)
Browse files Browse the repository at this point in the history
* cherry pick #4600 to release-5.0

Signed-off-by: ti-srebot <ti-srebot@pingcap.com>

* resolve conflicts

Co-authored-by: Charlotte Liu <37295236+CharLotteiu@users.noreply.github.com>
Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
  • Loading branch information
3 people authored Jan 12, 2021
1 parent e6202c9 commit ae34c7a
Show file tree
Hide file tree
Showing 10 changed files with 212 additions and 16 deletions.
3 changes: 3 additions & 0 deletions TOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

+ About TiDB
+ [TiDB Introduction](/overview.md)
+ [What's New in TiDB 5.0](/releases/release-5.0.0-rc.md)
+ [Basic Features](/basic-features.md)
+ Benchmarks
+ [Interaction Test on Online Workloads and `ADD INDEX`](/benchmark/online-workloads-and-add-index-operations.md)
Expand Down Expand Up @@ -513,6 +514,8 @@
+ Release Notes
+ [All Releases](/releases/release-notes.md)
+ [TiDB Roadmap](/roadmap.md)
+ v5.0
+ [5.0.0-rc](/releases/release-5.0.0-rc.md)
+ v4.0
+ [4.0.9](/releases/release-4.0.9.md)
+ [4.0.8](/releases/release-4.0.8.md)
Expand Down
2 changes: 1 addition & 1 deletion _index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Designed for the cloud, TiDB provides flexible scalability, reliability and secu

- [TiDB Introduction](/overview.md)
- [Basic Features](/basic-features.md)
- [What's New in TiDB 4.0](/whats-new-in-tidb-4.0.md)
- [What's New in TiDB 5.0](/releases/release-5.0.0-rc.md)
- [Compatibility with MySQL](/mysql-compatibility.md)
- [Usage Limitations](/tidb-limitations.md)
- [TiDB Adopters](/adopters.md)
Expand Down
2 changes: 1 addition & 1 deletion clustered-indexes.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ summary: Learn how clustered indexes apply to TiDB.

# Clustered Indexes

The clustered index is an experimental feature introduced in TiDB 5.0.0-rc. This document provides multiple examples to explain how this feature makes a difference to the query performance of TiDB. To enable this feature and see the detailed operation guide, see [tidb_enable_clustered_index](/system-variables.md#tidb_enable_clustered_index).
The clustered index is an experimental feature introduced in TiDB 5.0.0-rc. This document provides multiple examples to explain how this feature makes a difference to the query performance of TiDB. To enable this feature and see the detailed operation guide, see [tidb_enable_clustered_index](/system-variables.md#tidb_enable_clustered_index-new-in-v500-rc).

Clustered indexes provide TiDB the ability to organize tables in a way that can improve the performance of certain queries. The term _clustered_ in this context refers to the _organization of how data is stored_ and not _a group of database servers working together_. Some database management systems refer to clustered indexes as _index-organized tables_ (IOT).

Expand Down
2 changes: 1 addition & 1 deletion log-redaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ To enable log redaction in the TiKV side, set the value of [`security.redact-inf

## Log redaction in PD side

To enable log redaction in the PD side, set the value of [`security.redact-info-log`](/pd-configuration-file.md#redact-info-log) to `true`. This configuration value defaults to `false`, which means that log redaction is disabled.
To enable log redaction in the PD side, set the value of [`security.redact-info-log`](/pd-configuration-file.md#redact-info-log-new-in-v500-rc) to `true`. This configuration value defaults to `false`, which means that log redaction is disabled.
4 changes: 2 additions & 2 deletions pd-configuration-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ Configuration items related to security
+ The path of the PEM file that contains the X509 key
+ Default value: ""

### `redact-info-log` <!-- New in v5.0.0-rc -->
### `redact-info-log` <span class="version-mark">New in v5.0.0-rc</span>

+ Controls whether to enable log redaction in the PD log.
+ When you set the configuration value to `true`, user data is redacted in the PD log.
Expand Down Expand Up @@ -314,7 +314,7 @@ Configuration items related to scheduling
+ Determines the maximum number of operations related to adding peers within a minute
+ Default value: `15`

### `enable-joint-consensus` <!-- New in v5.0.0-rc -->
### `enable-joint-consensus` <span class="version-mark">New in v5.0.0-rc</span>

> **Warning:**
>
Expand Down
189 changes: 189 additions & 0 deletions releases/release-5.0.0-rc.md

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions releases/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ title: Release Notes

# TiDB Release Notes

## 5.0

- [5.0.0-rc](/releases/release-5.0.0-rc.md)

## 4.0

- [4.0.9](/releases/release-4.0.9.md)
Expand Down
14 changes: 7 additions & 7 deletions system-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ SET GLOBAL tidb_distsql_scan_concurrency = 10;
- Default value: 0
- This variable is used to show whether the execution plan used in the previous `execute` statement is taken directly from the plan cache.

### last_plan_from_binding <!-- New in v5.0.0-rc -->
### last_plan_from_binding <span class="version-mark">New in v5.0.0-rc</span>

- Scope: SESSION
- Default value: 0
Expand Down Expand Up @@ -303,7 +303,7 @@ Constraint checking is always performed in place for pessimistic transactions (d
- Default value: 0
- This variable is used to control whether to enable the cascades planner, which is currently considered experimental.

### tidb_enable_clustered_index <!-- New in v5.0.0-rc -->
### tidb_enable_clustered_index <span class="version-mark">New in v5.0.0-rc</span>

- Scope: SESSION | GLOBAL
- Default value: 0
Expand Down Expand Up @@ -975,7 +975,7 @@ explain select * from t where age=5;
- TiDB triggers an alarm when the percentage of the memory it takes exceeds a certain threshold. For the detailed usage description of this feature, see [`memory-usage-alarm-ratio`](/tidb-configuration-file.md#memory-usage-alarm-ratio-new-in-v409).
- You can set the initial value of this variable by configuring [`memory-usage-alarm-ratio`](/tidb-configuration-file.md#memory-usage-alarm-ratio-new-in-v409).
### `tidb_track_aggregate_memory_usage` <!-- New in v5.0.0-rc -->
### `tidb_track_aggregate_memory_usage` <span class="version-mark">New in v5.0.0-rc</span>
> **Warning:**
>
Expand All @@ -985,14 +985,14 @@ explain select * from t where age=5;
- Default value: OFF
- This variable controls whether to track the memory usage of the aggregate function. When you enable this feature, TiDB counts the memory usage of the aggregate function, which might cause the overall SQL memory statistics to exceed the threshold [`mem-quota-query`](/tidb-configuration-file.md#mem-quota-query), and then be affected by the behavior defined by [`oom-action`](/tidb-configuration-file.md#oom-action).
### `tidb_enable_async_commit` <!-- New in v5.0.0-rc -->
### `tidb_enable_async_commit` <span class="version-mark">New in v5.0.0-rc</span>
> **Warning:**
>
> Async commit is still an experimental feature. It is not recommended to use this feature in the production environment. Currently, the following incompatible issues are found, and be aware of them if you need to use this feature:
> - This feature is incompatible with [TiCDC](/ticdc/ticdc-overview.md) and might cause TiCDC to run abnormally.
> - This feature is incompatible with [Compaction Filter](/tikv-configuration-file.md#enable-compaction-filter). If you use the two features at the same time, write loss might occur.
> - This feature is incompatible with [Compaction Filter](/tikv-configuration-file.md#enable-compaction-filter-new-in-v500-rc). If you use the two features at the same time, write loss might occur.
> - This feature is incompatible with TiDB Binlog and does not take effect when TiDB Binlog is enabled.
- Scope: SESSION | GLOBAL
Expand All @@ -1001,9 +1001,9 @@ explain select * from t where age=5;
> **Warning:**
>
> When async commit is enabled, the external consistency of transactions cannot be guaranteed. For details, refer to [`tidb_guarantee_external_consistency`](#tidb_guarantee_external_consistency).
> When async commit is enabled, the external consistency of transactions cannot be guaranteed. For details, refer to [`tidb_guarantee_external_consistency`](#tidb_guarantee_external_consistency-new-in-v500-rc).
### `tidb_guarantee_external_consistency` <!-- New in v5.0.0-rc -->
### `tidb_guarantee_external_consistency` <span class="version-mark">New in v5.0.0-rc</span>
- Scope: SESSION | GLOBAL
- Default value: OFF
Expand Down
4 changes: 2 additions & 2 deletions tidb-configuration-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@ Configuration items related to performance.
- Default value: `5000`
- If a transaction does not roll back or commit after the number of statements exceeds `stmt-count-limit`, TiDB returns the `statement count 5001 exceeds the transaction limitation, autocommit = false` error. This configuration takes effect **only** in the retriable optimistic transaction. If you use the pessimistic transaction or have disabled the transaction retry, the number of statements in a transaction is not limited by this configuration.

### `txn-entry-size-limit` <!-- New in v5.0.0-rc -->
### `txn-entry-size-limit` <span class="version-mark">New in v5.0.0-rc</span>

- The size limit of a single row of data in TiDB.
- Default value: `6291456` (in bytes)
Expand Down Expand Up @@ -462,7 +462,7 @@ The Plan Cache configuration of the `PREPARE` statement.
- The threshold of the TiKV load. If the TiKV load exceeds this threshold, more `batch` packets are collected to relieve the pressure of TiKV. It is valid only when the value of `tikv-client.max-batch-size` is greater than `0`. It is recommended not to modify this value.
- Default value: `200`

## tikv-client.async-commit <!-- New in v5.0.0-rc -->
## tikv-client.async-commit <span class="version-mark">New in v5.0.0-rc</span>

### `keys-limit`

Expand Down
4 changes: 2 additions & 2 deletions tikv-configuration-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -749,7 +749,7 @@ Configuration items related to RocksDB
+ Minimum value: `1`
+ Maximum value: `3`

### `rate-limiter-auto-tuned` <!-- New in v5.0.0-rc -->
### `rate-limiter-auto-tuned` <span class="version-mark">New in v5.0.0-rc</span>

+ Determines whether to automatically optimize the configuration of the RocksDB's compaction rate limiter based on recent workload. When this configuration is enabled, compaction pending bytes will be slightly higher than usual.
+ Default value: `true`
Expand Down Expand Up @@ -1247,7 +1247,7 @@ Configuration items related to TiDB Lightning import and BR restore.

## gc

### `enable-compaction-filter` <!-- New in v5.0.0-rc -->
### `enable-compaction-filter` <span class="version-mark">New in v5.0.0-rc</span>

+ Controls whether to enable the GC in Compaction Filter feature
+ Default value: `false`
Expand Down

0 comments on commit ae34c7a

Please sign in to comment.