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.

Sign up for GitHub

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

Jump to bottom

Feature Request: export vtctldclient VDiffShow summarization code #16780

Open
mdlayher opened this issue Sep 13, 2024 · 0 comments · May be fixed by #16781
Open

Feature Request: export vtctldclient VDiffShow summarization code #16780

mdlayher opened this issue Sep 13, 2024 · 0 comments · May be fixed by #16781
Assignees
@mdlayher
Labels
Component: VReplication Type: Feature Request

Comments

@mdlayher
Copy link
Member

Feature Description

When executing vtctldclient vdiff show, a summary is generated based on the raw RPC outputs containing query rows, fields, etc. This summary is useful for humans using the CLI, but is also useful for automating the VDiff flow. Being able to import the summary logic as a library means that callers don't need to parse the entire VDiffShowResponse type to generate a report similar to vtctldclient.

Use Case(s)

Creating workflow automation tooling in Go, and being able to programmatically check the validity of workflows via VDiff.
@mdlayher mdlayher added Type: Feature Request Needs Triage This issue needs to be correctly labelled and triaged labels Sep 13, 2024
@mdlayher mdlayher self-assigned this Sep 13, 2024
mdlayher added a commit that referenced this issue Sep 13, 2024
@mdlayher
vdiff: factor Summarize out from vtctldclient
a77b4af 
Factor out buildSingleSummary as vdiff.Summarize, which generates a summary of
the VDiff operation based on the VDiffShow RPC response.

Fixes #16780.

Signed-off-by: Matt Layher <mdlayher@planetscale.com>
@mdlayher mdlayher linked a pull request Sep 13, 2024 that will close this issue
Open
5 tasks
@deepthi deepthi added Component: VReplication and removed Needs Triage This issue needs to be correctly labelled and triaged labels Sep 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mdlayher mdlayher

Labels
Component: VReplication Type: Feature Request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

vdiff: factor Summarize out from vtctldclient vitessio/vitess
2 participants
@deepthi @mdlayher