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

Introducing ExecuteMultiFetchAsDba gRPC and vtctldclient ExecuteMultiFetchAsDBA command #15506

Merged
merged 20 commits into from
Mar 19, 2024

Conversation

shlomi-noach
Copy link
Contributor

@shlomi-noach shlomi-noach commented Mar 18, 2024

Description

See #15505 for context. This PR adds:

  • ExecuteMultiFetchAsDba gRPC call, with ExecuteMultiFetchAsDbaRequest and ExecuteMultiFetchAsDbaResponse proto messages.
  • vtctldclient ExecuteMultiFetchAsDBA command, which acts very similarly to ExecuteFetchAsDBA, except it returns a list of results (seen in --json as an array of results).

The behavior of ExecuteFetchAsDBA in rpc_query.go remains unchanged, although we consolidate its logic with the new
ExecuteMultiFetchAsDBA implementation.

The main changes of this PR are in go/vt/vttablet/tabletmanager/rpc_query.go and in go/cmd/vtctldclient/command/query.go. The rest is gRPC/interface boilerplate and testing.

Docs: vitessio/website#1709

No backport required.

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

Copy link
Contributor

vitess-bot bot commented Mar 18, 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 Mar 18, 2024
@shlomi-noach shlomi-noach requested a review from a team March 18, 2024 06:19
@github-actions github-actions bot added this to the v20.0.0 milestone Mar 18, 2024
@shlomi-noach shlomi-noach removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work 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 Mar 18, 2024
Signed-off-by: Shlomi Noach <[email protected]>
Copy link

codecov bot commented Mar 18, 2024

Codecov Report

Attention: Patch coverage is 35.00000% with 117 lines in your changes are missing coverage. Please review.

Project coverage is 65.61%. Comparing base (696fe0e) to head (fdabcfb).
Report is 119 commits behind head on main.

Files Patch % Lines
go/cmd/vtctldclient/command/query.go 14.70% 29 Missing ⚠️
go/vt/vttablet/grpctmclient/client.go 0.00% 25 Missing ⚠️
go/vt/vttablet/tabletmanager/rpc_query.go 64.00% 18 Missing ⚠️
go/vt/wrangler/tablet.go 0.00% 11 Missing ⚠️
go/vt/vttablet/grpctmserver/server.go 0.00% 9 Missing ⚠️
go/vt/vttablet/tmrpctest/test_tm_rpc.go 0.00% 8 Missing ⚠️
...t/vtctl/grpcvtctldserver/testutil/test_tmclient.go 46.15% 7 Missing ⚠️
go/vt/vtctl/grpcvtctldclient/client_gen.go 0.00% 4 Missing ⚠️
go/vt/vtcombo/tablet_map.go 0.00% 2 Missing ⚠️
go/vt/vtctl/localvtctldclient/client_gen.go 0.00% 2 Missing ⚠️
... and 1 more
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #15506      +/-   ##
==========================================
- Coverage   67.41%   65.61%   -1.81%     
==========================================
  Files        1560     1563       +3     
  Lines      192752   194638    +1886     
==========================================
- Hits       129952   127703    -2249     
- Misses      62800    66935    +4135     

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

Signed-off-by: Shlomi Noach <[email protected]>
@@ -30,6 +30,7 @@ Available Commands:
ExecuteFetchAsApp Executes the given query as the App user on the remote tablet.
ExecuteFetchAsDBA Executes the given query as the DBA user on the remote tablet.
ExecuteHook Runs the specified hook on the given tablet.
ExecuteMultiFetchAsDBA Executes given multiple queries as the DBA user on the remote tablet.
Copy link
Contributor

Choose a reason for hiding this comment

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

For symmetry with the other ExecuteFetch, does this mean we also want / need ExecuteMultiFetchAsApp?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure. We have a specific use case for DBA, and no specific use case for App, so unsure we should add just for the sake of symmetry.

Copy link
Contributor

Choose a reason for hiding this comment

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

@shlomi-noach My thinking is that it would be mostly for people using ExecuteFetchAsApp with multiple queries and have it kinda accidentally mostly work. They wouldn't have anywhere to go if we don't have it. I don't know if this is a real valid concern though or not.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Having consulted with the team, we should not add ExecuteMultiFetchAsApp right now. Only when there's a specific use case.

proto/tabletmanagerdata.proto Outdated Show resolved Hide resolved
Signed-off-by: Shlomi Noach <[email protected]>
Signed-off-by: Shlomi Noach <[email protected]>
@shlomi-noach
Copy link
Contributor Author

Docs PR: vitessio/website#1709

@shlomi-noach shlomi-noach removed the NeedsWebsiteDocsUpdate What it says label Mar 19, 2024
@shlomi-noach shlomi-noach merged commit 8833092 into vitessio:main Mar 19, 2024
105 of 106 checks passed
@shlomi-noach shlomi-noach deleted the execute-multi-fetch-as-dba branch March 19, 2024 08:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: TabletManager Type: Bug 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