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 SHOW VSCHEMA KEYSPACES query #14505

Merged
merged 6 commits into from
Nov 13, 2023

Conversation

GuptaManan100
Copy link
Member

@GuptaManan100 GuptaManan100 commented Nov 10, 2023

Description

This PR adds a new Vitess specific query syntax to vtgates, SHOW VSCHEMA KEYSPACES. This query is intended to print out the information of all the keyspaces that Vitess has. Specifically, this query prints out the keyspace name, whether it is sharded, what the foreign key management mode is and the error in the keyspace (if any).

This query is intended to provide an easier way to look at the keyspace information as an alternative to looking at the /debug/vschema endpoint of vtgate and finding the required information.

The query looks like the following when run from vtgate -

mysql> show vschema keyspaces;
+----------+---------+-------------+---------+
| Keyspace | Sharded | Foreign Key | Comment |
+----------+---------+-------------+---------+
| ks       | true    | managed     |         |
| uks      | false   | managed     |         |
+----------+---------+-------------+---------+
2 rows in set (0.01 sec)

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on the CI
  • Documentation was added or is not required

Deployment Notes

@GuptaManan100 GuptaManan100 added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: Query Serving labels Nov 10, 2023
Copy link
Contributor

vitess-bot bot commented Nov 10, 2023

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 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 10, 2023
@github-actions github-actions bot added this to the v19.0.0 milestone Nov 10, 2023
Signed-off-by: Manan Gupta <[email protected]>
@GuptaManan100 GuptaManan100 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 labels Nov 10, 2023
Copy link
Member

@harshit-gangal harshit-gangal left a comment

Choose a reason for hiding this comment

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

need to fix upgrade downgrade test

2023-11-10T09:17:03.2520559Z === RUN   TestInitAndUpdate
2023-11-10T09:17:03.3682409Z     st_sharded_test.go:195: 
2023-11-10T09:17:03.3683627Z         	Error Trace:	/home/runner/work/vitess/vitess/go/test/endtoend/utils/utils.go:153
2023-11-10T09:17:03.3686117Z         	            				/home/runner/work/vitess/vitess/go/test/endtoend/utils/utils.go:48
2023-11-10T09:17:03.3689435Z         	            				/home/runner/work/vitess/vitess/go/test/endtoend/vtgate/schematracker/sharded/st_sharded_test.go:195
2023-11-10T09:17:03.3690912Z         	Error:      	Received unexpected error:
2023-11-10T09:17:03.3692982Z         	            	syntax error at position 23 near 'KEYSPACES' (errno 1105) (sqlstate HY000) during query: SHOW VSCHEMA KEYSPACES
2023-11-10T09:17:03.3694454Z         	Test:       	TestInitAndUpdate
2023-11-10T09:17:03.3695102Z         	Messages:   	for query: SHOW VSCHEMA KEYSPACES
2023-11-10T09:17:03.3695708Z --- FAIL: TestInitAndUpdate (0.12s)

@systay systay added NeedsWebsiteDocsUpdate What it says and removed NeedsWebsiteDocsUpdate What it says labels Nov 13, 2023
@GuptaManan100 GuptaManan100 merged commit 0fd0b36 into vitessio:main Nov 13, 2023
116 of 117 checks passed
@GuptaManan100 GuptaManan100 deleted the fk-mode-keyspace branch November 13, 2023 08:39
ejortegau pushed a commit to slackhq/vitess that referenced this pull request Dec 13, 2023
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