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

Local Examples: Add --binary-as-hex=false flag to mysql alias #15996

Merged
merged 1 commit into from
May 27, 2024

Conversation

mattlord
Copy link
Contributor

@mattlord mattlord commented May 22, 2024

Description

The Vitess local examples (source) are a common first touch experience for users. They are regularly confused or curious as to why many of the columns in the examples show up as HEX in the query results. The reason for this is that we use VARBINARY types throughout — in some rare cases like keyspace_id it makes sense, but most like customer.email are pure text. This makes understanding what's happening and quickly confirming at-a-glance results as expected more difficult and poses a minor hurdle when it's already quite a lot to get started with Vitess.

In this PR, we add the --binary-as-hex=false mysql client flag to the mysql alias we setup to both increase awareness of that flag and so that more people are using it by default (source ../common/env.sh).

The bigger effort would be to move most of our VARBINARY usage under ./examples to VARCHAR. This offers a more intuitive/expected experience while also more closely matching what users will be using for similar types of data. I can only guess that VARBINARY was used initially (many years ago now) because at the time Vitess did not have MySQL collation support. Vitess now has MySQL compatible collations so I think it's worth doing this work. For that I've created an issue and marked it as a good first issue for anyone that's interested in a relatively simple and straightforward first contribution to Vitess.

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

Copy link
Contributor

vitess-bot bot commented May 22, 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 May 22, 2024
@mattlord mattlord 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 May 22, 2024
@github-actions github-actions bot added this to the v20.0.0 milestone May 22, 2024
@mattlord mattlord marked this pull request as ready for review May 22, 2024 23:39
@mattlord mattlord requested a review from deepthi as a code owner May 22, 2024 23:39
@mattlord mattlord requested a review from GuptaManan100 May 22, 2024 23:39
@rohit-nayak-ps rohit-nayak-ps merged commit 3773563 into vitessio:main May 27, 2024
103 checks passed
@rohit-nayak-ps rohit-nayak-ps deleted the local_examples_binashex branch May 27, 2024 07:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants