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

Add convenience functions for working with schemadiff objects #10238

Conversation

dbussink
Copy link
Contributor

@dbussink dbussink commented May 9, 2022

This adds a number of convenience methods to schemadiff that are useful when working with schema related objects and inspecting what a schema looks like.

It avoids having to do some casts often when for example you only care about getting a table from a schema (and not views).

The diff methods are useful when getting the underlying object so you don't have to grab it with Statement() and then cast it again to the real underlying sqlparser object.

Related Issue(s)

#10203

Checklist

  • "Backport me!" label has been added if this change should be backported
  • Tests were added or are not required
  • Documentation was added or is not required

@dbussink dbussink requested a review from shlomi-noach May 9, 2022 10:54
@dbussink dbussink added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: Query Serving release notes none labels May 9, 2022
@github-actions
Copy link
Contributor

github-actions bot commented May 9, 2022

Review Checklist

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

General

  • Ensure that the Pull Request has the correct release notes label. release notes none should only be used for PRs that are so trivial that they need not be included.
  • If a new flag is being introduced, review whether it is really needed. The flag names should be clear and intuitive (as far as possible), and the flag's help should be descriptive.

Bug fixes

  • There should be at least one unit or end-to-end test.
  • The Pull Request description should either include a link to an issue that describes the bug OR an actual description of the bug and how to reproduce, along with a description of the fix.

Non-trivial changes

  • There should be some code comments as to why things are implemented the way they are.

New/Existing features

  • Should be documented, either by modifying the existing documentation or creating new documentation.
  • New features should have a link to a feature request issue or an RFC that documents the use cases, corner cases and test cases.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • vtctl command output order should be stable and awk-able.

@shlomi-noach
Copy link
Contributor

@dbussink add a couple tests e.g. for TableNames() and ViewNames()?

Copy link
Contributor

@yields yields left a comment

Choose a reason for hiding this comment

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

LGTM

@dbussink
Copy link
Contributor Author

dbussink commented May 9, 2022

@dbussink add a couple tests e.g. for TableNames() and ViewNames()?

Added something and following how EntityNames() was already used.

@shlomi-noach
Copy link
Contributor

Added tests look legit

dbussink added 2 commits May 9, 2022 15:25
This adds a number of convenience methods to schemadiff that are useful
when working with schema related objects and inspecting what a schema
looks like.

It avoids having to do some casts often when for example you only care
about getting a table from a schema (and not views).

The diff methods are useful when getting the underlying object so you
don't have to grab it with `Statement()` and then cast it again to the
real underlying `sqlparser` object.

Signed-off-by: Dirkjan Bussink <d.bussink@gmail.com>
Signed-off-by: Dirkjan Bussink <d.bussink@gmail.com>
@dbussink dbussink force-pushed the dbussink/provide-easier-schemadiff-accessor-methods branch from 5f3c8e3 to aa94010 Compare May 9, 2022 13:25
@shlomi-noach shlomi-noach merged commit c917cd3 into vitessio:main May 10, 2022
@shlomi-noach shlomi-noach deleted the dbussink/provide-easier-schemadiff-accessor-methods branch May 10, 2022 07:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Query Serving 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