schemadiff: Online DDL support, declarative based
#16462
Merged
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
…ysis, remove redundant datatypes from onlineddl/vrepl Signed-off-by: Shlomi Noach <[email protected]>
Signed-off-by: Shlomi Noach <[email protected]>
shlomi-noach
added
Type: Enhancement
Review ChecklistHello reviewers! 👋 Please follow this checklist when reviewing this Pull Request. General
Tests
Documentation
New flags
If a workflow is added or modified:
Backward compatibility
|
vitess-bot
bot
added
NeedsBackportReason
shlomi-noach
changed the title
schemadiff: Online DDL support, declarative based
shlomi-noach
removed
NeedsDescriptionUpdate
5 tasks
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #16462 +/- ##
==========================================
+ Coverage 68.62% 68.76% +0.13%
==========================================
Files 1552 1549 -3
Lines 199559 199624 +65
==========================================
+ Hits 136957 137264 +307
+ Misses 62602 62360 -242 ☔ View full report in Codecov by Sentry. |
dbussink
reviewed
Jul 23, 2024
| m := make(map[int]string, len(c.ColumnDefinition.Type.EnumValues)) | ||
| for i, enumValue := range c.ColumnDefinition.Type.EnumValues { | ||
| // SET and ENUM values are 1 indexed. | ||
| m[i+1] = enumValue |
There was a problem hiding this comment.
This doesn't seem symmetric with EnumValuesOrdinals?
There was a problem hiding this comment.
Nice catch. Fixed EnumValuesOrdinals, which is as yet unused.
| @@ -445,6 +445,18 @@ type CreateTableEntity struct { | |||
| Env *Environment | |||
| } | |||
|
|
|||
| func NewCreateTableEntityFromSQL(env *Environment, sql string) (*CreateTableEntity, error) { | |||
There was a problem hiding this comment.
@shlomi-noach Do we want to have a symmetric function for views here?
There was a problem hiding this comment.
Added + testing.
Signed-off-by: Shlomi Noach <[email protected]>
Signed-off-by: Shlomi Noach <[email protected]>
Signed-off-by: Shlomi Noach <[email protected]>
dbussink
approved these changes
Jul 24, 2024
Signed-off-by: Shlomi Noach <[email protected]>
mattlord
approved these changes
Jul 30, 2024
go/vt/schemadiff/key.go
Outdated
|
|
||
| // ColumnNames returns the names of the columns in the index. | ||
| func (i *IndexDefinitionEntity) ColumnNames() []string { | ||
| var names []string |
There was a problem hiding this comment.
We could preallocate this slice to a size equal to the length of i.IndexDefinition.Columns.
go/vt/schemadiff/onlineddl_test.go
Outdated
| @@ -0,0 +1,960 @@ | |||
| /* | |||
| Copyright 2022 The Vitess Authors. | |||
| @@ -0,0 +1,590 @@ | |||
| /* | |||
| Copyright 2022 The Vitess Authors. | |||
There was a problem hiding this comment.
Should use 2024 here too.
go/vt/schemadiff/onlineddl.go
Outdated
| // assumption that the later `targetColumn := targetColumns.GetColumn(expectedTargetName)` | ||
| // check is sufficient. It is not. It is possible that a columns was explicitly dropped | ||
| // and added (`DROP COLUMN c, ADD COLUMN c INT`) in the same ALTER TABLE statement. | ||
| // Without checking the ALTER TABLE statement, we would be folled to believe that column |
There was a problem hiding this comment.
Assuming folled should be fooled
| @@ -4,3 +4,224 @@ | |||
| */ | |||
There was a problem hiding this comment.
Can we remove this copyright at this point?
Either way, we should also add the vitess copyright.
There was a problem hiding this comment.
Good catch. For this file the copyright should be just vitess. There is not derivative work from freno here.
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]>
venkatraju
pushed a commit
to slackhq/vitess
that referenced
this pull request
Aug 29, 2024
Signed-off-by: Shlomi Noach <[email protected]>
5 tasks
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.
Description
Addresses #16229 and more. Replaces #16256 just as a succinct single commit change.
In this PR
schemadifftakes more ownership in the Online DDL process. Specifically, it takes away much of the logic fromvttablet/onlineddl/vrepl/*andvttablet/onlineddl/vrepl.go, but also:schemadiffis purely declarative and does not use database connections, query based logic is replaced with programmatic logic.gh-ost:Column,ColumnList,UniqueKeyand more. We already have the formal AST types ingo/vt/sqlparser, and there was a lot of duplication of logic.regexpbased parsing, and more.Much of the logic removed as mentioned above is reincarnated in
go/vt/schemadiff/onlineddl.go, where we introduce helper functions specific to Vitess's Online DDL implementations. Intentionally set apart from the general purposetable.goorcolumn.go, these functions deal with questions such as:To help formalizing some of the above, we introduce a few data types in
schemadiffthat assist in iteration, filtering, and generally inter-operate with each other to enrich column information:ColumnDefinitionEntity(introduced in a previous PR) and many helper functions (is this column nullable? Is it numeric? What's the column's charset? etc.)ColumnDefinitionEntityList- a list of the aboveColumnDefinitionEntityIndexDefinitionEntityand many helper functions (is this index unique? Does it have nullable columns? etc.)IndexDefinitionEntityList- a list of the aboveIndexDefinitionEntityThese inter-connect, as mentioned above. For example, a column
i intlooks to be nullable, but if we know it's part of aPRIMARYkey, then we implicitly know it is in fact non nullable.What this means
This lets
schemadiffpre-evaluate the ability to run Online DDL on a table, what risks there might be, what the revertibility implications might be, what keys will be used, and so forth, without actually having to read/write anything from/to the the database.Testing
Thanks to the declarative-only nature of
schemadiff, it is easier to do more testing in unit tests. For example, we copy+pasted all the revertible tests fromgo/test/endtoend/onlineddl/revert/and they are now tested in unit tests.There's otherwise a bunch of tests moved over from
go/vt/vttablet/onlineddl/vrepl, almost as-is. And otherwise just a bunch more tests. Finally, all of the existingendtoendtests, includingvreplsuite, reverts, scheduler, and more -- all are unchanged and are expected to exhibit no change of behavior.Related Issue(s)
schemadiffanalysis #16229Checklist
Deployment Notes