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 VEXPLAIN KEYS for improved sharding key selection #16830

Merged
merged 7 commits into from
Sep 25, 2024

Conversation

systay
Copy link
Collaborator

@systay systay commented Sep 24, 2024

Description:

This PR introduces a new VEXPLAIN type called KEYS, designed to assist developers and database administrators in making informed decisions about sharding keys. The VEXPLAIN KEYS command provides a concise summary of the query structure, highlighting columns used in joins, filters, and grouping operations.

Key features:

  1. Identifies potential sharding key candidates
  2. Highlights SARGable columns in the WHERE clause
  3. Shows grouping columns for aggregation queries
  4. Reveals join conditions between tables

The output focuses on the structural elements of the query that are most relevant to sharding decisions, without executing the query or providing execution statistics.

Example usage:

mysql> vexplain keys select u.foo, ue.bar, count(*) from user u join user_extra ue on u.id = ue.user_id where u.name = 'John Doe' group by 1, 2;
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ColumnUsage                                                                                                                                                                                |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| {
        "groupingColumns": [
                "user.foo",
                "user_extra.bar"
        ],
        "joinColumns": [
                "user.id",
                "user_extra.user_id"
        ],
        "filterColumns": [
                "user.name"
        ],
        "statementType": "SELECT"
} |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1 row in set (0.00 sec)

This output provides valuable insights for sharding decisions:

  • groupingColumns: Potential candidates for secondary sharding keys
  • joinColumns: Important for maintaining data locality across shards
  • filterColumns: SARGable columns that could be used as primary sharding keys
  • statementType: Helps understand the query type (SELECT, INSERT, UPDATE, DELETE)

By analyzing this information across multiple queries, developers can make more informed decisions about sharding strategies, potentially improving query performance and data distribution.

Related Issue(s)

#16768
Docs: vitessio/website#1853

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 Sep 24, 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 Sep 24, 2024
@systay systay added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: Query Serving and 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 Sep 24, 2024
@github-actions github-actions bot added this to the v21.0.0 milestone Sep 24, 2024
@systay systay added NeedsWebsiteDocsUpdate What it says and removed NeedsWebsiteDocsUpdate What it says labels Sep 24, 2024
Copy link

codecov bot commented Sep 24, 2024

Codecov Report

Attention: Patch coverage is 94.02985% with 4 lines in your changes missing coverage. Please review.

Project coverage is 69.45%. Comparing base (969e018) to head (ac6138e).

Files with missing lines Patch % Lines
go/vt/vtgate/planbuilder/operators/keys.go 93.75% 3 Missing ⚠️
go/vt/vtgate/planbuilder/vexplain.go 94.11% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #16830      +/-   ##
==========================================
+ Coverage   69.41%   69.45%   +0.03%     
==========================================
  Files        1570     1571       +1     
  Lines      202945   203004      +59     
==========================================
+ Hits       140880   140993     +113     
+ Misses      62065    62011      -54     

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

Copy link
Member

@GuptaManan100 GuptaManan100 left a comment

Choose a reason for hiding this comment

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

LGTM!

@systay systay requested a review from deepthi as a code owner September 24, 2024 10:46
@deepthi
Copy link
Member

deepthi commented Sep 24, 2024

@systay systay merged commit 3743f09 into vitessio:main Sep 25, 2024
98 checks passed
@systay systay deleted the vexplain-keys branch September 25, 2024 05:13
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.

4 participants