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

vtorc: make SQL formatting consistent #17154

Merged
merged 5 commits into from
Nov 26, 2024

Conversation

timvaillancourt
Copy link
Contributor

@timvaillancourt timvaillancourt commented Nov 5, 2024

Description

This PR improves the consistency of SQL statements in go/vt/vtorc (as discussed with @dbussink offline)

Some notes:

  • Standardized on uppercase text for SQL verbs, functions, units, etc
    • Examples: SELECT, AS, OR, DATETIME, SECOND/HOUR/DAY, etc
  • Standardized on \t for indentation - in places it's a mix of spaces and tabs
  • Standardized when indentation happens, examples: list of columns/values, subqueries, conditions, etc
  • Consistent spacing for value definitions, example something = ?
  • Other minor style fixes

Related Issue(s)

#17164

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

@timvaillancourt timvaillancourt added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: VTorc Vitess Orchestrator integration labels Nov 5, 2024
Copy link
Contributor

vitess-bot bot commented Nov 5, 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 Nov 5, 2024
@github-actions github-actions bot added this to the v22.0.0 milestone Nov 5, 2024
@timvaillancourt timvaillancourt removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Nov 5, 2024
Signed-off-by: Tim Vaillancourt <[email protected]>
@timvaillancourt timvaillancourt marked this pull request as ready for review November 5, 2024 23:05
Signed-off-by: Tim Vaillancourt <[email protected]>
Copy link

codecov bot commented Nov 5, 2024

Codecov Report

Attention: Patch coverage is 61.19403% with 130 lines in your changes missing coverage. Please review.

Project coverage is 67.41%. Comparing base (96f4ac7) to head (da08a88).
Report is 3 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/vtorc/logic/topology_recovery_dao.go 0.00% 81 Missing ⚠️
go/vt/vtorc/inst/instance_dao.go 85.51% 21 Missing ⚠️
go/vt/vtorc/logic/disable_recovery.go 0.00% 15 Missing ⚠️
go/vt/vtorc/process/health.go 0.00% 7 Missing ⚠️
go/vt/vtorc/inst/analysis_dao.go 84.84% 5 Missing ⚠️
go/vt/vtorc/logic/tablet_discovery.go 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #17154      +/-   ##
==========================================
+ Coverage   67.39%   67.41%   +0.02%     
==========================================
  Files        1573     1573              
  Lines      253136   253181      +45     
==========================================
+ Hits       170603   170690      +87     
+ Misses      82533    82491      -42     

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

Signed-off-by: Tim Vaillancourt <[email protected]>
@timvaillancourt timvaillancourt added Type: Internal Cleanup and removed NeedsIssue A linked issue is missing for this Pull Request labels Nov 6, 2024
@shlomi-noach shlomi-noach merged commit 69b381f into vitessio:main Nov 26, 2024
97 checks passed
@timvaillancourt timvaillancourt deleted the vtorc-cleanup-sql branch November 26, 2024 11:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: VTorc Vitess Orchestrator integration Type: Enhancement Logical improvement (somewhere between a bug and feature) Type: Internal Cleanup
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants