Skip to content

Conversation

@nickvanw
Copy link
Collaborator

@nickvanw nickvanw commented Oct 25, 2025

Description

This PR adds the ability for a user to target a specific tablet by alias when doing USE, instead of only being able to pick a type for a shard. This means that a user can get "stable" routing, which is extremely useful when they don't have access to the underlying MySQL instance and need to do things like debug.

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

AI Disclosure

This PR was written hand-in-hand with Claude Code, which absolutely got the initial few approaches extremely incorrect and required a lot of human help. Robot isn't going to take my job any time soon.

Signed-off-by: Nick Van Wiggeren <[email protected]>
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Oct 25, 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 Oct 25, 2025
@github-actions github-actions bot added this to the v24.0.0 milestone Oct 25, 2025
@codecov
Copy link

codecov bot commented Oct 25, 2025

Codecov Report

❌ Patch coverage is 96.61017% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 69.73%. Comparing base (8fc596b) to head (ba83739).
⚠️ Report is 19 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/topo/topoproto/destination.go 95.65% 1 Missing ⚠️
go/vt/vtgate/executorcontext/vcursor_impl.go 92.30% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #18809      +/-   ##
==========================================
+ Coverage   69.68%   69.73%   +0.04%     
==========================================
  Files        1605     1607       +2     
  Lines      214461   214642     +181     
==========================================
+ Hits       149456   149674     +218     
+ Misses      65005    64968      -37     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@nickvanw nickvanw force-pushed the nickvanw/direct-access branch from 8ecfaf3 to 883637f Compare October 26, 2025 15:04
Signed-off-by: Nick Van Wiggeren <[email protected]>
@nickvanw nickvanw force-pushed the nickvanw/direct-access branch from 883637f to 8ab64dc Compare October 26, 2025 15:07
@nickvanw nickvanw force-pushed the nickvanw/direct-access branch 3 times, most recently from f77286f to 1eb17dd Compare October 27, 2025 07:41
@nickvanw nickvanw 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 Oct 27, 2025
@nickvanw nickvanw force-pushed the nickvanw/direct-access branch from 1eb17dd to 29e658c Compare October 27, 2025 08:07
Signed-off-by: Nick Van Wiggeren <[email protected]>
@nickvanw nickvanw force-pushed the nickvanw/direct-access branch 6 times, most recently from 3ef8159 to 84f29f0 Compare October 27, 2025 13:27
@nickvanw nickvanw force-pushed the nickvanw/direct-access branch from 84f29f0 to 6c49907 Compare October 27, 2025 14:03
@nickvanw nickvanw marked this pull request as ready for review October 27, 2025 14:28
Signed-off-by: Nick Van Wiggeren <[email protected]>
Signed-off-by: Nick Van Wiggeren <[email protected]>
Comment on lines 906 to +912
info.alias = shardSession.TabletAlias
info.rowsAffected = shardSession.RowsAffected
}
// Override alias if tablet-specific routing is set
if targetAlias := session.GetTargetTabletAlias(); targetAlias != nil {
info.alias = targetAlias
}
Copy link
Member

Choose a reason for hiding this comment

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

we should error out if info.alias is set and does not match targetAlias if set.
We should also error out during the use command as well if the shard session exists and shardSession.TabletAlias does not match the alias in the use command.

Comment on lines +1037 to +1048
// Clear any existing tablet-specific routing if not specified
if tabletAlias == nil {
vc.SafeSession.SetTargetTabletAlias(nil)
} else {
// Store tablet alias in session for routing
// Note: We don't validate the tablet exists here - if it doesn't exist or is
// unreachable, the query will fail during execution with a clear error message
vc.SafeSession.SetTargetTabletAlias(tabletAlias)

// Keep tabletType as determined by ParseDestination (defaultTabletType)
// The actual routing uses the tablet alias, so the type is only for VCursor state
}
Copy link
Member

Choose a reason for hiding this comment

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

We do not need to call this. As on the next query a new vcursor object will be created and that will set the tabletAlias based on the session target.

Comment on lines +208 to +214

// TestTargetTabletAlias tests the SetTargetTabletAlias and GetTargetTabletAlias methods.
func TestTargetTabletAlias(t *testing.T) {
session := NewSafeSession(&vtgatepb.Session{})

// Test: initially nil
assert.Nil(t, session.GetTargetTabletAlias())
Copy link
Member

Choose a reason for hiding this comment

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

the test on thread safety is not required.
A connection as a contract cannot be shared, so no one can call SetTarget in parallel.

@harshit-gangal harshit-gangal added release notes (needs details) This PR needs to be listed in the release notes in a dedicated section (deprecation notice, etc...) NeedsWebsiteDocsUpdate What it says labels Nov 3, 2025
Comment on lines +956 to +958
// Query different replicas and verify different server UUIDs
// This proves we're actually hitting different physical tablets
for range 10 {
Copy link
Member

Choose a reason for hiding this comment

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

not sure if we need this for loop here

Comment on lines +103 to +106
if tabletAlias != nil && dest == nil {
return "", defaultTabletType, nil, nil, vterrors.Errorf(vtrpcpb.Code_INVALID_ARGUMENT, "tablet alias must be used with a shard")
}
return keyspace, tabletType, dest, tabletAlias, nil
Copy link
Member

@harshit-gangal harshit-gangal Nov 3, 2025

Choose a reason for hiding this comment

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

If there is a destination then it will not go through the planner? The query will be shard targeted.
Is this the expectation?

@timvaillancourt timvaillancourt linked an issue Nov 5, 2025 that may be closed by this pull request
@mattlord
Copy link
Member

mattlord commented Dec 1, 2025

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Component: Query Serving Component: VTGate NeedsWebsiteDocsUpdate What it says release notes (needs details) This PR needs to be listed in the release notes in a dedicated section (deprecation notice, etc...) Type: Feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

RFC: Tablet Targeting

4 participants