horaedbproto 1.0.24

Protobuf specs for HoraeDB
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

# Protocol of [HoraeDB](https://github.com/CeresDB/horaedb)

[![Crates.io](https://img.shields.io/crates/v/horaedbproto.svg)](https://crates.io/crates/horaedbproto)
[![Go Reference](https://pkg.go.dev/badge/github.com/CeresDB/horaedbproto.svg)](https://pkg.go.dev/github.com/CeresDB/horaedbproto)

Protocol buffer files for HoraeDB. Projects that manage generated code of different languages are also in this repository. They acts as underlying dependency of client, server and meta.

---

## User Guide

### Rust

```sh
cargo add horaedbproto
```

### Golang

```sh
go get github.com/CeresDB/horaedbproto/golang
```

### Java

Add a maven dependency to your project.

```xml
<dependency>
    <groupId>io.ceresdb</groupId>
    <artifactId>horaedb-proto-internal</artifactId>
    <version>1.0.0</version>
</dependency>
```

---

## Developer Guide

After modifying the proto files, something else for different programming languages should be done.

### Java

1. Name the maven project to a new version.
2. Rebuild the maven project lies in the `java` directory (During the build process, java code for the latest proto will be generated).
2. Publish the build result to the central maven repository.

### Rust

As for the Rust projects that depends on this project, everything will be generated during the build process of themselves. So nothing else needs to be done for `Rust`.

### Golang

1. Install the prerequisites:
* Install [Protocol Buffers v3.20.1](https://github.com/protocolbuffers/protobuf/releases/tag/v3.20.1) compiler.
2. Execute `make build`.