vitess.io/vitess@v0.16.2/changelog/16.0/16.0.0/release_notes.md (about) 1 # Release of Vitess v16.0.0 2 ## Summary 3 4 ### Table of Contents 5 6 - **[Known Issues](#known-issues)** 7 - [MySQL & Xtrabackup known issue](#mysql-xtrabackup-ddl) 8 - **[Major Changes](#major-changes)** 9 - **[Breaking Changes](#breaking-changes)** 10 - [VTGate Advertised MySQL Version](#advertised-mysql-version) 11 - [Default MySQL version on Docker](#default-mysql-version) 12 - [⚠️ Upgrading to this release with vitess-operator](#upgrading-to-this-release-with-vitess-operator) 13 - [Flag Deletions and Deprecations](#flag-deletions-and-deprecations) 14 - [VTCtld](#vtctld-flag-deletions-deprecations) 15 - [MySQLCtl](#mysqlctl-flag-deletions-deprecations) 16 - [VTTablet](#vttablet-flag-deletions-deprecations) 17 - [VTBackup](#vtbackup-flag-deletions-deprecations) 18 - [VTOrc](#vtorc-flag-deletions-deprecations) 19 - [`lock-timeout` and `remote_operation_timeout` Changes](#lock-timeout-introduction) 20 - [Orchestrator Integration Deletion](#orc-integration-removal) 21 - [vtctld UI Removal](#vtcltd-ui-removal) 22 - [Query Serving Errors](#qs-errors) 23 - [Logstats Table and Keyspace removed](#logstats-table-keyspace) 24 - [Removed Stats](#removed-stats) 25 - [Deprecated Stats](#deprecated-stats) 26 - [Normalized labels in the Prometheus Exporter](#normalized-lables) 27 - **[Replication manager removal and VTOrc becomes mandatory](#repl-manager-removal)** 28 - **[VReplication](#vreplication)** 29 - [VStream Copy Resume](#vstream-copy-resume) 30 - [VDiff2 GA](#vdiff2-ga) 31 - **[Tablet throttler](#tablet-throttler)** 32 - **[Incremental backup and point in time recovery](#inc-backup)** 33 - **[New command line flags and behavior](#new-flag)** 34 - [VTGate: Support query timeout --query-timeout](#vtgate-query-timeout) 35 - [VTTablet: VReplication parallel insert workers --vreplication-parallel-insert-workers](#vrepl-parallel-workers) 36 - [VTTablet: --queryserver-config-pool-conn-max-lifetime](#queryserver-lifetime) 37 - [vttablet --throttler-config-via-topo](#vttablet-throttler-config) 38 - [vtctldclient UpdateThrottlerConfig](#vtctldclient-update-throttler) 39 - [vtctldclient Backup --incremental_from_pos](#vtctldclient-backup) 40 - [vtctldclient RestoreFromBackup --restore_to_pos](#vtctldclient-restore-from-backup) 41 - [New `vexplain` command](#new-vexplain-command) 42 - **[Important bug fixes](#important-bug-fixes)** 43 - [Corrupted results for non-full-group-by queries with JOINs](#corrupted-results) 44 - **[Deprecations and Removals](#deprecations-removals)** 45 - **[MySQL Compatibility](#mysql-compatibility)** 46 - [Transaction Isolation Level](#transaction-isolation-level) 47 - [Transaction Access Mode](#transaction-access-mode) 48 - [Support for views](#support-views) 49 - **[VTTestServer](#vttestserver)** 50 - [Performance Improvement](#perf-improvement) 51 - **[Minor Changes](#minor-changes)** 52 - **[Backup compression benchmarks](#backup-comp-benchmarks)** 53 - **[Refactor](#refactor)** 54 - **[VTTablet sidecar schema maintenance refactor](#vttablet-sidecar-schema)** 55 56 ## <a id="known-issues"/>Known Issues 57 58 ### <a id="mysql-xtrabackup-ddl"/>MySQL & Xtrabackup known issue 59 60 There is a known issue with MySQL's INSTANT DDL combined with Percona XtraBackup, that affects users of Vitess 16.0. 61 The problem is described in https://docs.percona.com/percona-xtrabackup/8.0/em/instant.html, and the immediate impact is you may not be able to backup your database using XtraBackup under certain conditions. 62 63 As of MySQL 8.0.12, the default `ALGORITHM` for InnoDB's `ALTER TABLE` is `INSTANT`. In `8.0.12` only a small number of operations were eligible for `INSTANT`, but MySQL `8.0.29` added support for more common cases. 64 Unfortunately, the changes in `8.0.29` affect XtraBackup as follows: if you `ALTER TABLE` in MySQL `8.0.29`, and that `ALTER` is eligible for `INSTANT` DDL (e.g. add new table column), then as of that moment, XtraBackup is unable to backup that table, hence your entire database. 65 66 It is important to note that even if you then upgrade your MySQL server to, e.g. `8.0.32`, the table still cannot be backed up. 67 68 Versions where XtraBackup is unable to backup such tables: MySQL `8.0.29` - `8.0.31`. This does not apply to Percona Server flavor. 69 70 The issue is resolved with Percona XtraBackup `8.0.32` combined with MySQL `8.0.32`. 71 72 You might be affected if: 73 74 - You're using MySQL `8.0.29` - `8.0.31` and are using XtraBackup to backup your database 75 - and, you have issued an `ALTER TABLE`, either directly, or using Online DDL in vitess `v16.0` and below 76 77 A futures Vitess patch release `v16.0.1` will address the issue via Online DDL migrations. 78 79 #### Mitigations 80 81 - Use Percona XtraBackup `8.0.32` combined with MySQL `8.0.32`. To go with this option, you can use the docker image `vitess/lite:v16.0.0-mysql-8.0.32`. 82 - or, Use a Percona Server flavor 83 - or, always ensure to add `ALGORITHM=INPLACE` or `ALGORITHM=COPY` to your `ALTER TABLE` statements 84 85 #### Workarounds 86 87 If you have already been affected, these are the options to be able to backup your database: 88 89 - Use `builtin` backups, see https://vitess.io/docs/15.0/user-guides/operating-vitess/backup-and-restore/creating-a-backup/. `builting` backups are not based on XtraBackup. 90 - Upgrade to MySQL `8.0.32` or above and to Xtrabackup `8.0.32`, or switch to Percona Server. To go with this option, you can use the docker image `vitess/lite:v16.0.0-mysql-8.0.32`. Then rebuild the table directly via: 91 - `OPTIMIZE TABLE your_table` 92 - or, `ALTER TABLE your_table ENGINE=INNOB` 93 - Upgrade to Vitess patch release `v16.0.1`, upgrade to MySQL `8.0.32` or above and to Xtrabackup `8.0.32`, or switch to Percona Server, and rebuild the table via Online DDL: 94 ```shell 95 $ vtctldclient ApplySchema --skip_preflight --ddl_strategy "vitess" --sql "ALTER TABLE your_table ENGINE=InnoDB" your_keyspace 96 ``` 97 or 98 ```sql 99 > SET @@ddl_strategy='vitess'; 100 > ALTER TABLE your_table ENGINE=InnoDB; 101 ``` 102 103 ## <a id="major-changes"/>Major Changes 104 105 ### <a id="breaking-changes"/>Breaking Changes 106 107 #### <a id="advertised-mysql-version"/>VTGate Advertised MySQL Version 108 109 Since [Pull Request #11989](https://github.com/vitessio/vitess/pull/11989), VTGate advertises MySQL version 8.0.30. This is a breaking change for clients that rely on the VTGate advertised MySQL version and still use MySQL 5.7. 110 The users can set the `mysql_server_version` flag to advertise the correct version. 111 112 It is worth noting that [the feature to avoid using reserved connections](https://vitess.io/docs/16.0/reference/query-serving/reserved-conn/#avoiding-the-use-of-reserved-connections) depends on the `mysql_server_version` CLI flag, which default value has been changed from `5.7.9-vitess` to `8.0.30-vitess`. We recommend that users running MySQL 5.7 set vtgate's `mysql_server_version` CLI flag to `5.7.9-vitess` to prevent the queries from being unexpectedly rewritten. 113 114 #### <a id="default-mysql-version"/>Default MySQL version on Docker 115 116 The default major MySQL version used by our `vitess/lite:latest` image is going from `5.7` to `8.0`. Additionally, the patch version of MySQL80 has been upgraded from `8.0.23` to `8.0.30`. 117 This change was brought by [Pull Request #12252](https://github.com/vitessio/vitess/pull/12252). 118 119 #### <a id="upgrading-to-this-release-with-vitess-operator"/>⚠️Upgrading to this release with vitess-operator 120 121 If you are using the vitess-operator and want to remain on MySQL 5.7, **you are required** to use the `vitess/lite:v16.0.0-mysql57` Docker Image, otherwise the `vitess/lite:v16.0.0` image will be on MySQL 80. 122 123 However, if you are running MySQL 8.0 on the vitess-operator, with for instance `vitess/lite:v15.0.2-mysql80`, considering that we are bumping the patch version of MySQL 80 from `8.0.23` to `8.0.30`, you will have to manually upgrade: 124 125 1. Add `innodb_fast_shutdown=0` to your extra cnf in your YAML file. 126 2. Apply this file. 127 3. Wait for all the pods to be healthy. 128 4. Then change your YAML file to use the new Docker Images (`vitess/lite:v16.0.0`, defaults to mysql80). 129 5. Remove `innodb_fast_shutdown=0` from your extra cnf in your YAML file. 130 6. Apply this file. 131 132 #### <a id="flag-deletions-and-deprecations"\>Flag Deletions and Deprecations 133 134 ##### <a id="vtctld-flag-deletions-deprecations"/>VTCtld 135 With the removal of the vtctld UI, the following vtctld flags have been deprecated: 136 - `--vtctld_show_topology_crud`: This was a flag that controlled the display of CRUD topology actions in the vtctld UI. The UI is removed, so this flag is no longer necessary. 137 138 The following deprecated flags have also been removed: 139 - `--enable_realtime_stats` 140 - `--enable_vtctld_ui` 141 - `--web_dir` 142 - `--web_dir2` 143 - `--workflow_manager_init` 144 - `--workflow_manager_use_election` 145 - `--workflow_manager_disable` 146 147 ##### <a id="mysqlctl-flag-deletions-deprecations"/>MySQLCtld 148 149 The [`mysqlctl` command-line client](https://vitess.io/docs/16.0/reference/programs/mysqlctl/) had some leftover (ignored) server flags after the [v15 pflag work](https://github.com/vitessio/enhancements/blob/main/veps/vep-4.md). Those unused flags have now been removed. If you are using any of the following flags with `mysqlctl` in your scripts or other tooling, they will need to be removed prior to upgrading to v16: 150 `--port --grpc_auth_static_client_creds --grpc_compression --grpc_initial_conn_window_size --grpc_initial_window_size --grpc_keepalive_time --grpc_keepalive_timeout` 151 152 ##### <a id="vttablet-flag-deletions-deprecations"/>VTTablet 153 154 The following flags were removed in v16: 155 - `--enable_semi_sync` 156 - `--backup_storage_hook`, use one of the builtin compression algorithms or `--external-compressor` and `--external-decompressor` instead. 157 - `--init_populate_metadata`, since we have deleted the `local_metadata` and `shard_metadata` sidecar database tables. 158 159 The flag `--disable-replication-manager` is deprecated and will be removed in a future release. 160 161 ##### <a id="vtbackup-flag-deletions-deprecations"/>VTBackup 162 163 The VTBackup flag `--backup_storage_hook` has been removed, use one of the builtin compression algorithms or `--external-compressor` and `--external-decompressor` instead. 164 165 166 ##### <a id="vtorc-flag-deletions-deprecations"/>VTOrc 167 168 The flag `--lock-shard-timeout` has been deprecated. Please use the newly introduced `--lock-timeout` flag instead. More detail [here](#lock-timeout-introduction). 169 170 #### <a id="lock-timeout-introduction"/>`lock-timeout` and `remote_operation_timeout` Changes 171 172 Before the changes made in [Pull Request #11881](https://github.com/vitessio/vitess/pull/11881), the shard and keyspace locks used to be capped by the `remote_operation_timeout`. This is no longer the case and instead a new flag called `lock-timeout` is introduced. 173 For backward compatibility, if `lock-timeout` is unspecified and `remote_operation_timeout` flag is provided, then its value will also be used for `lock-timeout`. 174 The default value for `remote_operation_timeout` has also changed from 30 seconds to 15 seconds. The default for the new flag `lock-timeout` is 45 seconds. 175 176 During upgrades, if the users want to preserve the same behaviour as previous releases, then they should provide the `remote_operation_timeout` flag explicitly before upgrading. 177 After the upgrade, they should then alter their configuration to also specify `lock-timeout` explicitly. 178 179 #### <a id="orc-integration-removal"/>Orchestrator Integration Deletion 180 181 Orchestrator integration in `vttablet` was deprecated in the previous release and is deleted in this release. 182 `VTOrc` should be deployed instead. You can read more on [how VTOrc is designed](https://vitess.io/docs/16.0/reference/vtorc/) and on [how to run VTOrc in production](https://vitess.io/docs/16.0/user-guides/configuration-basic/vtorc/). 183 184 #### <a id="vtcltd-ui-removal"/>vtctld web UI Removal 185 In v13, the vtctld UI was deprecated. As of this release, the `web/vtctld2` directory is deleted and the UI will no longer be included in any Vitess images going forward. All build scripts and the Makefile have been updated to reflect this change, which was done in [Pull Request #11851](https://github.com/vitessio/vitess/pull/11851) 186 187 However, the vtctld HTTP API will remain at `{$vtctld_web_port}/api`. 188 189 #### <a id="qs-errors"/>Query Serving Errors 190 191 In [Pull Request #10738](https://github.com/vitessio/vitess/pull/10738) we are introducing a new way to report errors from Vitess through the query interface. 192 Errors will now have an error code for each error, which will make it easy to search for more information on the issue. 193 For instance, the following error: 194 195 ``` 196 aggregate functions take a single argument 'count(user_id, name)' 197 ``` 198 199 Will be transformed into: 200 201 ``` 202 VT03001: aggregate functions take a single argument 'count(user_id, name)' 203 ``` 204 205 The error code `VT03001` can then be used to search or ask for help and report problems. 206 207 If you have code searching for error strings from Vitess, this is a breaking change. 208 Many error strings have been tweaked. 209 If your application is searching for specific errors, you might need to update your code. 210 211 #### <a id="logstats-table-keyspace"/>Logstats Table and Keyspace removed 212 213 Information about which tables are used is now reported by the field TablesUsed added in v15, that is a string array, listing all tables and which keyspace they are in. 214 The Table/Keyspace fields were deprecated in v15 and are now removed in the v16 release, more information can be found on [Pull Request #12083](https://github.com/vitessio/vitess/pull/12083). 215 216 #### <a id="removed-stats"/>Removed Stats 217 218 The stat `QueryRowCounts` is removed in v16 as part of [Pull Request #12083](https://github.com/vitessio/vitess/pull/12083). `QueryRowsAffected` and `QueryRowsReturned` can be used instead to gather the same information. 219 220 #### <a id="deprecated-stats"/>Deprecated Stats 221 222 The stats `QueriesProcessed` and `QueriesRouted` are deprecated in v16 as part of [Pull Request #12083](https://github.com/vitessio/vitess/pull/12083). The same information can be inferred from the stats `QueriesProcessedByTable` and `QueriesRoutedByTable` respectively. These stats will be removed in the next release. 223 224 #### <a id="normalized-lables"/>Normalized labels in the Prometheus Exporter 225 226 The Prometheus metrics exporter now properly normalizes _all_ label names into their `snake_case` form, as it is idiomatic for Prometheus metrics. Previously, Vitess instances were emitting inconsistent labels for their metrics, with some of them being `CamelCase` and others being `snake_case`. 227 More information about this change can be found on [Pull Request #12057](https://github.com/vitessio/vitess/pull/12057). 228 229 For example, `vtgate_topology_watcher_errors{Operation="GetTablet"} 0` will become `vtgate_topology_watcher_errors{operation="GetTablet"} 0` 230 231 Some more of these changes are listed here - 232 233 | Previous metric | New Metric | 234 |-------------------------------------------------------------|-------------------------------------------------------------| 235 | vtgate_topology_watcher_operations{Operation="AddTablet"} | vtgate_topology_watcher_operations{operation="AddTablet"} | 236 | vtgate_queries_processed{Plan="Reference"} | vtgate_queries_processed{plan="Reference"} | 237 | vtgate_queries_routed{Plan="Reference"} | vtgate_queries_routed{plan="Reference"} | 238 | vttablet_table_allocated_size{Table="corder"} | vttablet_table_allocated_size{table="corder"} | 239 | vttablet_table_file_size{Table="corder"} | vttablet_table_file_size{table="corder"} | 240 | vttablet_topology_watcher_errors{Operation="GetTablet"} | vttablet_topology_watcher_errors{operation="GetTablet"} | 241 | vttablet_topology_watcher_operations{Operation="AddTablet"} | vttablet_topology_watcher_operations{operation="AddTablet"} | 242 243 ### <a id="repl-manager-removal"/>Replication manager removal and VTOrc becomes mandatory 244 VTOrc is now a **required** component of Vitess starting from v16. If the users want Vitess to manage replication, then they must run VTOrc. 245 Replication manager is removed from vttablets since the responsibility of fixing replication lies entirely with VTOrc now. 246 The flag `disable-replication-manager` is deprecated and will be removed in a future release. 247 248 ### <a id="vreplication"/>VReplication 249 250 #### <a id="vstream-copy-resume"/>VStream Copy Resume 251 252 In [Pull Request #11103](https://github.com/vitessio/vitess/pull/11103) we introduced the ability to resume a `VTGate` [`VStream` copy operation](https://vitess.io/docs/16.0/reference/vreplication/vstream/). This is useful when a [`VStream` copy operation](https://vitess.io/docs/16.0/reference/vreplication/vstream/) is interrupted due to e.g. a network failure or a server restart. The `VStream` copy operation can be resumed by specifying each table's last seen primary key value in the `VStream` request. Please see the [`VStream` docs](https://vitess.io/docs/16.0/reference/vreplication/vstream/) for more details. 253 254 #### <a id="vdiff2-ga"/>VDiff2 GA 255 256 We are marking [VDiff v2](https://vitess.io/docs/16.0/reference/vreplication/vdiff2/) as production-ready in v16. We now recommend that you use v2 rather than v1 going forward. V1 will be deprecated and eventually removed in future releases. 257 If you wish to use v1 for any reason, you will now need to specify the `--v1` flag. 258 259 ### <a id="tablet-throttler"/>Tablet throttler 260 261 The tablet throttler can now be configured dynamically. Configuration is now found in the topo service, and applies to all tablets in all shards and cells of a given keyspace. 262 It is possible to enable or disable throttling, and to change the throttling threshold as well as the throttler query. 263 264 Please note that this feature is considered experimental in this release. For backwards compatibility `v16` still supports `vttablet`-based command line flags for throttler configuration. 265 266 More information can be found on [Pull Request #11604](https://github.com/vitessio/vitess/pull/11604). 267 268 ### <a id="inc-backup"/>Incremental backup and point in time recovery 269 270 In [Pull Request #11097](https://github.com/vitessio/vitess/pull/11097) we introduced native incremental backup and point in time recovery: 271 272 - It is possible to take an incremental backup, starting with last known (full or incremental) backup, and up to either a specified (GTID) position, or current ("auto") position. 273 - The backup is done by copying binary logs. The binary logs are rotated as needed. 274 - It is then possible to restore a backup up to a given point in time (GTID position). This involves finding a restore path consisting of a full backup and zero or more incremental backups, applied up to the given point in time. 275 - A server restored to a point in time remains in `DRAINED` tablet type, and does not join the replication stream (thus, "frozen" in time). 276 - It is possible to take incremental backups from different tablets. It is OK to have overlaps in incremental backup contents. The restore process chooses a valid path, and is valid as long as there are no gaps in the backed up binary log content. 277 278 ### <a id="new-flag"/>New command line flags and behavior 279 280 #### <a id="vtgate-query-timeout"/>VTGate: Support query timeout --query-timeout 281 282 `--query-timeout` allows you to specify a timeout for queries. This timeout is applied to all queries. 283 It can be overridden by setting the `query_timeout` session variable. 284 Setting it as query comment directive with `QUERY_TIMEOUT_MS` will override other values. 285 286 #### <a id="vrepl-parallel-workers"/>VTTablet: VReplication parallel insert workers --vreplication-parallel-insert-workers 287 288 `--vreplication-parallel-insert-workers=[integer]` enables parallel bulk inserts during the copy phase 289 of VReplication (disabled by default). When set to a value greater than 1 the bulk inserts — each 290 executed as a single transaction from the vstream packet contents — may happen in-parallel and 291 out-of-order, but the commit of those transactions are still serialized in order. 292 293 Other aspects of the VReplication copy-phase logic are preserved: 294 295 1. All statements executed when processing a vstream packet occur within a single MySQL transaction. 296 2. Writes to `_vt.copy_state` always follow their corresponding inserts from within the vstream packet. 297 3. The final `commit` for the vstream packet always follows the corresponding write to `_vt.copy_state`. 298 4. The vstream packets are committed in the order seen in the stream. So for any PK1 and PK2, the write to `_vt.copy_state` and `commit` steps (steps 2 and 3 above) for PK1 will both precede the `_vt.copy_state` write and commit steps of PK2. 299 300 Other phases, catchup, fast-forward, and replicating/"running", are unchanged. 301 302 #### <a id="queryserver-lifetime"/>VTTablet: --queryserver-config-pool-conn-max-lifetime 303 304 `--queryserver-config-pool-conn-max-lifetime=[integer]` allows you to set a timeout on each connection in the query server connection pool. It chooses a random value between its value and twice its value, and when a connection has lived longer than the chosen value, it'll be removed from the pool the next time it's returned to the pool. 305 306 #### <a id="vttablet-throttler-config"/>vttablet --throttler-config-via-topo 307 308 The flag `--throttler-config-via-topo` switches throttler configuration from `vttablet`-flags to the topo service. This flag is `false` by default, for backwards compatibility. It will default to `true` in future versions. 309 310 #### <a id="vtctldclient-update-throttler"/>vtctldclient UpdateThrottlerConfig 311 312 Tablet throttler configuration is now supported in `topo`. Updating the throttler configuration is done via `vtctldclient UpdateThrottlerConfig` and applies to all tablet in all cells for a given keyspace. 313 314 Examples: 315 316 ```shell 317 # disable throttler; all throttler checks will return with "200 OK" 318 $ vtctldclient UpdateThrottlerConfig --disable commerce 319 320 # enable throttler; checks are responded with appropriate status per current metrics 321 $ vtctldclient UpdateThrottlerConfig --enable commerce 322 323 # Both enable and set threshold in same command. Since no query is indicated, we assume the default check for replication lag 324 $ vtctldclient UpdateThrottlerConfig --enable --threshold 5.0 commerce 325 326 # Change threshold. Does not affect enabled/disabled state of the throttler 327 $ vtctldclient UpdateThrottlerConfig --threshold 1.5 commerce 328 329 # Use a custom query 330 $ vtctldclient UpdateThrottlerConfig --custom_query "show global status like 'threads_running'" --check_as_check_self --threshold 50 commerce 331 332 # Restore default query and threshold 333 $ vtctldclient UpdateThrottlerConfig --custom_query "" --check_as_check_shard --threshold 1.5 commerce 334 ``` 335 336 See https://github.com/vitessio/vitess/pull/11604 337 338 #### <a id="vtctldclient-backup"/>vtctldclient Backup --incremental_from_pos 339 340 The `Backup` command now supports `--incremental_from_pos` flag, which can receive a valid position or the value `auto`. For example: 341 342 ```shell 343 $ vtctlclient -- Backup --incremental_from_pos "MySQL56/16b1039f-22b6-11ed-b765-0a43f95f28a3:1-615" zone1-0000000102 344 $ vtctlclient -- Backup --incremental_from_pos "auto" zone1-0000000102 345 ``` 346 347 When the value is `auto`, the position is evaluated as the last successful backup's `Position`. The idea with incremental backups is to create a contiguous (overlaps allowed) sequence of backups that store all changes from last full backup. 348 349 The incremental backup copies binary log files. It does not take MySQL down nor places any locks. It does not interrupt traffic on the MySQL server. The incremental backup copies complete binlog files. It initially rotates binary logs, then copies anything from the requested position and up to the last completed binary log. 350 351 The backup thus does not necessarily start _exactly_ at the requested position. It starts with the first binary log that has newer entries than requested position. It is OK if the binary logs include transactions prior to the requested position. The restore process will discard any duplicates. 352 353 Normally, you can expect the backups to be precisely contiguous. Consider an `auto` value: due to the nature of log rotation and the fact we copy complete binlog files, the next incremental backup will start with the first binay log not covered by the previous backup, which in itself copied the one previous binlog file in full. Again, it is completely valid to enter any good position. 354 355 The incremental backup fails if it is unable to attain binary logs from given position (ie binary logs have been purged). 356 357 The manifest of an incremental backup has a non-empty `FromPosition` value, and a `Incremental = true` value. 358 359 #### <a id="vtctldclient-restore-from-backup"/>vtctldclient RestoreFromBackup --restore_to_pos 360 361 - `--restore_to_pos`: request to restore the server up to the given position (inclusive) and not one step further. 362 - `--dry_run`: when `true`, calculate the restore process, if possible, evaluate a path, but exit without actually making any changes to the server. 363 364 Examples: 365 366 ```shell 367 $ vtctlclient -- RestoreFromBackup --restore_to_pos "MySQL56/16b1039f-22b6-11ed-b765-0a43f95f28a3:1-220" zone1-0000000102 368 ``` 369 370 The restore process seeks a restore _path_: a sequence of backups (handles/manifests) consisting of one full backup followed by zero or more incremental backups, that can bring the server up to the requested position, inclusive. 371 372 The command fails if it cannot evaluate a restore path. Possible reasons: 373 374 - there's gaps in the incremental backups 375 - existing backups don't reach as far as requested position 376 - all full backups exceed requested position (so there's no way to get into an ealier position) 377 378 The command outputs the restore path. 379 380 There may be multiple restore paths, the command prefers a path with the least number of backups. This has nothing to say about the amount and size of binary logs involved. 381 382 The `RestoreFromBackup --restore_to_pos` ends with: 383 384 - the restored server in intentionally broken replication setup 385 - tablet type is `DRAINED` 386 387 #### <a id="new-vexplain-command"/>New `vexplain` command 388 A new `vexplain` command has been introduced with the following syntax: 389 ``` 390 VEXPLAIN [ALL|QUERIES|PLAN] explainable_stmt 391 ``` 392 393 This command will help users look at the plan that vtgate comes up with for the given query (`PLAN` type), see all the queries that are executed on all the MySQL instances (`QUERIES` type), and see the vtgate plan along with the MySQL explain output for the executed queries (`ALL` type). 394 395 The formats `VTEXPLAIN` and `VITESS` for `EXPLAIN` queries are deprecated, and these newly introduced commands should be used instead. 396 397 ### <a id="important-bug-fixes"/>Important bug fixes 398 399 #### <a id="corrupted-results"/>Corrupted results for non-full-group-by queries with JOINs 400 401 An issue in versions `<= v14.0.3` and `<= v15.0.0` that generated corrupted results for non-full-group-by queries with a JOIN 402 is now fixed. The full issue can be found [here](https://github.com/vitessio/vitess/issues/11625), and its fix [here](https://github.com/vitessio/vitess/pull/11633). 403 404 ### <a id="deprecations-removals"/>Deprecations and Removals 405 406 - The V3 planner is deprecated as of the v16 release, and will be removed in the v17 release of Vitess. 407 408 - The [VReplication v1 commands](https://vitess.io/docs/15.0/reference/vreplication/v1/) — which were deprecated in Vitess 11.0 — have been removed. You will need to use the [VReplication v2 commands](https://vitess.io/docs/16.0/reference/vreplication/v2/) instead. 409 410 - The `vtctlclient VExec` command was removed, having been deprecated since v12. 411 412 - The `vtctlclient VReplicationExec` command has now been deprecated and will be removed in a future release. Please see [#12070](https://github.com/vitessio/vitess/pull/12070) for additional details. 413 414 - `vtctlclient OnlineDDL ... [complete|retry|cancel|cancel-all]` returns empty result on success instead of number of shard affected. 415 416 - The dead legacy Workflow Manager related code was removed in [#12085](https://github.com/vitessio/vitess/pull/12085). This included the following `vtctl` client commands: `WorkflowAction`, `WorkflowCreate`, `WorkflowWait`, `WorkflowStart`, `WorkflowStop`, `WorkflowTree`, `WorkflowDelete`. 417 418 - VTAdmin's `VTExplain` endpoint has been deprecated. Users can use the new `vexplain` query format instead. The endpoint will be deleted in a future release. 419 420 ### <a id="mysql-compatibility"/>MySQL Compatibility 421 422 #### <a id="transaction-isolation-level"/>Transaction Isolation Level 423 424 In [Pull Request #11704](https://github.com/vitessio/vitess/pull/11704) we are adding support for `set [session] transaction isolation level <transaction_characteristic>` 425 426 ```sql 427 transaction_characteristic: { 428 ISOLATION LEVEL level 429 | access_mode 430 } 431 432 level: { 433 REPEATABLE READ 434 | READ COMMITTED 435 | READ UNCOMMITTED 436 | SERIALIZABLE 437 } 438 ``` 439 440 This will set the transaction isolation level for the current session. 441 This will be applied to any shard where the session will open a transaction. 442 443 #### <a id="transaction-access-mode"/>Transaction Access Mode 444 445 In [Pull Request #11704](https://github.com/vitessio/vitess/pull/11704) we are adding support for `start transaction` with transaction characteristic. 446 447 ```sql 448 START TRANSACTION 449 [transaction_characteristic [, transaction_characteristic] ...] 450 451 transaction_characteristic: { 452 WITH CONSISTENT SNAPSHOT 453 | READ WRITE 454 | READ ONLY 455 } 456 ``` 457 458 This will allow users to start a transaction with these characteristics. 459 460 #### <a id="support-views"/>Support For Views 461 462 Views sharded support is released as an experimental feature in `v16.0.0`. 463 Views are not enabled by default in your Vitess cluster, but they can be turned on using the `--enable-views` flag on VTGate, and `--queryserver-enable-views` flag on VTTablet. 464 465 To read more on how views are implemented you can read the [Views Support RFC](https://github.com/vitessio/vitess/issues/11559). 466 And if you want to learn more on how to use views and its current limitations, you can read the [Views Documentation](https://vitess.io/docs/16.0/reference/compatibility/mysql-compatibility/#views). 467 468 ### <a id="vttestserver"/>VTTestServer 469 470 #### <a id="perf-improvement"/>Performance Improvement 471 472 Creating a database with vttestserver was taking ~45 seconds. This can be problematic in test environments where testcases do a lot of `create` and `drop` database. 473 In an effort to minimize the database creation time, in [Pull Request #11918](https://github.com/vitessio/vitess/pull/11918) we have changed the value of `tablet_refresh_interval` to 10s while instantiating vtcombo during vttestserver initialization. We have also made this configurable so that it can be reduced further if desired. 474 For any production cluster the default value of this flag is still [1 minute](https://vitess.io/docs/16.0/reference/programs/vtgate/). Reducing this value might put more stress on Topo Server (since we now read from Topo server more often) but for testing purposes 475 this shouldn't be a concern. 476 477 ## <a id="minor-changes"/>Minor changes 478 479 ### <a id="backup-comp-benchmarks"/>Backup Compression Benchmarks 480 481 Compression benchmarks have been added to the `mysqlctl` package. 482 483 The benchmarks fetch and compress a ~6 GiB tar file containing 3 InnoDB files using different built-in and external compressors. 484 485 Here are sample results from a 2020-era Mac M1 with 16 GiB of memory: 486 487 ```sh 488 $ go test -bench=BenchmarkCompress ./go/vt/mysqlctl -run=NONE -timeout=12h -benchtime=1x -v 489 goos: darwin 490 goarch: arm64 491 pkg: vitess.io/vitess/go/vt/mysqlctl 492 BenchmarkCompressLz4Builtin 493 compression_benchmark_test.go:310: downloading data from https://www.dropbox.com/s/raw/smmgifsooy5qytd/enwiki-20080103-pages-articles.ibd.tar.zst 494 BenchmarkCompressLz4Builtin-8 1 11737493087 ns/op 577.98 MB/s 2.554 compression-ratio 495 BenchmarkCompressPargzipBuiltin 496 BenchmarkCompressPargzipBuiltin-8 1 31083784040 ns/op 218.25 MB/s 2.943 compression-ratio 497 BenchmarkCompressPgzipBuiltin 498 BenchmarkCompressPgzipBuiltin-8 1 13325299680 ns/op 509.11 MB/s 2.910 compression-ratio 499 BenchmarkCompressZstdBuiltin 500 BenchmarkCompressZstdBuiltin-8 1 18683863911 ns/op 363.09 MB/s 3.150 compression-ratio 501 BenchmarkCompressZstdExternal 502 BenchmarkCompressZstdExternal-8 1 10795487675 ns/op 628.41 MB/s 3.093 compression-ratio 503 BenchmarkCompressZstdExternalFast4 504 BenchmarkCompressZstdExternalFast4-8 1 7139319009 ns/op 950.23 MB/s 2.323 compression-ratio 505 BenchmarkCompressZstdExternalT0 506 BenchmarkCompressZstdExternalT0-8 1 4393860434 ns/op 1543.97 MB/s 3.093 compression-ratio 507 BenchmarkCompressZstdExternalT4 508 BenchmarkCompressZstdExternalT4-8 1 4389559744 ns/op 1545.49 MB/s 3.093 compression-ratio 509 PASS 510 cleaning up "/var/folders/96/k7gzd7q10zdb749vr02q7sjh0000gn/T/ee7d47b45ef09786c54fa2d7354d2a68.dat" 511 ``` 512 513 ## <a id="refactor"/>Refactor 514 515 ### <a id="vttablet-sidecar-schema"/>VTTablet Sidecar Schema Maintenance Refactor 516 517 This is an internal refactor and should not change the behavior of Vitess as seen by users. 518 519 Developers will see a difference though: v16 changes the way we maintain vttablet's sidecar database schema (also referred to as the `_vt` 520 database). Instead of using the `WithDDL` package, introduced in [PR #6348](https://github.com/vitessio/vitess/pull/6348), we use a 521 declarative approach. Developers will now have to update the desired schema in the `go/vt/sidecardb/schema` directory. 522 523 The desired schema is specified, one per table. A new module `sidecardb`, compares this to the existing schema and 524 performs the required `create` or `alter` to reach it. This is done whenever a primary vttablet starts up. 525 526 The sidecar tables `local_metadata` and `shard_metadata` are no longer in use and all references to them are removed as 527 part of this refactor. They were used previously for Orchestrator support, which has been superseded by `vtorc`. 528 529 ------------ 530 The entire changelog for this release can be found [here](https://github.com/vitessio/vitess/blob/main/changelog/16.0/16.0.0/changelog.md). 531 532 The release includes 378 commits (excluding merges) 533 534 Thanks to all our contributors: @EmadMokhtar, @GuptaManan100, @Weijun-H, @WilliamLu99, @ajm188, @arthurschreiber, @arvind-murty, @brendar, @brirams, @dbussink, @deepthi, @dependabot[bot], @draftcode, @ejortegau, @frouioui, @harshit-gangal, @jjh-kim, @johanoskarsson, @kbslvsk, @mattlord, @maxenglander, @mdlayher, @notfelineit, @pbibra, @pudiva, @rohit-nayak-ps, @rsajwani, @shlomi-noach, @systay, @timvaillancourt, @vitess-bot[bot], @vmg, @yoheimuta 535