Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

releases: add release notes for v8.4.0 #18829

Merged
merged 109 commits into from
Nov 11, 2024
Merged
Changes from 5 commits
Commits
Show all changes
109 commits
Select commit Hold shift + click to select a range
e74c805
releases: add release notes for v8.4.0
Oreoxmt Sep 6, 2024
248c152
Update release-8.4.0.md
benmeadowcroft Sep 17, 2024
d05fef6
update client-side log backup, BR reduces requires storage permission…
Oreoxmt Sep 18, 2024
e6766c3
Update releases/release-8.4.0.md
hfxsd Sep 20, 2024
fd38263
Update releases/release-8.4.0.md
hfxsd Sep 20, 2024
d433b0c
Apply suggestions from code review
hfxsd Sep 20, 2024
95b7f2e
Apply suggestions from code review
hfxsd Sep 23, 2024
c38c9e4
update TiProxy traffic replay
Oreoxmt Sep 23, 2024
842af14
Update releases/release-8.4.0.md
hfxsd Sep 23, 2024
2ada230
add Instance-level execution plan cache
Oreoxmt Sep 23, 2024
31cb7fa
Update release-8.4.0.md
benmeadowcroft Sep 23, 2024
f0bbf31
update TiCDC and removal of TiDB Binlog
Oreoxmt Sep 24, 2024
6707391
Apply suggestions from code review
hfxsd Sep 25, 2024
d246991
Update feature highlights
lilin90 Sep 25, 2024
e5331ec
Update release-8.4.0.md
lilin90 Sep 25, 2024
55fcebc
Update release-8.4.0.md
lilin90 Sep 25, 2024
c9afc5f
update BR reduces storage permission for restores, TiCDC Claim-Check,…
Oreoxmt Sep 25, 2024
1f997f4
Apply suggestions from code review
qiancai Sep 25, 2024
07b9178
add link for highlights and update improvements
Oreoxmt Sep 25, 2024
aeb29e4
fix HTML table
Oreoxmt Sep 25, 2024
6a313f9
fix HTML table
Oreoxmt Sep 25, 2024
2bea170
Add more descriptions
lilin90 Sep 25, 2024
c7bc219
add translation of new features
qiancai Sep 26, 2024
d7e16a3
add translation for BR highlights
qiancai Sep 26, 2024
6be2f6d
Update TiDB Binlog removal
lilin90 Sep 26, 2024
0793443
add GitHub issue link for automatic statistics collection
Oreoxmt Sep 26, 2024
858595f
Remove foreign key GA
lilin90 Sep 26, 2024
bcf3e86
wording updates
qiancai Sep 26, 2024
3675a62
Apply suggestions from code review
hfxsd Sep 26, 2024
a7cb901
Apply suggestions from code review
hfxsd Sep 27, 2024
ee4b865
Update wording
lilin90 Sep 27, 2024
424e941
Apply suggestions from code review
lilin90 Sep 27, 2024
10a6495
Apply suggestions from code review
lilin90 Sep 27, 2024
cdcd682
Update releases/release-8.4.0.md
qiancai Sep 27, 2024
cac1db3
Refine descriptions
lilin90 Sep 27, 2024
21d5e7a
Update rowspan to fix format
lilin90 Sep 27, 2024
d16fab5
Add one highlight
lilin90 Sep 27, 2024
9516711
add a contributor for vector search
Oreoxmt Sep 29, 2024
afd91e4
align with Chinese
Oreoxmt Sep 29, 2024
3f64d28
Update releases/release-8.4.0.md
qiancai Sep 29, 2024
7675436
Apply suggestions from code review
qiancai Sep 29, 2024
3b5e9ec
Apply suggestions from code review
Oreoxmt Sep 29, 2024
d60d449
fix Checksum V2
Oreoxmt Sep 30, 2024
e1d2129
Apply suggestions from code review
Oreoxmt Sep 30, 2024
3653bd5
Apply suggestions from code review
qiancai Sep 30, 2024
2677e3b
Remove description for gb18030
lilin90 Oct 8, 2024
cd8dec1
compatibility changes: tidb_enable_inl_join_inner_multi_pattern, tidb…
Oreoxmt Oct 8, 2024
c12d361
Add more removed system variables and parameters
lilin90 Oct 8, 2024
c9423d7
Update wording
lilin90 Oct 8, 2024
4704aa7
Add parameter "logical-import-prep-stmt"
lilin90 Oct 8, 2024
be80d65
add improvement and bug fix
Oreoxmt Oct 10, 2024
b2d6296
update removed and deprecated features
Oreoxmt Oct 10, 2024
140d4a9
Apply suggestions from code review
qiancai Oct 10, 2024
f05c933
update descriptions of tidb_tso_client_rpc_mode
qiancai Oct 11, 2024
f2c867b
Update releases/release-8.4.0.md
qiancai Oct 11, 2024
f5f7ba1
add compatibility changes for tidb_tso_client_rpc_mode
qiancai Oct 11, 2024
d00d204
add compatibility changes for BR log backup
qiancai Oct 11, 2024
3e387b5
Update releases/release-8.4.0.md
qiancai Oct 11, 2024
a01a7fa
Add binary changes
lilin90 Oct 11, 2024
838ebbc
update the description for storage.format_version
qiancai Oct 11, 2024
a751e1a
add compatibility changes for cert-allowed-cn
qiancai Oct 11, 2024
d674189
Apply suggestions from code review
hfxsd Oct 12, 2024
1fdba45
Apply suggestions from code review
hfxsd Oct 12, 2024
00590e0
Apply suggestions from code review
hfxsd Oct 12, 2024
a3e86de
translate TiKV, PD, and TiFlash improvements + TiFlash bug fixes
qiancai Oct 14, 2024
8c87871
Apply suggestions from code review
hfxsd Oct 14, 2024
ae80887
compatibility changes: sort lines
Oreoxmt Oct 14, 2024
4646f3a
update improvements > TiDB and bug fixes > BR, TiDB Lightning
Oreoxmt Oct 14, 2024
4956ce6
Apply suggestions from code review
hfxsd Oct 15, 2024
1931bd6
Update bug fixes
lilin90 Oct 15, 2024
2613ae6
Update format
lilin90 Oct 15, 2024
8f1d082
releases: add 13 bug fixes
lilin90 Oct 15, 2024
7d83563
Apply suggestions from code review
lilin90 Oct 15, 2024
1e822ee
Apply suggestions from code review
qiancai Oct 15, 2024
ad81810
Apply suggestions from code review
lilin90 Oct 16, 2024
7b7a1f1
Apply suggestions from code review
Oreoxmt Oct 16, 2024
4205b14
Apply suggestions from code review
hfxsd Oct 21, 2024
0b101bb
Update links
lilin90 Oct 21, 2024
79410d4
remove empty notes
Oreoxmt Oct 21, 2024
bfc839f
Merge branch 'master' into v8.4.0/release-notes
Oreoxmt Oct 21, 2024
067a8b8
remove Behavior changes and deprecated features in v8.4.0
Oreoxmt Oct 21, 2024
4aa2fb5
update dup for improvements and bug fixes
Oreoxmt Oct 21, 2024
65c08e5
Merge branch 'master' into v8.4.0/release-notes
Oreoxmt Oct 23, 2024
b216201
add Contributors
Oreoxmt Oct 23, 2024
5679df2
Update wording and parameter order
lilin90 Oct 23, 2024
a3217bf
fix a broken link
Oreoxmt Oct 23, 2024
9420ec5
make ci happy
Oreoxmt Oct 23, 2024
ee9dd3a
make ci happy
Oreoxmt Oct 23, 2024
e98e2f1
move vector search improvements to new features section
Oreoxmt Oct 25, 2024
e2038e5
update instance-level plan cache
Oreoxmt Oct 28, 2024
2b33262
- update TSO RPC mode
Oreoxmt Oct 28, 2024
cd8d355
update release date, fix format
Oreoxmt Oct 28, 2024
95c16f7
release notes: remove comments
Oreoxmt Oct 28, 2024
8d20cd5
update TOC.md, release-timeline.md, release-notes.md, README.md
Oreoxmt Oct 28, 2024
3bf9042
Apply suggestions from code review
hfxsd Oct 28, 2024
d663eaa
Update releases/release-8.4.0.md
hfxsd Oct 30, 2024
7a749c2
update release date
Oreoxmt Oct 30, 2024
35f5ff4
update release date
Oreoxmt Oct 30, 2024
35e47b1
Merge branch 'v8.4.0/release-notes' into remove-comments-in-release-n…
Oreoxmt Nov 5, 2024
5779aa1
Merge pull request #7 from Oreoxmt/remove-comments-in-release-notes
Oreoxmt Nov 5, 2024
48672bb
Apply suggestions from code review
Oreoxmt Nov 5, 2024
9641249
fix format
Oreoxmt Nov 6, 2024
f15c0f9
fix the format of deprecated features
Oreoxmt Nov 6, 2024
a1fb1d7
fix typo "tiproxyctrl"
Oreoxmt Nov 6, 2024
03db660
remove duplicated "the"
Oreoxmt Nov 6, 2024
ece425d
highlight: fix format
Oreoxmt Nov 6, 2024
5e32654
remove empty list
Oreoxmt Nov 6, 2024
acdb8e0
Apply suggestions from code review
Oreoxmt Nov 11, 2024
0db0413
Update wording
lilin90 Nov 11, 2024
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
230 changes: 230 additions & 0 deletions releases/release-8.4.0.md
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Original file line number Diff line number Diff line change
@@ -0,0 +1,230 @@
---
title: TiDB 8.4.0 Release Notes
summary: Learn about the new features, compatibility changes, improvements, and bug fixes in TiDB 8.4.0.
---

# TiDB 8.4.0 Release Notes

Release date: xx xx, 2024

TiDB version: 8.4.0

Quick access: [Quick start](https://docs.pingcap.com/tidb/v8.4/quick-start-with-tidb)

8.4.0 introduces the following key features and improvements:

hfxsd marked this conversation as resolved.
Show resolved Hide resolved
## Feature details

### Scalability

* Feature summary [#issue-number](issue-link) @[pr-auorthor-id](author-link)

Feature descriptions (including what the feature is, why it is valuable for users, and how to use this feature generally)

For more information, see [documentation](doc-link).

### Performance

* Feature summary [#issue-number](issue-link) @[pr-auorthor-id](author-link)

Feature descriptions (including what the feature is, why it is valuable for users, and how to use this feature generally)

For more information, see [documentation](doc-link).

hfxsd marked this conversation as resolved.
Show resolved Hide resolved
qiancai marked this conversation as resolved.
Show resolved Hide resolved
* The performance of batch user creation and password changes has been improved by hundreds of times [#55604](https://github.com/pingcap/tidb/pull/55604) @[wjhuang2016](https://github.com/wjhuang2016) **tw@hfxsd** <!--1941-->

In SaaS scenarios, you might need to batch-create a large number of users, rotate passwords periodically, and complete these tasks within a specific time window. Starting from v8.4.0, the performance of batch user creation and password rotation has been significantly improved. Additionally, you can further enhance performance by increasing concurrency through a higher number of session connections, which greatly reduces execution time for these operations.

Check warning on line 36 in releases/release-8.4.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [PingCAP.Ambiguous] Consider using a clearer word than 'a large number of' because it may cause confusion. Raw Output: {"message": "[PingCAP.Ambiguous] Consider using a clearer word than 'a large number of' because it may cause confusion.", "location": {"path": "releases/release-8.4.0.md", "range": {"start": {"line": 36, "column": 55}}}, "severity": "INFO"}
hfxsd marked this conversation as resolved.
Show resolved Hide resolved

* Partitioned tables support global indexes (GA) [#45133](https://github.com/pingcap/tidb/issues/45133) @[mjonss](https://github.com/mjonss) @[Defined2014](https://github.com/Defined2014) @[jiyfhust](https://github.com/jiyfhust) @[L-maple](https://github.com/L-maple)
hfxsd marked this conversation as resolved.
Show resolved Hide resolved

In previous versions of partitioned tables, some limitations exist because global indexes are not supported. For example, the unique key must use every column in the table's partitioning expression. If the query condition does not use the partitioning key, the query will scan all partitions, resulting in poor performance. Starting from v7.6.0, the system variable [`tidb_enable_global_index`](/system-variables.md#tidb_enable_global_index-new-in-v760) is introduced to enable the global index feature. But this feature was under development at that time and it is not recommended to enable it.
hfxsd marked this conversation as resolved.
Show resolved Hide resolved
lilin90 marked this conversation as resolved.
Show resolved Hide resolved

Starting with v8.3.0, the global index feature is released as an experimental feature. You can explicitly create a global index for a partitioned table with the keyword `Global` to remove the restriction that the unique key must use every column in the table's partitioning expression, to meet flexible business needs. Global indexes also enhance the performance of queries that do not include partition keys.
lilin90 marked this conversation as resolved.
Show resolved Hide resolved

In v8.4.0, this feature becomes generally available (GA).
hfxsd marked this conversation as resolved.
Show resolved Hide resolved

For more information, see [documentation](/partitioned-table.md#global-indexes).

* Optimize query performance for cached tables in some scenarios [#43249](https://github.com/pingcap/tidb/issues/43249) @[tiancaiamao](https://github.com/tiancaiamao) **tw@hfxsd** <!--1965-->

Optimize the query performance of cached tables by up to 5.4 times when using `IndexLookup` to execute `SELECT ... LIMIT 1` with `IndexLookup`. Improve the performance of `IndexLookupReader` in full table scan and primary key query scenarios.
lilin90 marked this conversation as resolved.
Show resolved Hide resolved

### Reliability

* Feature summary [#issue-number](issue-link) @[pr-auorthor-id](author-link)

Feature descriptions (including what the feature is, why it is valuable for users, and how to use this feature generally)

For more information, see [documentation](doc-link).

hfxsd marked this conversation as resolved.
Show resolved Hide resolved
### Availability

* Feature summary [#issue-number](issue-link) @[pr-auorthor-id](author-link)

Feature descriptions (including what the feature is, why it is valuable for users, and how to use this feature generally)

For more information, see [documentation](doc-link).

### SQL

* Feature summary [#issue-number](issue-link) @[pr-auorthor-id](author-link)

Feature descriptions (including what the feature is, why it is valuable for users, and how to use this feature generally)

For more information, see [documentation](doc-link).

qiancai marked this conversation as resolved.
Show resolved Hide resolved
### DB operations

* PITR adds client-side log backup data encryption support (experimental) [55834](https://github.com/pingcap/tidb/issues/55834) @[Tristan1900](https://github.com/Tristan1900) **tw@qiancai** <!--1920-->

Previously only the data from a snapshot based backup could be encrypted (on the client side) with a data key provided by the user. With this feature, log backups may now also be encrypted, ensuring that the confidentiality of information within the backup data is secured.

For more information, see [documentation](doc-link).
qiancai marked this conversation as resolved.
Show resolved Hide resolved

* BR reduces requires storage permissions for restores [#55870](https://github.com/pingcap/tidb/issues/55870) @[Leavrth](https://github.com/Leavrth) **tw@Oreoxmt** <!--1943-->

Previously, when BR was restoring data, checkpoint information about the progress of the restore was recorded in the location hosting the backup data. These restore checkpoints enabled restoration to be quickly resumed if it was interrupted. With this feature, the restore checkpoints are now stored in the target TiDB cluster. This means that BR only requires read access to the backup dataset location for restores.

For more information, see [documentation](doc-link).

* Feature summary [#issue-number](issue-link) @[pr-auorthor-id](author-link)

Feature descriptions (including what the feature is, why it is valuable for users, and how to use this feature generally)

For more information, see [documentation](doc-link).

### Observability

* Feature summary [#issue-number](issue-link) @[pr-auorthor-id](author-link)

Feature descriptions (including what the feature is, why it is valuable for users, and how to use this feature generally)

For more information, see [documentation](doc-link).
hfxsd marked this conversation as resolved.
Show resolved Hide resolved

### Security

* TiDB BR Supports AWS IMDSv2 [#16443](https://github.com/tikv/tikv/issues/16443) @[pingyu](https://github.com/pingyu) **tw@hfxsd** <!--1945-->

TiDB BR now supports AWS's Instance Metadata Service Version 2 (IMDSv2) when deployed on AWS EC2. This enables users to configure the newer session-oriented method on their EC2 instances, and for BR to be able to successfully use the IAM Role associated with the instance to access AWS S3 with the appropriate privileges.

For more information, see [documentation](/backup-and-restore-storages#authentication).
hfxsd marked this conversation as resolved.
Show resolved Hide resolved

* Feature summary [#issue-number](issue-link) @[pr-auorthor-id](author-link)

Feature descriptions (including what the feature is, why it is valuable for users, and how to use this feature generally)

For more information, see [documentation](doc-link).

### Data migration

* Feature summary [#issue-number](issue-link) @[pr-auorthor-id](author-link)

Feature descriptions (including what the feature is, why it is valuable for users, and how to use this feature generally)

For more information, see [documentation](doc-link).

## Compatibility changes

> **Note:**
>
> This section provides compatibility changes you need to know when you upgrade from v8.3.0 to the current version (v8.4.0). If you are upgrading from v8.2.0 or earlier versions to the current version, you might also need to check the compatibility changes introduced in intermediate versions.

Oreoxmt marked this conversation as resolved.
Show resolved Hide resolved
Oreoxmt marked this conversation as resolved.
Show resolved Hide resolved
### Behavior changes

* Behavior change

### System variables

| Variable name | Change type | Description |
|--------|------------------------------|------|
| | | |
hfxsd marked this conversation as resolved.
Show resolved Hide resolved
| | | |
hfxsd marked this conversation as resolved.
Show resolved Hide resolved
| | | |
hfxsd marked this conversation as resolved.
Show resolved Hide resolved
| | | |

### Configuration file parameters

| Configuration file | Configuration parameter | Change type | Description |
| -------- | -------- | -------- | -------- |
hfxsd marked this conversation as resolved.
Show resolved Hide resolved
| | | | |
| | | | |
| | | | |
| | | | |

qiancai marked this conversation as resolved.
Show resolved Hide resolved
### System tables

## Offline package changes

## Deprecated features

* The following features are deprecated starting from v8.4.0:

* Deprecated feature

* The following features are planned for deprecation in future versions:

* TiDB introduces the system variable [`tidb_enable_auto_analyze_priority_queue`](/system-variables.md#tidb_enable_auto_analyze_priority_queue-new-in-v800), which controls whether priority queues are enabled to optimize the ordering of tasks that automatically collect statistics. In future releases, the priority queue will be the only way to order tasks for automatically collecting statistics, so this system variable will be deprecated.
* TiDB introduces the system variable [`tidb_enable_async_merge_global_stats`](/system-variables.md#tidb_enable_async_merge_global_stats-new-in-v750) in v7.5.0. You can use it to set TiDB to use asynchronous merging of partition statistics to avoid OOM issues. In future releases, partition statistics will be merged asynchronously, so this system variable will be deprecated.
* It is planned to redesign [the automatic evolution of execution plan bindings](/sql-plan-management.md#baseline-evolution) in subsequent releases, and the related variables and behavior will change.
* In v8.0.0, TiDB introduces the [`tidb_enable_parallel_hashagg_spill`](/system-variables.md#tidb_enable_parallel_hashagg_spill-new-in-v800) system variable to control whether TiDB supports disk spill for the concurrent HashAgg algorithm. In future versions, the [`tidb_enable_parallel_hashagg_spill`](/system-variables.md#tidb_enable_parallel_hashagg_spill-new-in-v800) system variable will be deprecated.
* The TiDB Lightning parameter [`conflict.max-record-rows`](/tidb-lightning/tidb-lightning-configuration.md#tidb-lightning-task) is planned for deprecation in a future release and will be subsequently removed. This parameter will be replaced by [`conflict.threshold`](/tidb-lightning/tidb-lightning-configuration.md#tidb-lightning-task), which means that the maximum number of conflicting records is consistent with the maximum number of conflicting records that can be tolerated in a single import task.

hfxsd marked this conversation as resolved.
Show resolved Hide resolved
* The following features are planned for removal in future versions:

* Starting from v8.0.0, TiDB Lightning deprecates the [old version of conflict detection](/tidb-lightning/tidb-lightning-physical-import-mode-usage.md#the-old-version-of-conflict-detection-deprecated-in-v800) strategy for the physical import mode, and enables you to control the conflict detection strategy for both logical and physical import modes via the [`conflict.strategy`](/tidb-lightning/tidb-lightning-configuration.md#tidb-lightning-task) parameter. The [`duplicate-resolution`](/tidb-lightning/tidb-lightning-configuration.md) parameter for the old version of conflict detection will be removed in a future release.

## Improvements

+ TiDB

hfxsd marked this conversation as resolved.
Show resolved Hide resolved
+ TiKV

hfxsd marked this conversation as resolved.
Show resolved Hide resolved
+ PD

qiancai marked this conversation as resolved.
Show resolved Hide resolved
+ TiFlash

+ Tools

+ Backup & Restore (BR)

+ TiCDC

+ TiDB Data Migration (DM)

+ TiDB Lightning

+ Dumpling

+ TiUP

+ TiDB Binlog

## Bug fixes

+ TiDB

+ TiKV

+ PD

+ TiFlash

+ Tools

+ Backup & Restore (BR)

+ TiCDC

+ TiDB Data Migration (DM)

+ TiDB Lightning

+ Dumpling

+ TiUP

+ TiDB Binlog

## Contributors

We would like to thank the following contributors from the TiDB community:
Loading