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

Adding an interface for v schema #17686

Open
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

anshikavashistha
Copy link
Collaborator

Description

Related Issue(s)

Add an interface for modifying discrete parts of the VSchema via concrete actions: AddTable, AddVindex, RemoveTable, etc. #17663

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

anshikavashistha and others added 10 commits August 17, 2024 05:08
…s Operator Compatibility Matrix

Removed specific Kubernetes version instructions from examples/operator/README.md.
Added a link to the Vitess Operator Compatibility Matrix for up-to-date Kubernetes version information.
This change centralizes Kubernetes version recommendations and ensures users are directed to the most current documentation.
Related Issue: [vitessio#1022](vitessio/website#1022)

Signed-off-by: Anshika Vashistha <[email protected]>
…s Operator Compatibility Matrix

Signed-off-by: Anshika Vashistha <[email protected]>
Co-authored-by: Matt Lord <[email protected]>
Signed-off-by: Anshika Vashistha <[email protected]>
Signed-off-by: Anshika Vashistha <[email protected]>
Signed-off-by: anshikavashistha <[email protected]>
Copy link
Contributor

vitess-bot bot commented Feb 3, 2025

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 Feb 3, 2025
@github-actions github-actions bot added this to the v22.0.0 milestone Feb 3, 2025
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

  • Implemented gRPCVSchemaOperations struct
  • Added atomic operations with version checking
  • Implemented retry logic for concurrent modifications

Copy link
Collaborator Author

@anshikavashistha anshikavashistha Feb 3, 2025

Choose a reason for hiding this comment

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

  • Added basic client operation tests
  • Added validation tests
  • Added error condition tests

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

  • Implemented gRPCVSchemaOperations struct
  • Added atomic operations with version checking
  • Implemented retry logic for concurrent modifications

AddTable(ctx context.Context, keyspace, tableName string, tableSpec interface{}) error

// RemoveTable atomically removes a table from the VSchema
RemoveTable(ctx context.Context, keyspace, tableName string) error
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

  • Added new VSchemaOperations interface for atomic VSchema modifications
  • Extended VtctlClient interface to include VSchema operations
  • Added methods for AddTable, RemoveTable, AddVindex, RemoveVindex

ts *memorytopo.Server
}

// Implement VtctlClient interface methods...
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

  • Added comprehensive test suite for atomic operations
  • Added concurrent modification tests
  • Added version conflict tests
  • Added integration tests with memory topo

func (s *VtctlServer) AddVSchemaTable(ctx context.Context, req *vtctlservicepb.AddVSchemaTableRequest) (*vtctlservicepb.AddVSchemaTableResponse, error) {
// Implement server-side handling of atomic VSchema modifications
return nil, nil // Placeholder return, actual implementation needed
}
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

  • Added comprehensive test suite for atomic operations
  • Added concurrent modification tests
  • Added version conflict tests
  • Added integration tests with memory topo

Copy link
Contributor

Choose a reason for hiding this comment

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

No changes are needed in this file.

Copy link
Contributor

Choose a reason for hiding this comment

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

vtctlclient is deprecated so no changes needed there. I'm also not sure what this is supposed to be used for.

Copy link
Contributor

@mattlord mattlord Feb 4, 2025

Choose a reason for hiding this comment

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

You can see how the ApplyVSchema command is implemented here on the vtctldclient side: https://github.com/vitessio/vitess/blob/main/go/cmd/vtctldclient/command/vschemas.go

And on the VtctldServer side: https://github.com/vitessio/vitess/blob/main/go/vt/vtctl/grpcvtctldserver/server.go

You can see a recent PR that added a couple of simple new commands here: #17442

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants