Skip to content

Commit bb5ab90

Browse files
patrickbirchpatrickbirch
committed
Merge pull request #571 from percona/ps-10190
PS-10190 [DOCS] - Binary Log UDFs functions documentation incomplete 8.4
2 parents 9274626 + 28041c1 commit bb5ab90

18 files changed

+1312
-403
lines changed

‎docs/8.4-breaking-changes.md‎

Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
# Breaking and incompatible changes in {{vers}}
2+
3+
Review these items before upgrading from 8.0 to {{vers}}. This document covers breaking behavioral changes, removed features, and removed variables that may affect your upgrade. Each entry includes the impact, replacement (if available), and recommended action.
4+
5+
## Authentication and user management
6+
7+
Impact:
8+
9+
* `mysql_native_password` is disabled by default in {{vers}}; new users default to `caching_sha2_password`.
10+
11+
* The `mysql_native_password` plugin can still be loaded using `--mysql-native-password=ON` if needed for backward compatibility.
12+
13+
* In the 9.x series, `mysql_native_password` will be completely removed.
14+
15+
* `default_authentication_plugin` variable is removed.
16+
17+
Replacement:
18+
19+
* New users default to `caching_sha2_password`; configure authentication via supported mechanisms without this variable.
20+
21+
Action:
22+
23+
* Identify accounts and applications using `mysql_native_password` and plan migration to `caching_sha2_password`.
24+
* If necessary for temporary compatibility, you can enable `mysql_native_password` with `--mysql-native-password=ON`, but plan to migrate accounts as this plugin will be removed in future versions.
25+
* Validate driver/client support for `caching_sha2_password` and TLS.
26+
* Ensure drivers and clients support `caching_sha2_password`.
27+
28+
## Replication terminology and commands
29+
30+
Impact:
31+
32+
* MASTER/SLAVE terms and statements are removed in {{vers}} and will cause syntax errors if used.
33+
34+
* Statements such as `CHANGE MASTER TO`, `START SLAVE`, `STOP SLAVE`, and `SHOW SLAVE STATUS` are no longer supported.
35+
36+
* Related status variables and counters (for example, `Com_show_slave_status`) are also removed.
37+
38+
Replacement:
39+
40+
* Use SOURCE/REPLICA equivalents: `START REPLICA`, `SHOW REPLICA STATUS`, `CHANGE REPLICATION SOURCE TO` and updated status fields.
41+
42+
Action:
43+
44+
* Update operational scripts, automation, and runbooks to new commands before upgrading.
45+
46+
* Search for and replace all MASTER/SLAVE statements in your codebase with their SOURCE/REPLICA equivalents.
47+
48+
* Update scripts, automation, and monitoring that reference removed statements or counters.
49+
50+
* Re-test replication lifecycle: provisioning, change-source, failover.
51+
52+
## Spatial indexes
53+
54+
Impact:
55+
56+
* A known issue can corrupt a spatial index (R-Tree index) in MySQL 8.4.0 through 8.4.4. The corruption is triggered when an `UPDATE` that slightly changes a geometry's MBR (Minimum Bounding Rectangle) is immediately followed by a `DELETE` of the same row. The R-Tree index can retain a dangling leaf, leading to "Incorrect key file" errors.
57+
58+
Action:
59+
60+
* Upgrade to 8.4.5 or later, which fixes this issue.
61+
62+
* If you must remain on 8.4.0-8.4.4, apply one of these workarounds:
63+
* Serialize UPDATE and DELETE statements (ensure they don't execute in immediate succession)
64+
* Rebuild the spatial index after operations that might trigger the bug
65+
* Set `innodb_rtree_index_update_interval=0` to disable deferred updates
66+
67+
* If you're planning an upgrade from 8.0 or an earlier 8.4 point release, schedule a pre-upgrade test that exercises an update-then-delete pattern on a table with a spatial index. Verify the index remains healthy with `CHECK TABLE ... EXTENDED`. This will surface the bug before you move production data.
68+
69+
* As a precautionary measure, you can drop spatial indexes before upgrade and re-create them after upgrade, then verify integrity.
70+
71+
## New reserved keywords
72+
73+
Impact:
74+
75+
* New reserved words (for example, `MANUAL`, `PARALLEL`, `QUALIFY`, `TABLESAMPLE`) may conflict with unquoted identifiers and break queries.
76+
77+
Action:
78+
79+
* Scan schemas and queries for unquoted usage; quote or rename objects.
80+
81+
* See: [Keywords and Reserved Words in MySQL {{vers}}](https://dev.mysql.com/doc/refman/{{vers}}/en/keywords.html) for the complete list of reserved keywords.
82+
83+
84+
## Data type restrictions
85+
86+
Impact:
87+
88+
* `AUTO_INCREMENT` is not permitted on `FLOAT` or `DOUBLE`.
89+
90+
Action:
91+
92+
* Convert these columns to `INTEGER` before upgrading.
93+
94+
## Removed SQL function
95+
96+
Impact:
97+
98+
* `WAIT_UNTIL_SQL_THREAD_AFTER_GTIDS()` function is removed (deprecated in 8.0).
99+
100+
Replacement:
101+
102+
* `WAIT_FOR_EXECUTED_GTID_SET()`.
103+
104+
Action:
105+
106+
* Replace function usage in procedures, scripts, and runbooks.
107+
108+
## Binary log retention variable
109+
110+
Impact:
111+
112+
* `expire_logs_days` variable is removed.
113+
114+
Replacement:
115+
116+
* `binlog_expire_logs_seconds`.
117+
118+
Action:
119+
120+
* Adjust configuration and automation to use seconds-based retention.
121+
122+
## Memcached-related variables and APIs
123+
124+
Impact:
125+
126+
* Built-in memcached integration variables (for example, `daemon_memcached`, `innodb_api`, and related settings) are removed.
127+
128+
Replacement:
129+
130+
* Externalize caching at the application tier or separate cache services.
131+
132+
Action:
133+
134+
* Remove dependencies on the built-in memcached functionality.
135+
136+
## Further reading
137+
138+
* [Upgrade overview](./upgrade.md)
139+
* [Upgrade checklist for {{vers}}](./upgrade-checklist-8.4.md)
140+
* [Upgrade procedures for {{vers}}](./upgrade-procedures.md)
141+
* [Upgrade strategies](./upgrade-strategies.md)
142+
* [MySQL upgrade paths and supported methods](./mysql-upgrade-paths.md)
143+
* [Upgrade from plugins to components](./upgrade-components.md)
144+
* [Upgrade to Percona Server for MySQL Pro](./upgrade-pro.md)
145+
* [Downgrade options](./downgrade.md)
146+
* [Compatibility and removed items in {{vers}}](./8.4-compatibility-and-removed-items.md)
147+
* [Defaults and tuning guidance for {{vers}}](./8.4-defaults-and-tuning.md)
148+
* [Percona Toolkit updates for {{vers}}](./percona-toolkit-8.4-updates.md)
149+
150+

‎docs/8.4-compatibility-and-removed-items.md‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# Compatibility and removed items in {{vers}}
2+
3+
A successful migration requires identifying and addressing all removed parameters, variables, and functions. Using removed items in configuration files or application code will cause errors and prevent server startup or application execution.
4+
5+
## Removed server and replication system variables
6+
7+
| Variable Name | Description | Replacement |
8+
| --- | --- | --- |
9+
| `avoid_temporal_upgrade` | Whether ALTER TABLE should upgrade pre-5.6.4 temporal columns | No replacement |
10+
| `binlog_transaction_dependency_tracking` | Source of dependency information for multithreaded applier | Functionality is now internal; WRITESET is the default and the only available mode |
11+
| `character-set-client-handshake` | Do not ignore client-side character set value sent during handshake | No replacement |
12+
| `default_authentication_plugin` | Default authentication plugin | `authentication_policy` |
13+
| `expire_logs_days` | Purge binary logs after a number of days | `binlog_expire_logs_seconds` |
14+
| `group_replication_ip_whitelist` | List of hosts permitted to connect to the group | No replacement |
15+
| `group_replication_primary_member` | Primary member UUID when in single-primary mode | No replacement |
16+
| `group_replication_recovery_complete_at` | Recovery policies when handling cached transactions | No replacement |
17+
| `have_openssl` | Whether the server supports SSL connections | No replacement |
18+
| `have_ssl` | Whether the server supports SSL connections | No replacement |
19+
| `innodb_api_...` variables | All innodb_api variables related to built-in memcached functionality | No replacement |
20+
21+
## Removed server options, SQL statements, and status variables
22+
23+
| Item Name | Type | Replacement |
24+
| --- | --- | --- |
25+
| `admin-ssl` | Server Option | `--tls-version` and `--admin-tls-version` |
26+
| `authentication_fido_rp_id` | Server Option | No replacement |
27+
| `--language` | Server Option | No replacement |
28+
| `--old` and `--new` | Server Option | No replacement |
29+
| `Com_change_master` | Status Variable | `Com_change_replication_source` |
30+
| `Com_show_master_status` | Status Variable | `Com_show_binary_log_status` |
31+
| `Com_show_slave_status` | Status Variable | `Com_show_replica_status` |
32+
| `Com_slave_start` | Status Variable | `Com_replica_start` |
33+
| `Com_slave_stop` | Status Variable | `Com_replica_stop` |
34+
| `CHANGE MASTER TO` | SQL Statement | `CHANGE REPLICATION SOURCE TO` |
35+
| `SHOW SLAVE STATUS` | SQL Statement | `SHOW REPLICA STATUS` |
36+
| `START SLAVE` | SQL Statement | `START REPLICA` |
37+
| `STOP SLAVE` | SQL Statement | `STOP REPLICA` |
38+
| `SHOW MASTER STATUS` | SQL Statement | `SHOW BINARY LOG STATUS` |
39+
| `RESET MASTER` | SQL Statement | `RESET BINARY LOGS AND GTIDS` |
40+
| `WAIT_UNTIL_SQL_THREAD_AFTER_GTIDS()` | SQL Function | `WAIT_FOR_EXECUTED_GTID_SET()` |
41+
42+
## Third-party tool compatibility
43+
44+
### Percona XtraBackup (PXB)
45+
46+
* **Version-specific backups**: Percona XtraBackup 8.4 creates backups of MySQL 8.4, Percona Server for MySQL 8.4, and Percona XtraDB Cluster 8.4 only.
47+
* **Compatibility**: Does not support backing up databases from MySQL 8.0 or 9.x servers.
48+
* **Action**: Upgrade XtraBackup to version 8.4 before or during the database upgrade.
49+
50+
### Percona Operator for MySQL
51+
52+
* **Upgrade method**: Create a new PXC 8.4 installation using the Percona Operator for PXC 8.4.
53+
* **Data migration**: Recover data from an 8.0 backup, then establish asynchronous replication between clusters.
54+
* **In-place upgrade**: Not recommended; may work but is not guaranteed.
55+
56+
### ProxySQL
57+
58+
* **MySQL 8.4 support**: Recent versions support MySQL 8.4 and include Group Replication support for 8.4 and 9.x.
59+
* **Authentication**: ProxySQL 2.6+ supports `caching_sha2_password` (default in 8.4).
60+
* **Replication terminology**: Compatible with SOURCE/REPLICA syntax; can monitor replica lag and manage traffic accordingly.
61+
62+
## Pre-upgrade validation
63+
64+
Use these tools to identify compatibility issues:
65+
66+
* **mysqlsh upgrade checker**: Identifies many removed parameters and compatibility issues.
67+
* **Manual review**: Cross-reference your configuration files and application code against the removed items tables above.
68+
* **Third-party tooling**: Verify versions of backup utilities, proxies, and monitoring solutions.
69+
70+
## Further reading
71+
72+
* [Upgrade overview](./upgrade.md)
73+
* [Upgrade checklist for {{vers}}](./upgrade-checklist-8.4.md)
74+
* [Upgrade procedures for {{vers}}](./upgrade-procedures.md)
75+
* [Upgrade strategies](./upgrade-strategies.md)
76+
* [MySQL upgrade paths and supported methods](./mysql-upgrade-paths.md)
77+
* [Upgrade from plugins to components](./upgrade-components.md)
78+
* [Upgrade to Percona Server for MySQL Pro](./upgrade-pro.md)
79+
* [Downgrade options](./downgrade.md)
80+
* [Breaking and incompatible changes in {{vers}}](./8.4-breaking-changes.md)
81+
* [Defaults and tuning guidance for {{vers}}](./8.4-defaults-and-tuning.md)
82+
* [Percona Toolkit updates for {{vers}}](./percona-toolkit-8.4-updates.md)

‎docs/8.4-defaults-and-tuning.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Defaults and tuning guidance for {{vers}}
2+
3+
MySQL {{vers}} updates several server defaults to align with modern CPUs, memory sizes, and SSD/NVMe storage. An in-place upgrade that blindly reuses an 8.0-era `my.cnf` may forgo these improvements or cause unexpected performance behaviors. Review and re-evaluate configuration on {{vers}}—or generate a new config—rather than carrying old settings forward.
4+
5+
## Notable InnoDB default changes
6+
7+
| InnoDB System Variable Name | New Default ({{vers}}) | Previous Default (8.0) |
8+
| --- | --- | --- |
9+
| `innodb_adaptive_hash_index` | OFF | ON |
10+
| `innodb_change_buffering` | none | all |
11+
| `innodb_doublewrite_files` | 2 | `innodb_buffer_pool_instances * 2` |
12+
| `innodb_doublewrite_pages` | 128 | 4 |
13+
| `innodb_flush_method` on Linux | O_DIRECT if supported, otherwise fsync | fsync |
14+
| `innodb_io_capacity` | 10000 | 200 |
15+
| `innodb_log_buffer_size` | 67108864 (64 MiB) | 16777216 (16 MiB) |
16+
| `innodb_numa_interleave` | ON | OFF |
17+
| `temptable_max_ram` | 3% of total memory (1–4 GiB range) | 1073741824 (1 GiB) |
18+
| `innodb_parallel_read_threads` | available logical processors / 8 (min 4) | 4 |
19+
20+
Why it matters:
21+
22+
* Higher `innodb_io_capacity` leverages SSD/NVMe for IO-bound workloads; legacy spinning disks may need a lower value.
23+
* Larger `innodb_log_buffer_size` reduces redo flush frequency—helpful for write-heavy workloads.
24+
* `innodb_adaptive_hash_index` default OFF favors predictability; AHI can become a contention source under concurrency.
25+
* NUMA interleaving defaults ON to reduce imbalance on multi-socket systems.
26+
27+
## Configuration review checklist
28+
29+
Use this to adapt an 8.0 configuration to {{vers}}:
30+
31+
* Remove overrides that merely reassert old 8.0 defaults unless they are proven necessary.
32+
* Re-evaluate IO settings (`innodb_io_capacity`, flush method) based on storage type and observed latency.
33+
* Confirm redo/undo settings and log buffer meet current write patterns.
34+
* Validate parallel read threads relative to CPU topology and workload.
35+
* Generate a fresh config for {{vers}} when possible; only reapply carefully justified overrides.
36+
37+
## Practical evaluation steps
38+
39+
* Benchmark with your workload: baseline on 8.0 → restore to {{vers}} → run the same tests.
40+
* Compare Performance Schema and wait events for regressions or new hotspots.
41+
* Adjust a single variable at a time; document changes and impacts.
42+
43+
## Further reading
44+
45+
* [Upgrade overview](./upgrade.md)
46+
* [Upgrade checklist for {{vers}}](./upgrade-checklist-8.4.md)
47+
* [Upgrade procedures for {{vers}}](./upgrade-procedures.md)
48+
* [Upgrade strategies](./upgrade-strategies.md)
49+
* [MySQL upgrade paths and supported methods](./mysql-upgrade-paths.md)
50+
* [Upgrade from plugins to components](./upgrade-components.md)
51+
* [Upgrade to Percona Server for MySQL Pro](./upgrade-pro.md)
52+
* [Downgrade options](./downgrade.md)
53+
* [Breaking and incompatible changes in {{vers}}](./8.4-breaking-changes.md)
54+
* [Compatibility and removed items in {{vers}}](./8.4-compatibility-and-removed-items.md)
55+
* [Percona Toolkit updates for {{vers}}](./percona-toolkit-8.4-updates.md)
56+
57+

0 commit comments

Comments
 (0)