https://github.com/planetscale/vitess-types
Protobuf types extracted from Vitess
https://github.com/planetscale/vitess-types
Last synced: 28 days ago
JSON representation
Protobuf types extracted from Vitess
- Host: GitHub
- URL: https://github.com/planetscale/vitess-types
- Owner: planetscale
- License: apache-2.0
- Created: 2022-10-15T05:41:34.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2026-03-13T22:20:06.000Z (3 months ago)
- Last Synced: 2026-03-14T10:19:34.476Z (3 months ago)
- Language: Go
- Homepage: https://vitess.io/
- Size: 5 MB
- Stars: 1
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Vitess types
These types are extracted out of [Vitess source](https://github.com/vitessio/vitess) and only modified to be more friendly for others.
## Why?
The main interface, besides MySQL, for Vitess is via gRPC. gRPC uses protobuf. If a third party module wanted to interact with Vitess's gRPC APIs, or to just work with their types such as a `QueryResult`, the logical choices is to use the generated interfaces from `vitess.io/vitess/go/vt/proto`, but this dependency is quite large since this is the entirety of Vitess.
So this extraction is an attempt at being a much lighter-weight version that is fully capable of interoping with Vitess. This makes it more friendly for consumers to wrap and depend on Vitess types, without a dependency on Vitess.