Docs: INSTANT DDL and RANGE PARTITIONING support for managed schema migrations
#1899
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Shlomi Noach <[email protected]>
Signed-off-by: Shlomi Noach <[email protected]>
Signed-off-by: Shlomi Noach <[email protected]>
Signed-off-by: Shlomi Noach <[email protected]>
Signed-off-by: Shlomi Noach <[email protected]>
Signed-off-by: Shlomi Noach <[email protected]>
Signed-off-by: Shlomi Noach <[email protected]>
Signed-off-by: Shlomi Noach <[email protected]>
Signed-off-by: Shlomi Noach <[email protected]>
Signed-off-by: Shlomi Noach <[email protected]>
Signed-off-by: Shlomi Noach <[email protected]>
✅ Deploy Preview for vitess ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
mattlord
approved these changes
Dec 3, 2024
| @@ -39,6 +39,8 @@ Vitess respects the following flags. They can be combined unless specifically in | |||
|
|
|||
| - `--postpone-launch`: initiate a migration that remains `queued` and only launches per user command. See [postponed migrations](../postponed-migrations). | |||
|
|
|||
| - `--prefer-instant-ddl`: where possible, apply `ALGORITHM=INSTANT` to the migration. This is applicable to `ALTER TABLE` migrations with `vitess` strategy. Vitess pre-computes whether the migration is eligible for `INSTANT` DDL. The [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/innodb-online-ddl-operations.html) references an incomplete list of eligible changes. If applicable, vitess does not create a shadow table and the migration is not revertible. | |||
There was a problem hiding this comment.
I would remove the /8.0/ part of the URLs so that we don't need to update them later. That will redirect to the latest GA LTS version page.
| Vitess can predict whether a schema change is eligible to `INSTANT` DDL based on the existing table schema and the requested change. It is aware of the MySQL limitations (some of which are listed in the documentation) and can devise a plan for each distinct migration. If eligible for `INSTANT` DDL, and if `--prefer-instant-ddl` is specified, Vitess will automatically add `ALGORITHM=INSTANT` to the statement. Otherwise any `ALGORITHM` directive is ignored. | ||
|
|
||
| If chosen to run as `INSTANT` DDL, the migration has no shadow table and is not revertible. | ||
| only to actually execute hours later. |
There was a problem hiding this comment.
This line seems like a leftover.
| special_plan: {"operation":"instant-ddl"} | ||
| ``` | ||
|
|
||
| Note the migration has not `artifacts`, and that it is executed with `special_plan: {"operation":"instant-ddl"}`. |
Signed-off-by: Shlomi Noach <[email protected]>
Signed-off-by: Shlomi Noach <[email protected]>
Signed-off-by: Shlomi Noach <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR documents
INSTANTDDL support andRANGE PARTITIONINGsupport for managed schema migrations.INSTANTDDL documentation were missing due to an oversight. We document the work in Online DDL: more support for INSTANT DDL vitess#11591.INSTANTDDL work began in Online DDL: support INSTANT DDL special plan, flag protected (flag undocumented for now) vitess#10402 which was marked experimental hence not documented, which caused the oversight.RANGE PARTITIONINGdocumentation cover the changes in Online DDL: better support for range partitioning vitess#15698 (see also Tracking: Online DDL partitioning changes improved support vitess#15674).We apply these changes for all supported versions, and a bit beyond, for good measure.