c0x0o / kvproto

Protocol buffer files for TiKV

kvproto

Protocol buffer files for TiKV

Usage

• Write your own protocol file in proto folder.
• If you need to update raft-rs, please download the proto file respectively and overwrite the one in include folder.
• Run make to generate go and rust code. We generate all go codes in pkg folder and rust in src folder.
• Update the dependent projects.

Dependencies

• Rust
• Go
• Protoc 3.8.0

Docker image

The easiest way to compile the protobufs is to use docker.

./scripts/docker-build.sh  # build the docker image once
./scripts/docker-run.sh make go

Multiple protoc Versions

If you need to override your version of protoc because you have a later version you can install the correct version like so:

PROTOC_VERSION=3.8.0
case `uname` in
  'Darwin') export OS='osx';; 
  'Linux') export OS='linux';;
esac
curl -L https://github.com/google/protobuf/releases/download/v$PROTOC_VERSION/protoc-$PROTOC_VERSION-$OS-x86_64.zip -o protoc.zip &&\
unzip protoc.zip -d protoc &&\
rm protoc.zip

Then you can run PATH="$(pwd)/protoc/bin:$PATH" make