https://github.com/pingcap/kvproto

Protocol buffer files for TiKV
https://github.com/pingcap/kvproto

Last synced: 8 days ago
JSON representation

Protocol buffer files for TiKV

• Host: GitHub
• URL: https://github.com/pingcap/kvproto
• Owner: pingcap
• License: apache-2.0
• Created: 2016-03-11T00:50:02.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-09-18T10:37:28.000Z (about 2 months ago)
• Last Synced: 2024-09-19T05:55:46.452Z (about 2 months ago)
• Language: CMake
• Size: 21.4 MB
• Stars: 153
• Watchers: 96
• Forks: 217
• Open Issues: 29
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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

```

# Build locally

There are many dependencies to be installed, please refer to the relevant scripts in [workflow](.github/workflows) to set them up.