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

schemadiff: temporal range partition rotation analysis and operation #17426

Open
wants to merge 25 commits into
base: main
Choose a base branch
from

Conversation

shlomi-noach
Copy link
Contributor

@shlomi-noach shlomi-noach commented Dec 24, 2024

Description

This PR introduces elaborate analysis and operations over temporal range partitioned tables.

Temporal range partitioned tables are tables with range partitions using any form of temporal value, ie:

  • Using PARTITION BY RANGE COLUMNS (col_name) over a single column of type DATE or DATETIME
  • Using PARTITION BY RANGE (temporal_func(col_name)) using one of several explicitly supported functions:
    • TO_SECONDS
    • TO_DAYS
    • YEARWEEK
    • YEAR
    • In 8.4: UNIX_TIMESTAMP and using a TIMESTAMP column

schemadiff then offers:

  • AnalyzeTemporalRangePartitioning() returning TemporalRangePartitioningAnalysis, which determines whether the table is at all partitioned by RANGE, and can be considered as being temporal partitioned. Analysis includes the minimal rotation interval, the function used, if any, the column used, whether MAXVALUE is used, etc.
  • TemporalRangePartitioningNextRotation(), given a table, interval, expected ahead-of-time partitions and time reference, returning a list of ALTER TABLE statements that prepare futuristic empty partitions, as needed. schemadiff analyzes the actual values in the table definition, whether these are DATE, DATETIME, or product of one of the supported functions, to determine which of the ahead-of-time partitions are already covered by existing schema, and which needs to be added.
    The function generates either ADD PARTITION or REORGANIZE PARTITION statements, based on whether MAXVALUE partition is present.
    There's a variety of conditions to make the function return an error: if the table is not temporal range partitioned, if the interval is invalid for the table, and more.
  • TemporalRangePartitioningRetention(): given a table and an expiration time, this function returns a (possibly empty) ALTER TABLE DROP PARTITION ... statement dropping all expired partitions. Again, schemadiff computed the actual partition values whether explicit DATE, DATETIME or product of one of the supported functions.

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

Deployment Notes

@shlomi-noach shlomi-noach added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: schema management schemadiff and schema changes labels Dec 24, 2024
Copy link
Contributor

vitess-bot bot commented Dec 24, 2024

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Dec 24, 2024
@github-actions github-actions bot added this to the v22.0.0 milestone Dec 24, 2024
Copy link

codecov bot commented Dec 24, 2024

Codecov Report

Attention: Patch coverage is 80.73090% with 116 lines in your changes missing coverage. Please review.

Project coverage is 67.74%. Comparing base (54dfd60) to head (5a2cb5f).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/schemadiff/partitioning_analysis.go 78.71% 116 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #17426      +/-   ##
==========================================
+ Coverage   67.71%   67.74%   +0.02%     
==========================================
  Files        1584     1584              
  Lines      254511   255019     +508     
==========================================
+ Hits       172346   172765     +419     
- Misses      82165    82254      +89     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@shlomi-noach
Copy link
Contributor Author

Now fully supporting weekly rotations, including all week modes, based on either requested interval or on a parsed YEARWEEK(... [,mode]) partitioning function.

@shlomi-noach shlomi-noach marked this pull request as ready for review January 2, 2025 10:16
@shlomi-noach shlomi-noach removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Jan 2, 2025
@shlomi-noach shlomi-noach requested review from a team and dbussink January 2, 2025 10:16
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Renamed as partitioning_analysis.go

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Renamed as partitioning_analysis_test.go

Copy link
Contributor

@mattlord mattlord left a comment

Choose a reason for hiding this comment

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

Nice work on this! I only had a few very minor nits/comments that you can do with as you prefer.

Comment on lines 172 to 175
case "year":
return IntervalYear
case "quarter":
return IntervalQuarter
Copy link
Contributor

Choose a reason for hiding this comment

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

Seems like this might be worth a map in the package?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

{
// RANGE COLUMNS uses non-existent column
schema: "CREATE TABLE t (id int, i INT, PRIMARY KEY (id, i)) PARTITION BY RANGE COLUMNS (i2) (PARTITION p0 VALUES LESS THAN (1))",
expectErr: &InvalidColumnInPartitionError{Table: "t", Column: "i2"},
Copy link
Contributor

Choose a reason for hiding this comment

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

Feels like ~ Type: "not_found" would be useful?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good thinking. Perhaps in a followup PR, as this would apply to a larger scope of scenarios.

return &InvalidColumnInPartitionError{Table: c.Name(), Column: colName.String()}
}
// Validate column type
// See https://dev.mysql.com/doc/refman/8.0/en/partitioning-columns.html
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit, but IMO it's best to remove the version from links when we can so that they do not become stale (w/o it it will redirect to latest GA LTS version): https://dev.mysql.com/doc/refman/en/partitioning-columns.html

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@@ -0,0 +1,731 @@
/*
Copyright 2024 The Vitess Authors.
Copy link
Contributor

Choose a reason for hiding this comment

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

It's a new year! 😉

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

Col *ColumnDefinitionEntity // The column used in the RANGE expression
FuncExpr *sqlparser.FuncExpr // The function used in the RANGE expression, if any
WeekMode int // The mode used in the WEEK function, if that's what's used
MaxvaluePartition *sqlparser.PartitionDefinition // The partition that has MAXVALUE, if any
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit, but MaxValuePartition would match the standard (Pascal) case.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

MaxvaluePartition *sqlparser.PartitionDefinition // The partition that has MAXVALUE, if any
HighestValueDateTime datetime.DateTime // The datetime value of the highest partition (excluding MAXVALUE)
HighestValueIntVal int64 // The integer value of the highest partition (excluding MAXVALUE)
Reason string // Why IsTemporalRangePartitioned is false
Copy link
Contributor

Choose a reason for hiding this comment

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

IMO it would be nice to couple these in a struct so that the relationship is formalized and obvious. I'm not sure if something like this is better or worse though:

type IsTemporalRangePartitioned struct {
	Determination bool
	Reason        string
}

Fine as-is.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

keeping as is for now. No strong feelings here, but I prefer not to have structure nesting.

Comment on lines 54 to 60
if createTable.TableSpec.PartitionOption == nil {
return false
}
if createTable.TableSpec.PartitionOption.Type != sqlparser.RangeType {
return false
}
return true
Copy link
Contributor

Choose a reason for hiding this comment

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

Would this not be correct? Nitty, obviously, but it feels simpler and more concise to me.

return createTable.TableSpec.PartitionOption != nil && createTable.TableSpec.PartitionOption.Type == sqlparser.RangeType

Copy link
Contributor Author

Choose a reason for hiding this comment

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

changed.

return nil, err
}
if !IsRangePartitioned(createTableEntity.CreateTable) {
return withReason("Table does not use PARTITION BY RANGE")
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit, but it looks like these strings end up becoming errors and errors aren't supposed to use sentence capitalization or punctuation.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed.

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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: schema management schemadiff and schema changes Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants