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

VReplication: Support passing VStream filters down to MySQL #17677

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

Conversation

mattlord
Copy link
Contributor

@mattlord mattlord commented Jan 31, 2025

Description

This PR fulfills the use cases in #17681 by pushing down any valid MySQL predicates in the provided Filter to MySQL in the query used for the copy phase. This PR does NOT alter the allowed filter expressions — with the exception that it removes a limitation excluding VARCHAR columns which is no longer applicable after #9549 — but it passes those allowed predicates down to MySQL in the query used to copy the rows from the given GTID/transaction snapshot before we then proceed to stream new binlog events which also match the given filters.

Note

I will open a website PR to document the options and limitations here: https://vitess.io/docs/22.0/reference/vreplication/vstream/#filter

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

Copy link
Contributor

vitess-bot bot commented Jan 31, 2025

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 Jan 31, 2025
@github-actions github-actions bot added this to the v22.0.0 milestone Jan 31, 2025
@mattlord mattlord removed the NeedsBackportReason If backport labels have been applied to a PR, a justification is required label Jan 31, 2025
Signed-off-by: Matt Lord <[email protected]>
@mattlord mattlord force-pushed the vstream_mysql_filters branch 2 times, most recently from 3c26c03 to 2eb85e4 Compare January 31, 2025 21:30
@mattlord mattlord force-pushed the vstream_mysql_filters branch from 2eb85e4 to 0a17436 Compare January 31, 2025 21:33
Copy link

codecov bot commented Jan 31, 2025

Codecov Report

Attention: Patch coverage is 70.37037% with 8 lines in your changes missing coverage. Please review.

Project coverage is 67.75%. Comparing base (cb7d61a) to head (157497f).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
.../vt/vttablet/tabletserver/vstreamer/rowstreamer.go 70.00% 6 Missing ⚠️
.../vt/vttablet/tabletserver/vstreamer/planbuilder.go 66.66% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #17677      +/-   ##
==========================================
- Coverage   67.75%   67.75%   -0.01%     
==========================================
  Files        1587     1587              
  Lines      255780   255802      +22     
==========================================
+ Hits       173310   173323      +13     
- Misses      82470    82479       +9     

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

Signed-off-by: Matt Lord <[email protected]>
Signed-off-by: Matt Lord <[email protected]>
@@ -601,10 +610,6 @@ func (plan *Plan) analyzeWhere(vschema *localVSchema, where *sqlparser.Where) er
if !ok {
return fmt.Errorf("unexpected: %v", sqlparser.String(expr))
}
// StrVal is varbinary, we do not support varchar since we would have to implement all collation types
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This support was actually added here: #9549

Copy link
Contributor Author

Choose a reason for hiding this comment

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

And it's tested in the new e2e test.

Signed-off-by: Matt Lord <[email protected]>
@mattlord mattlord force-pushed the vstream_mysql_filters branch from e4374be to 087521f Compare February 1, 2025 03:00
Signed-off-by: Matt Lord <[email protected]>
@mattlord mattlord force-pushed the vstream_mysql_filters branch from 087521f to b87608b Compare February 1, 2025 03:22
@mattlord mattlord removed NeedsIssue A linked issue is missing for this Pull Request NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work labels Feb 1, 2025
@mattlord mattlord force-pushed the vstream_mysql_filters branch from ab995b5 to d708223 Compare February 1, 2025 22:36
Signed-off-by: Matt Lord <[email protected]>
@mattlord mattlord force-pushed the vstream_mysql_filters branch from d708223 to e9551de Compare February 1, 2025 22:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature Request: Support pushing down viable VStream filters to MySQL for the copy phase
1 participant